You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/development/backend.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -112,7 +112,7 @@ The `debug` flag allows the server to be reloaded when a change is detected in t
112
112
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.
113
113
GraphQL sandbox is available through the frontend.
114
114
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).
Copy file name to clipboardExpand all lines: docs/docs/development/docs.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -239,7 +239,7 @@ Please note the following important points:
239
239
240
240
- 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.
241
241
- All documentation URLs need to be relative:
242
-
- Do this: `[some page](../path/to/file)`
242
+
- Do this: `[some page](../path/to/file.mdx)`
243
243
- Not this: `[some page](/absolute_path/to/file)`
244
244
245
245
## Organizing new pages
@@ -313,7 +313,7 @@ For a deeper dive into reference docs, refer to the [diátaxis reference page](h
313
313
314
314
## Application screenshots
315
315
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`.
317
317
318
318
### Updating all screenshots manually
319
319
@@ -350,7 +350,7 @@ The screenshots will be saved in `docs/docs/media`. You can then use them in our
350
350
351
351
#### 1. Locate on which test the screenshot should be added
352
352
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.
Copy file name to clipboardExpand all lines: docs/docs/development/frontend/getting-set-up.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ npm install
34
34
npm start
35
35
```
36
36
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).
Copy file name to clipboardExpand all lines: docs/docs/faq/faq.mdx
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ Infrahub is an open-source platform that enables infrastructure as code by provi
26
26
- Integrations: Integrations with tools like NetBox, Nautobot, Ansible, and Nornir. Ability to build custom integrations.
27
27
- Python SDK: Programmatically interact with Infrahub using a Python SDK.
28
28
29
-
For more information, see our [Infrahub overview](../getting-started/overview).
29
+
For more information, see our [Infrahub overview](../getting-started/overview.mdx).
30
30
31
31
### I'm just getting started with infrastructure automation. Do I need Infrahub?
32
32
@@ -36,7 +36,7 @@ Check out the [blog section on our website](https://opsmill.com/blog/) to learn
36
36
37
37
### How can I see Infrahub in action?
38
38
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.
40
40
41
41
Here are some quick ways to get started:
42
42
@@ -55,7 +55,7 @@ Common deployment types include:
55
55
56
56
:::note
57
57
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.
59
59
60
60
Each deployment option comes with trade-offs. It's important to also consider your existing tools and processes when choosing the best fit.
61
61
@@ -65,13 +65,13 @@ We're also working on a managed cloud SaaS version of Infrahub. Please [subscrib
65
65
66
66
### How can I install Infrahub?
67
67
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.
69
69
70
70
### I deployed Infrahub, now what?
71
71
72
72
Once Infrahub is deployed, you can start using it to manage your infrastructure resources and begin your automation journey.
73
73
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.
75
75
76
76
### What is the status of the project? Can I deploy Infrahub in production?
77
77
@@ -108,7 +108,7 @@ Infrahub is built on an open source foundation to allow for broad community acce
108
108
-**Infrahub Community** - Infrahub is an open source project that delivers a unified system to model, store, version, validate, and generate infrastructure data and configurations.
109
109
-**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.
110
110
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.
112
112
113
113
You can find pricing and feature details on [our website](https://opsmill.com/pricing/).
Copy file name to clipboardExpand all lines: docs/docs/getting-started/concepts.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,9 @@ A core feature of Infrahub is the ability to define a relational model to descri
13
13
14
14
The schema provides an abstraction layer to the graph database, and as such no knowledge of database administration is needed for daily Infrahub usage.
15
15
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).
17
17
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.
Copy file name to clipboardExpand all lines: docs/docs/getting-started/next-steps.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -84,7 +84,7 @@ The most important file is the `.infrahub.yml` file, which defines how Infrahub
84
84
85
85
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:
86
86
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).
88
88
2. Push the repository to the remote location.
89
89
3. Create a "Infrahub" access token with the required permissions to access the repository.
90
90
@@ -102,9 +102,9 @@ At this point, you have a running Infrahub instance with a schema, some data loa
102
102
103
103
From here, depending on your use case and goals, you can:
104
104
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.
108
108
-[**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.
109
109
110
110
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.
Copy file name to clipboardExpand all lines: docs/docs/getting-started/overview.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,7 @@ GraphQL is the primary API to interact with data, and allows access to everythin
39
39
40
40
- By default, exposed on TCP port `8000` at the endpoint: `http://<API_SERVER_IP>:8000/graphql`
41
41
- 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)
43
43
44
44
### REST API
45
45
@@ -73,7 +73,7 @@ One of the three pillars Infrahub is built on is the idea of having unified stor
73
73
74
74
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.
75
75
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)
77
77
78
78
## Data input and sync
79
79
@@ -82,7 +82,7 @@ More information can be found in the [external repositories guide](../guides/rep
82
82
When a schema has been loaded into Infrahub, data can be populated or synced through multiple methods:
83
83
84
84
- 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)
86
86
- Via the [Infrahub SDK]($(base_url)python-sdk/introduction), which simplifies working with the GraphQL API:
87
87
- 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)
88
88
- Integration with other systems
@@ -98,11 +98,11 @@ These integrations transform Infrahub into a centralized source of truth for inf
98
98
99
99
### Ansible integration
100
100
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.
102
102
103
103
### Nornir integration
104
104
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.
Copy file name to clipboardExpand all lines: docs/docs/getting-started/quick-start.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ To see Infrahub in action, you have several options. Depending on your available
14
14
15
15
:::note
16
16
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!
18
18
19
19
:::
20
20
@@ -56,13 +56,13 @@ Below is the current list of available demos developed and maintained by OpsMill
56
56
57
57
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.
58
58
59
-
<ReferenceLinktitle="Demo DC Fabric"url="https://docs.infrahub.app/demo/demo-dc-fabric"openInNewTab />
59
+
<ReferenceLinktitle="Demo DC Fabric"url="$(base_url)demo/demo-dc-fabric"openInNewTab />
60
60
61
61
-**Demo Service Catalog**
62
62
63
63
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.
64
64
65
-
<ReferenceLinktitle="Demo Service Catalog"url="https://docs.infrahub.app/demo-service-catalog"openInNewTab />
65
+
<ReferenceLinktitle="Demo Service Catalog"url="$(base_url)demo-service-catalog"openInNewTab />
0 commit comments