Infrahub documentation website

This folder contains the source code and documentation powering https://docs.infrahub.app.

This website is built using Docusaurus, a modern static website generator.

Getting started

Installation

cd docs
npm install

Local development

npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Serve

npm run serve

How to Setup a New Repo

• Create a branch in the to have it's docs built locally
• Copy over these files & directories from another repo, like emma repo:

docs/
.vale
.vale.ini
.markdownlint.yml
.yamllint.yml
tasks.py
.github/
  build-docs.sh
  file-filters.yml
  labeler.yml
  labels.yml
  workflows/
    ci.yml (only adding part)
    sync-docs.yml

• Modify the following:

docs/
  docusaurus.config.ts
  sidebars.ts
  docs/<projectname>  <— Put docs here
.github/
  workflows/
    ci.yml (only adding part)
    sync-docs.yml (paths)

• chmod 755 .github/build-docs.sh

• In infrahub-docs:

docs/sidebars-<projectname>.ts
docs/docs-<projectname>/<projectname>/readme.mdx <-- Placeholder
docs/docusaurus.config.ts <-- Add a plugin and navbar entry

• Setup Cloudflare Pages Integration
• Create PRs and test