Infrahub documentation website

⚠️ Important Notice: This repository is a documentation aggregation site that combines documentation from multiple Infrahub repositories. Most of the documentation content here is read-only and automatically synced from other repositories.

Before opening an issue or pull request

Please do not open issues or pull requests for documentation content in this repository. Instead, please open them in the appropriate source repository where the documentation actually lives:

• Infrahub core documentation: opsmill/infrahub repository
• Python SDK documentation: opsmill/infrahub-sdk-python repository
• Ansible collection documentation: opsmill/infrahub-ansible repository
• Service catalog documentation: opsmill/infrahub-demo-service-catalog repository
• Nornir integration documentation: opsmill/nornir-infrahub repository
• Schema library documentation: opsmill/schema-library repository
• Infrahub Sync documentation: opsmill/infrahub-sync repository
• Emma documentation: opsmill/emma repository

This repository only aggregates and builds the documentation website. Changes made here will be overwritten during the next sync from the source repositories.

About this repository

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/  ## Put docs here
.github/
  workflows/
    ci.yml ## only adding part
    sync-docs.yml ## paths

• chmod 755 .github/build-docs.sh

In infrahub-docs modify the following

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

Remaining tasks

• Setup Cloudflare Pages Integration
• Create PRs and test