Skip to content

Commit 2f3dc7e

Browse files
author
github-actions
committed
Sync docs from infrahub repo
1 parent cfcb86a commit 2f3dc7e

File tree

90 files changed

+265
-267
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+265
-267
lines changed

docs/docs/development/backend.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ The `debug` flag allows the server to be reloaded when a change is detected in t
112112
Note that this will only make the backend service usable, the frontend will not be available. Only Swagger documentation should be available at http://localhost:8000/api/docs.
113113
GraphQL sandbox is available through the frontend.
114114

115-
For running the frontend, please refer to its [dedicated documentation section](./frontend).
115+
For running the frontend, please refer to its [dedicated documentation section](./frontend/readme.mdx).
116116

117117
## Loading a new schema via CLI
118118

docs/docs/development/docs.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ Please note the following important points:
239239

240240
- Today, spelling (the `.vale` directory) is authoritative in the `infrahub` repository, not the `infrahub-docs` repository. If you need to add a spelling exception in another repository (i.e. `infrahub-demo-dc-fabric`), you have to add the exception to the `infrahub` repository.
241241
- All documentation URLs need to be relative:
242-
- Do this: `[some page](../path/to/file)`
242+
- Do this: `[some page](../path/to/file.mdx)`
243243
- Not this: `[some page](/absolute_path/to/file)`
244244

245245
## Organizing new pages
@@ -313,7 +313,7 @@ For a deeper dive into reference docs, refer to the [diátaxis reference page](h
313313

314314
## Application screenshots
315315

316-
To ensure that Infrahub's screenshots remain up to date and to check that our guides work properly, we use [end-to-end (e2e) tests](./frontend/testing-guidelines#e2e-tests). You'll find the e2e tests specifically designed for tutorials located in `frontend/app/tests/e2e/tutorial`.
316+
To ensure that Infrahub's screenshots remain up to date and to check that our guides work properly, we use [end-to-end (e2e) tests](./frontend/testing-guidelines.mdx#e2e-tests). You'll find the e2e tests specifically designed for tutorials located in `frontend/app/tests/e2e/tutorial`.
317317

318318
### Updating all screenshots manually
319319

@@ -350,7 +350,7 @@ The screenshots will be saved in `docs/docs/media`. You can then use them in our
350350

351351
#### 1. Locate on which test the screenshot should be added
352352

353-
If the test does not exist yet, create must create it first. Refer to the [write e2e tests](./frontend/testing-guidelines#writing-e2e-tests) for more information.
353+
If the test does not exist yet, create must create it first. Refer to the [write e2e tests](./frontend/testing-guidelines.mdx#writing-e2e-tests) for more information.
354354

355355
#### 2. Add the screenshot
356356

docs/docs/development/frontend/getting-set-up.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ npm install
3434
npm start
3535
```
3636

37-
You can access your local server at [http://localhost:8080/](http://localhost:8080/). If you are not familiar with Infrahub, follow our [tutorial](../../tutorials/getting-started).
37+
You can access your local server at [http://localhost:8080/](http://localhost:8080/). If you are not familiar with Infrahub, follow our [tutorial](../../tutorials/getting-started/readme.mdx).
3838

3939
## 3. Run all tests
4040

docs/docs/development/frontend/testing-guidelines.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Running & writing tests
66

77
:::info Before we start
88

9-
If you have never run Infrahub tests before, we highly suggest following the [frontend guide](getting-set-up).
9+
If you have never run Infrahub tests before, we highly suggest following the [frontend guide](./getting-set-up.mdx).
1010

1111
:::
1212

docs/docs/development/git-best-practices.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Before you begin, ensure you have:
1616
- Git 2.20+ installed with submodule support
1717
- SSH keys configured for GitHub access
1818
- Basic understanding of Git branching and merging concepts
19-
- Development environment set up per the [backend guide](../development/backend)
19+
- Development environment set up per the [backend guide](../development/backend.mdx)
2020

2121
## Working with submodules
2222

@@ -442,7 +442,7 @@ git commit -m "temp: use local submodule changes"
442442

443443
## Further reading
444444

445-
- [Understanding Git repositories in Infrahub](../topics/repository) - Repository integration concepts
446-
- [Backend development guide](../development/backend) - Setting up the development environment
447-
- [How to connect external Git repositories](../guides/repository) - External repository setup
448-
- [Proposed changes](../topics/proposed-change) - Understanding Infrahub's change management
445+
- [Understanding Git repositories in Infrahub](../topics/repository.mdx) - Repository integration concepts
446+
- [Backend development guide](../development/backend.mdx) - Setting up the development environment
447+
- [How to connect external Git repositories](../guides/repository.mdx) - External repository setup
448+
- [Proposed changes](../topics/proposed-change.mdx) - Understanding Infrahub's change management

docs/docs/faq/faq.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Infrahub is an open-source platform that enables infrastructure as code by provi
2626
- Integrations: Integrations with tools like NetBox, Nautobot, Ansible, and Nornir. Ability to build custom integrations.
2727
- Python SDK: Programmatically interact with Infrahub using a Python SDK.
2828

29-
For more information, see our [Infrahub overview](../getting-started/overview).
29+
For more information, see our [Infrahub overview](../getting-started/overview.mdx).
3030

3131
### I'm just getting started with infrastructure automation. Do I need Infrahub?
3232

@@ -36,7 +36,7 @@ Check out the [blog section on our website](https://opsmill.com/blog/) to learn
3636

3737
### How can I see Infrahub in action?
3838

39-
You have many options to quickly try out Infrahub, please refer to the [Getting Started](../getting-started/quick-start) page for more details.
39+
You have many options to quickly try out Infrahub, please refer to the [Getting Started](../getting-started/quick-start.mdx) page for more details.
4040

4141
Here are some quick ways to get started:
4242

@@ -55,7 +55,7 @@ Common deployment types include:
5555

5656
:::note
5757

58-
Infrahub depends on several supporting services that must be installed either within the same environment or externally. See the [Overview](../getting-started/overview) page for more details.
58+
Infrahub depends on several supporting services that must be installed either within the same environment or externally. See the [Overview](../getting-started/overview.mdx) page for more details.
5959

6060
Each deployment option comes with trade-offs. It's important to also consider your existing tools and processes when choosing the best fit.
6161

@@ -65,13 +65,13 @@ We're also working on a managed cloud SaaS version of Infrahub. Please [subscrib
6565

6666
### How can I install Infrahub?
6767

68-
Check out the [Installing Infrahub](../guides/installation) guide for detailed setup instructions.
68+
Check out the [Installing Infrahub](../guides/installation.mdx) guide for detailed setup instructions.
6969

7070
### I deployed Infrahub, now what?
7171

7272
Once Infrahub is deployed, you can start using it to manage your infrastructure resources and begin your automation journey.
7373

74-
Visit the [Next Steps](../getting-started/next-steps) section for practical examples.
74+
Visit the [Next Steps](../getting-started/next-steps.mdx) section for practical examples.
7575

7676
### What is the status of the project? Can I deploy Infrahub in production?
7777

@@ -108,7 +108,7 @@ Infrahub is built on an open source foundation to allow for broad community acce
108108
- **Infrahub Community** - Infrahub is an open source project that delivers a unified system to model, store, version, validate, and generate infrastructure data and configurations.
109109
- **Infrahub Enterprise** - Get SLA-backed support, advanced integrations, and enhanced performance and high-availability. Gain the benefits of mature infrastructure automation with greater velocity and quality assurance.
110110

111-
For a detailed comparison of features, use cases, and decision guidance, see our [Community vs Enterprise](../topics/community-vs-enterprise) documentation.
111+
For a detailed comparison of features, use cases, and decision guidance, see our [Community vs Enterprise](../topics/community-vs-enterprise.mdx) documentation.
112112

113113
You can find pricing and feature details on [our website](https://opsmill.com/pricing/).
114114

docs/docs/getting-started/concepts.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ A core feature of Infrahub is the ability to define a relational model to descri
1313

1414
The schema provides an abstraction layer to the graph database, and as such no knowledge of database administration is needed for daily Infrahub usage.
1515

16-
The schema is described in YAML format, and consists of nodes, attributes, relationships, and other descriptors. For more detail, see the [guide to creating a schema](../guides/create-schema).
16+
The schema is described in YAML format, and consists of nodes, attributes, relationships, and other descriptors. For more detail, see the [guide to creating a schema](../guides/create-schema.mdx).
1717

18-
A new deployment of Infrahub will have no schema by default. It is up to the administrator of the system to define and load the initial schema. See the [commands to load a schema](../topics/schema#load-a-schema-into-infrahub) for more information.
18+
A new deployment of Infrahub will have no schema by default. It is up to the administrator of the system to define and load the initial schema. See the [commands to load a schema](../topics/schema.mdx#load-a-schema-into-infrahub) for more information.
1919

2020
Example schemas can be found:
2121

docs/docs/getting-started/next-steps.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ The most important file is the `.infrahub.yml` file, which defines how Infrahub
8484

8585
You will need to push this repository to a remote location that Infrahub can access. It doesn't have to be a public repository as Infrahub supports authentication with private repositories. Depending on the provider you use (for example: GitHub, GitLab, Bitbucket), the process may vary slightly, but the general steps are the same:
8686

87-
1. Create a new repository using the `infrahubctl repository init <directory>` command or manually. More details in the [related topic](../topics/developer-guide#initializing-an-infrahub-repository).
87+
1. Create a new repository using the `infrahubctl repository init <directory>` command or manually. More details in the [related topic](../topics/developer-guide.mdx#initializing-an-infrahub-repository).
8888
2. Push the repository to the remote location.
8989
3. Create a "Infrahub" access token with the required permissions to access the repository.
9090

@@ -102,9 +102,9 @@ At this point, you have a running Infrahub instance with a schema, some data loa
102102

103103
From here, depending on your use case and goals, you can:
104104

105-
- [**Create your own schema**](../guides/create-schema) - Extend the existing schema to fit your organization's needs.
106-
- [**Generate artifacts**](../guides/artifact) - Use transformations to create meaningful files from your data such as startup configurations, documentation, cabling plans and more.
107-
- [**Build generators**](../guides/generator) - Automate the creation of infrastructure objects based on templates and user inputs.
105+
- [**Create your own schema**](../guides/create-schema.mdx) - Extend the existing schema to fit your organization's needs.
106+
- [**Generate artifacts**](../guides/artifact.mdx) - Use transformations to create meaningful files from your data such as startup configurations, documentation, cabling plans and more.
107+
- [**Build generators**](../guides/generator.mdx) - Automate the creation of infrastructure objects based on templates and user inputs.
108108
- [**Deploy artifacts to the field using Ansible**]($(base_url)ansible) - Deploy outputs where they're needed and apply your intended state to your infrastructure. You can also use other tools like [Nornir]($(base_url)nornir) to deploy your artifacts.
109109

110110
If you need guidance with which feature to explore next or how to implement a specific use case, feel free to reach out to the community on our [Discord server](https://discord.gg/opsmill) or book a meeting with OpsMill.

docs/docs/getting-started/overview.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ GraphQL is the primary API to interact with data, and allows access to everythin
3939

4040
- By default, exposed on TCP port `8000` at the endpoint: `http://<API_SERVER_IP>:8000/graphql`
4141
- The Frontend utilizes the GraphQL API for most tasks
42-
- More information can be found in the [GraphQL topic](../topics/graphql)
42+
- More information can be found in the [GraphQL topic](../topics/graphql.mdx)
4343

4444
### REST API
4545

@@ -73,7 +73,7 @@ One of the three pillars Infrahub is built on is the idea of having unified stor
7373

7474
When integrating a Git repository with Infrahub, the Task worker will ensure that both systems stay in sync at any time. Changes to branches or files in a Git repository will be synced to Infrahub automatically.
7575

76-
More information can be found in the [external repositories guide](../guides/repository)
76+
More information can be found in the [external repositories guide](../guides/repository.mdx)
7777

7878
## Data input and sync
7979

@@ -82,7 +82,7 @@ More information can be found in the [external repositories guide](../guides/rep
8282
When a schema has been loaded into Infrahub, data can be populated or synced through multiple methods:
8383

8484
- Via the WebUI: users can add, modify, and delete objects
85-
- Via [infrahub-sync](https://docs.infrahub.app/sync)
85+
- Via [infrahub-sync]($(base_url)sync)
8686
- Via the [Infrahub SDK]($(base_url)python-sdk/introduction), which simplifies working with the GraphQL API:
8787
- One-time imports can be done similar to this [Python example](https://github.com/opsmill/infrahub-demo-dc-fabric/blob/main/generators/create_basic.py)
8888
- Integration with other systems
@@ -98,11 +98,11 @@ These integrations transform Infrahub into a centralized source of truth for inf
9898

9999
### Ansible integration
100100

101-
This integration is provided through the [`opsmill.infrahub` Ansible Collection](https://docs.infrahub.app/ansible/). It allows Infrahub to be used as a dynamic inventory source for Ansible, enabling management of infrastructure based on data stored in Infrahub.
101+
This integration is provided through the [`opsmill.infrahub` Ansible Collection]($(base_url)ansible/). It allows Infrahub to be used as a dynamic inventory source for Ansible, enabling management of infrastructure based on data stored in Infrahub.
102102

103103
### Nornir integration
104104

105-
Nornir is a Python-based automation framework primarily used for network automation. The [Infrahub plugin for Nornir](https://docs.infrahub.app/nornir/) enables Infrahub to serve as an inventory source, providing a streamlined solution for managing network devices and configurations.
105+
Nornir is a Python-based automation framework primarily used for network automation. The [Infrahub plugin for Nornir]($(base_url)nornir/) enables Infrahub to serve as an inventory source, providing a streamlined solution for managing network devices and configurations.
106106

107107
### Webhooks
108108

docs/docs/getting-started/quick-start.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To see Infrahub in action, you have several options. Depending on your available
1414

1515
:::note
1616

17-
If you are looking to build your own Infrahub instance to evaluate it in your environment, please refer to the [Next steps](./next-steps) section!
17+
If you are looking to build your own Infrahub instance to evaluate it in your environment, please refer to the [Next steps](./next-steps.mdx) section!
1818

1919
:::
2020

@@ -56,13 +56,13 @@ Below is the current list of available demos developed and maintained by OpsMill
5656

5757
The DC Fabric demo highlights Infrahub's capabilities in a data center environment. It offers a realistic simulation of data center infrastructure, showcasing how Infrahub can be used for infrastructure management and control. Key features demonstrated include resource allocation, service deployment, and automated configuration generation.
5858

59-
<ReferenceLink title="Demo DC Fabric" url="https://docs.infrahub.app/demo/demo-dc-fabric" openInNewTab />
59+
<ReferenceLink title="Demo DC Fabric" url="$(base_url)demo/demo-dc-fabric" openInNewTab />
6060

6161
- **Demo Service Catalog**
6262

6363
The Service Catalog demo demonstrates how Infrahub can be used to manage and deploy services within an ISP environment. It walks through the process of creating a service catalog using Infrahub and Streamlit. From modeling services in the schema, codifying them in Generator, to making these capabilities accessible across the organization via a Streamlit app. This demo provides a comprehensive, end-to-end overview of the workflow.
6464

65-
<ReferenceLink title="Demo Service Catalog" url="https://docs.infrahub.app/demo-service-catalog" openInNewTab />
65+
<ReferenceLink title="Demo Service Catalog" url="$(base_url)demo-service-catalog" openInNewTab />
6666

6767
## Meeting OpsMill
6868

0 commit comments

Comments
 (0)