From e54470bec8bdc486f38c1051e029bb2726413b9d Mon Sep 17 00:00:00 2001 From: Pete Crocker Date: Wed, 1 Jan 2025 12:06:43 +0000 Subject: [PATCH 1/4] change paths --- .../code_snippets/0001_graphql_add_repo.gql | 0 .../code_snippets/0002_shell_run_generator.sh | 0 .../infrahub-demo-dc-fabric.excalidraw.svg | 0 docs/{demo-dc-fabric => docs-demo}/readme.mdx | 0 .../step_by_step.mdx | 0 docs/docs-infrahub/convert_links.py | 45 +++ .../development/backend.mdx | 0 .../development/changelog.mdx | 0 .../development/docs.mdx | 0 .../development/editor.mdx | 0 .../development/frontend/getting-set-up.mdx | 0 .../development/frontend/readme.mdx | 0 .../frontend/testing-guidelines.mdx | 0 docs/{docs => docs-infrahub}/faq/faq.mdx | 0 .../guides/accounts-permissions.mdx | 0 .../guides/artifact.mdx | 0 docs/{docs => docs-infrahub}/guides/check.mdx | 0 .../guides/create-schema.mdx | 0 .../guides/database-backup.mdx | 0 .../guides/generator.mdx | 0 .../{docs => docs-infrahub}/guides/groups.mdx | 0 .../guides/import-schema.mdx | 0 .../guides/installation.mdx | 0 .../guides/jinja2-transform.mdx | 0 .../guides/managing-api-tokens.mdx | 0 docs/{docs => docs-infrahub}/guides/menu.mdx | 0 .../guides/object-storage.mdx | 0 .../guides/profiles.mdx | 0 .../guides/python-transform.mdx | 0 .../guides/repository.mdx | 0 .../guides/resource-manager.mdx | 0 docs/{docs => docs-infrahub}/guides/sso.mdx | 0 docs/{docs => docs-infrahub}/infrahubctl.mdx | 0 .../infrahubctl/infrahubctl-branch.mdx | 0 .../infrahubctl/infrahubctl-check.mdx | 0 .../infrahubctl/infrahubctl-dump.mdx | 0 .../infrahubctl/infrahubctl-generator.mdx | 0 .../infrahubctl/infrahubctl-load.mdx | 0 .../infrahubctl/infrahubctl-menu.mdx | 0 .../infrahubctl/infrahubctl-object.mdx | 0 .../infrahubctl/infrahubctl-protocols.mdx | 0 .../infrahubctl/infrahubctl-render.mdx | 0 .../infrahubctl/infrahubctl-repository.mdx | 0 .../infrahubctl/infrahubctl-run.mdx | 0 .../infrahubctl/infrahubctl-schema.mdx | 0 .../infrahubctl/infrahubctl-transform.mdx | 0 .../infrahubctl/infrahubctl-validate.mdx | 0 .../infrahubctl/infrahubctl-version.mdx | 0 .../integrations/infrahub-ansible/readme.mdx | 0 .../integrations/nornir-infrahub/readme.mdx | 0 .../integrations/readme.mdx | 0 .../integrations/sync/guides/creation.mdx | 0 .../integrations/sync/guides/installation.mdx | 0 .../integrations/sync/guides/run.mdx | 0 .../integrations/sync/readme.mdx | 0 .../integrations/sync/reference/cli.mdx | 0 .../integrations/sync/reference/config.mdx | 0 .../media/Infrahub-horizontal.svg | 0 .../artifacts-1-definition-details.png | Bin .../artifacts-2-artifact-details.png | Bin .../media/branch_conflict.excalidraw.svg | 0 .../media/branch_merge.excalidraw.svg | 0 .../branch_rebase_no_conflict.excalidraw.svg | 0 .../media/create_repository.png | Bin .../media/demo_edge.excalidraw.svg | 0 .../media/demo_edge_topology.png | Bin .../media/github_access_settings.png | Bin .../media/github_create_fork.png | Bin .../github_fined_grain_access_token_setup.png | Bin .../media/github_forked_repo.png | Bin .../media/github_view_all_branches.png | Bin .../group_tagconfig_grp_adding_members.png | Bin .../media/group_tagconfig_grp_new_grp.png | Bin .../media/group_tagconfig_grp_new_members.png | Bin .../guides/artifact/artifact_definition.png | Bin .../media/guides/artifact/artifact_detail.png | Bin .../media/guides/artifact/artifact_view.png | Bin .../media/guides/check_proposed_change.png | Bin .../media/guides/create_schema_1.png | Bin .../media/guides/create_schema_2.png | Bin .../media/guides/create_schema_3.png | Bin .../media/guides/create_schema_generics.png | Bin .../media/guides/create_schema_graphql_1.png | Bin .../guides/resource-manager-create-device.png | Bin .../high_level_architecture.excalidraw.svg | 0 .../high_level_architecture_ha.excalidraw.svg | 0 .../media/infrahub-favicon.png | Bin .../media/infrahub-readme.gif | Bin .../infrahub_sync_process.excalidraw.svg | 0 docs/{docs => docs-infrahub}/media/otto.png | Bin .../media/overview-data.excalidraw.svg | 0 .../media/overview-interfaces.excalidraw.svg | 0 .../media/overview-schema.excalidraw.svg | 0 .../overview-transformations.excalidraw.svg | 0 .../media/overview-versioning.excalidraw.svg | 0 .../media/overview.excalidraw.svg | 0 .../media/reference/schema/location_menu.png | Bin .../infrahub_0_12_0/branch_create_form.png | Bin .../proposed_change_checks.png | Bin .../proposed_change_failed_checks.png | Bin .../infrahub_0_12_0/proposed_change_tasks.png | Bin .../infrahub_0_12_0/schema_visualizer.png | Bin .../infrahub_0_12_0/search_bar_01.png | Bin .../infrahub_0_12_0/search_bar_02.png | Bin .../infrahub_0_13_0/filter_in_list.png | Bin .../infrahub_0_13_0/graphiql.png | Bin .../infrahub_0_13_0/help_panel.png | Bin .../release_notes/infrahub_0_13_0/ipam_01.png | Bin .../release_notes/infrahub_0_13_0/ipam_02.png | Bin .../infrahub_0_13_0/proposed_change_form.png | Bin .../infrahub_0_13_0/search_in_list.png | Bin .../infrahub_0_13_0/search_schema.png | Bin .../infrahub_0_14_0/resource_manager_form.png | Bin .../resource_manager_overview.png | Bin .../generic_relationship_select.png | Bin .../infrahub_0_15_0/hierarchical_view.png | Bin .../diff_view_enhancements.png | Bin .../diff_view_enhancements_before.png | Bin .../hide_auto_generated_groups.png | Bin .../infrahub_0_16_0/number_pool.png | Bin .../infrahub_0_16_0/number_pool_detail.png | Bin .../release_notes/infrahub_1_0/1_0_ui.png | Bin .../permissions_1_0.excalidraw.svg | 0 .../repository_architecture.excalidraw.svg | 0 .../media/temporal_graph.excalidraw.svg | 0 .../artifact/architecture.excalidraw.svg | 0 .../node_detail_view_artifact_tab.png | Bin .../media/topics/checks.excalidraw.svg | 0 .../generator_overview.excalidraw.svg | 0 ...resources_testing_framework.excalidraw.svg | 0 .../media/transformation.excalidraw.svg | 0 .../media/tutorial_1_branch_creation.png | Bin .../media/tutorial_1_branch_details.png | Bin .../media/tutorial_1_branch_diff.png | Bin .../media/tutorial_1_branch_list.png | Bin .../media/tutorial_1_organization_create.png | Bin .../media/tutorial_1_organization_details.png | Bin .../media/tutorial_1_organization_edit.png | Bin .../media/tutorial_1_organizations.png | Bin .../media/tutorial_2_historical.png | Bin .../media/tutorial_3_schema.png | Bin .../media/tutorial_4_metadata.png | Bin .../media/tutorial_4_metadata_edit.png | Bin .../media/tutorial_6_branch_creation.png | Bin .../media/tutorial_6_interface_update.png | Bin ...orial_resource_manager_add_device_form.png | Bin ...torial_resource_manager_loopbacks_pool.png | Bin .../media/tutorial_rfile_update_jinja.gif | Bin .../validators-1-list-fail.png | Bin .../validators-1-list-success.png | Bin .../{docs => docs-infrahub}/overview/data.mdx | 0 .../overview/generators.mdx | 0 .../overview/integrations.mdx | 0 .../overview/interfaces.mdx | 0 .../overview/readme.mdx | 0 .../overview/schema.mdx | 0 .../overview/transformations.mdx | 0 .../overview/versioning.mdx | 0 .../python-sdk/guides/batch.mdx | 0 .../python-sdk/guides/branches.mdx | 0 .../python-sdk/guides/client.mdx | 0 .../guides/create_update_delete.mdx | 0 .../python-sdk/guides/installation.mdx | 0 .../python-sdk/guides/object-storage.mdx | 0 .../python-sdk/guides/query_data.mdx | 0 .../python-sdk/guides/resource-manager.mdx | 0 .../python-sdk/guides/store.mdx | 0 .../python-sdk/guides/tracking.mdx | 0 .../python-sdk/readme.mdx | 0 .../python-sdk/reference/config.mdx | 0 .../python-sdk/topics/tracking.mdx | 0 docs/{docs => docs-infrahub}/readme.mdx | 0 .../reference/api-server.mdx | 0 .../reference/configuration.mdx | 0 .../reference/dotinfrahub.mdx | 0 .../reference/git-agent.mdx | 0 .../reference/infrahub-cli/infrahub-db.mdx | 0 .../infrahub-cli/infrahub-git-agent.mdx | 0 .../infrahub-cli/infrahub-server.mdx | 0 .../reference/infrahub-tests.mdx | 0 .../reference/menu.mdx | 0 .../reference/message-bus-events.mdx | 0 .../reference/permissions.mdx | 0 .../reference/schema-validation.mdx | 0 .../reference/schema/attribute.mdx | 0 .../reference/schema/generic.mdx | 0 .../reference/schema/groups.mdx | 0 .../reference/schema/node-extension.mdx | 0 .../reference/schema/node.mdx | 0 .../reference/schema/relationship.mdx | 0 .../reference/schema/validator-migration.mdx | 0 .../release-notes/infrahub/release-0_10.mdx | 0 .../release-notes/infrahub/release-0_11.mdx | 0 .../release-notes/infrahub/release-0_12.mdx | 0 .../release-notes/infrahub/release-0_13.mdx | 0 .../release-notes/infrahub/release-0_14.mdx | 0 .../release-notes/infrahub/release-0_15_0.mdx | 0 .../release-notes/infrahub/release-0_15_1.mdx | 0 .../release-notes/infrahub/release-0_15_2.mdx | 0 .../release-notes/infrahub/release-0_15_3.mdx | 0 .../release-notes/infrahub/release-0_16_0.mdx | 0 .../release-notes/infrahub/release-0_16_1.mdx | 0 .../release-notes/infrahub/release-0_16_2.mdx | 0 .../release-notes/infrahub/release-0_16_3.mdx | 0 .../release-notes/infrahub/release-0_16_4.mdx | 0 .../release-notes/infrahub/release-0_6.mdx | 0 .../release-notes/infrahub/release-0_7.mdx | 0 .../release-notes/infrahub/release-0_8.mdx | 0 .../release-notes/infrahub/release-0_9.mdx | 0 .../release-notes/infrahub/release-1_0_0.mdx | 0 .../release-notes/infrahub/release-1_0_1.mdx | 0 .../release-notes/infrahub/release-1_0_10.mdx | 0 .../release-notes/infrahub/release-1_0_2.mdx | 0 .../release-notes/infrahub/release-1_0_3.mdx | 0 .../release-notes/infrahub/release-1_0_4.mdx | 0 .../release-notes/infrahub/release-1_0_5.mdx | 0 .../release-notes/infrahub/release-1_0_6.mdx | 0 .../release-notes/infrahub/release-1_0_7.mdx | 0 .../release-notes/infrahub/release-1_0_8.mdx | 0 .../release-notes/infrahub/release-1_0_9.mdx | 0 .../release-notes/python-sdk/release-0_13.mdx | 0 .../python-sdk/release-1_0-DRAFT.mdx | 0 .../schemas/edge_topology.d2 | 0 .../schemas/edge_topology.svg | 0 .../snippets/pre-reqs-base.mdx | 0 .../snippets/pre-reqs-frontend.mdx | 0 .../topics/architecture.mdx | 0 .../topics/artifact.mdx | 0 docs/{docs => docs-infrahub}/topics/auth.mdx | 0 docs/{docs => docs-infrahub}/topics/check.mdx | 0 .../topics/database-backup.mdx | 0 .../topics/event-handling.mdx | 0 .../topics/generator.mdx | 0 .../topics/graphql.mdx | 0 .../{docs => docs-infrahub}/topics/groups.mdx | 0 .../topics/hardware-requirements.mdx | 0 .../topics/infrahub-yml.mdx | 0 docs/{docs => docs-infrahub}/topics/ipam.mdx | 0 .../topics/local-demo-environment.mdx | 0 .../topics/metadata.mdx | 0 .../topics/object-storage.mdx | 0 .../topics/permissions-roles.mdx | 0 .../topics/profiles.mdx | 0 .../topics/proposed-change.mdx | 0 .../topics/repository.mdx | 0 .../topics/resource-manager.mdx | 0 .../topics/resources-testing-framework.mdx | 0 .../{docs => docs-infrahub}/topics/schema.mdx | 0 .../topics/transformation.mdx | 0 .../topics/version-control.mdx | 0 .../tutorials/getting-started/branches.mdx | 0 .../getting-started/creating-an-object.mdx | 0 .../getting-started/git-integration.mdx | 0 .../getting-started/graphql-mutation.mdx | 0 .../getting-started/graphql-query.mdx | 0 .../getting-started/historical-data.mdx | 0 .../introduction-to-infrahub.mdx | 0 .../getting-started/lineage-information.mdx | 0 .../tutorials/getting-started/readme.mdx | 0 .../rendering-configuration.mdx | 0 .../getting-started/resource-manager.mdx | 0 .../tutorials/getting-started/schema.mdx | 0 docs/docs-projects/readme.mdx | 9 + docs/docusaurus.config.ts | 31 +- docs/sidebars-infrahub.ts | 364 ++++++++++++++++++ docs/sidebars.ts | 361 +---------------- 266 files changed, 445 insertions(+), 365 deletions(-) rename docs/{demo-dc-fabric => docs-demo}/code_snippets/0001_graphql_add_repo.gql (100%) rename docs/{demo-dc-fabric => docs-demo}/code_snippets/0002_shell_run_generator.sh (100%) rename docs/{demo-dc-fabric => docs-demo}/infrahub-demo-dc-fabric.excalidraw.svg (100%) rename docs/{demo-dc-fabric => docs-demo}/readme.mdx (100%) rename docs/{demo-dc-fabric => docs-demo}/step_by_step.mdx (100%) create mode 100644 docs/docs-infrahub/convert_links.py rename docs/{docs => docs-infrahub}/development/backend.mdx (100%) rename docs/{docs => docs-infrahub}/development/changelog.mdx (100%) rename docs/{docs => docs-infrahub}/development/docs.mdx (100%) rename docs/{docs => docs-infrahub}/development/editor.mdx (100%) rename docs/{docs => docs-infrahub}/development/frontend/getting-set-up.mdx (100%) rename docs/{docs => docs-infrahub}/development/frontend/readme.mdx (100%) rename docs/{docs => docs-infrahub}/development/frontend/testing-guidelines.mdx (100%) rename docs/{docs => docs-infrahub}/faq/faq.mdx (100%) rename docs/{docs => docs-infrahub}/guides/accounts-permissions.mdx (100%) rename docs/{docs => docs-infrahub}/guides/artifact.mdx (100%) rename docs/{docs => docs-infrahub}/guides/check.mdx (100%) rename docs/{docs => docs-infrahub}/guides/create-schema.mdx (100%) rename docs/{docs => docs-infrahub}/guides/database-backup.mdx (100%) rename docs/{docs => docs-infrahub}/guides/generator.mdx (100%) rename docs/{docs => docs-infrahub}/guides/groups.mdx (100%) rename docs/{docs => docs-infrahub}/guides/import-schema.mdx (100%) rename docs/{docs => docs-infrahub}/guides/installation.mdx (100%) rename docs/{docs => docs-infrahub}/guides/jinja2-transform.mdx (100%) rename docs/{docs => docs-infrahub}/guides/managing-api-tokens.mdx (100%) rename docs/{docs => docs-infrahub}/guides/menu.mdx (100%) rename docs/{docs => docs-infrahub}/guides/object-storage.mdx (100%) rename docs/{docs => docs-infrahub}/guides/profiles.mdx (100%) rename docs/{docs => docs-infrahub}/guides/python-transform.mdx (100%) rename docs/{docs => docs-infrahub}/guides/repository.mdx (100%) rename docs/{docs => docs-infrahub}/guides/resource-manager.mdx (100%) rename docs/{docs => docs-infrahub}/guides/sso.mdx (100%) rename docs/{docs => docs-infrahub}/infrahubctl.mdx (100%) rename docs/{docs => docs-infrahub}/infrahubctl/infrahubctl-branch.mdx (100%) rename docs/{docs => docs-infrahub}/infrahubctl/infrahubctl-check.mdx (100%) rename docs/{docs => docs-infrahub}/infrahubctl/infrahubctl-dump.mdx (100%) rename docs/{docs => docs-infrahub}/infrahubctl/infrahubctl-generator.mdx (100%) rename docs/{docs => docs-infrahub}/infrahubctl/infrahubctl-load.mdx (100%) rename docs/{docs => docs-infrahub}/infrahubctl/infrahubctl-menu.mdx (100%) rename docs/{docs => docs-infrahub}/infrahubctl/infrahubctl-object.mdx (100%) rename docs/{docs => docs-infrahub}/infrahubctl/infrahubctl-protocols.mdx (100%) rename docs/{docs => docs-infrahub}/infrahubctl/infrahubctl-render.mdx (100%) rename docs/{docs => docs-infrahub}/infrahubctl/infrahubctl-repository.mdx (100%) rename docs/{docs => docs-infrahub}/infrahubctl/infrahubctl-run.mdx (100%) rename docs/{docs => docs-infrahub}/infrahubctl/infrahubctl-schema.mdx (100%) rename docs/{docs => docs-infrahub}/infrahubctl/infrahubctl-transform.mdx (100%) rename docs/{docs => docs-infrahub}/infrahubctl/infrahubctl-validate.mdx (100%) rename docs/{docs => docs-infrahub}/infrahubctl/infrahubctl-version.mdx (100%) rename docs/{docs => docs-infrahub}/integrations/infrahub-ansible/readme.mdx (100%) rename docs/{docs => docs-infrahub}/integrations/nornir-infrahub/readme.mdx (100%) rename docs/{docs => docs-infrahub}/integrations/readme.mdx (100%) rename docs/{docs => docs-infrahub}/integrations/sync/guides/creation.mdx (100%) rename docs/{docs => docs-infrahub}/integrations/sync/guides/installation.mdx (100%) rename docs/{docs => docs-infrahub}/integrations/sync/guides/run.mdx (100%) rename docs/{docs => docs-infrahub}/integrations/sync/readme.mdx (100%) rename docs/{docs => docs-infrahub}/integrations/sync/reference/cli.mdx (100%) rename docs/{docs => docs-infrahub}/integrations/sync/reference/config.mdx (100%) rename docs/{docs => docs-infrahub}/media/Infrahub-horizontal.svg (100%) rename docs/{docs => docs-infrahub}/media/artifacts.cy.ts/artifacts-1-definition-details.png (100%) rename docs/{docs => docs-infrahub}/media/artifacts.cy.ts/artifacts-2-artifact-details.png (100%) rename docs/{docs => docs-infrahub}/media/branch_conflict.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/branch_merge.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/branch_rebase_no_conflict.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/create_repository.png (100%) rename docs/{docs => docs-infrahub}/media/demo_edge.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/demo_edge_topology.png (100%) rename docs/{docs => docs-infrahub}/media/github_access_settings.png (100%) rename docs/{docs => docs-infrahub}/media/github_create_fork.png (100%) rename docs/{docs => docs-infrahub}/media/github_fined_grain_access_token_setup.png (100%) rename docs/{docs => docs-infrahub}/media/github_forked_repo.png (100%) rename docs/{docs => docs-infrahub}/media/github_view_all_branches.png (100%) rename docs/{docs => docs-infrahub}/media/group_tagconfig_grp_adding_members.png (100%) rename docs/{docs => docs-infrahub}/media/group_tagconfig_grp_new_grp.png (100%) rename docs/{docs => docs-infrahub}/media/group_tagconfig_grp_new_members.png (100%) rename docs/{docs => docs-infrahub}/media/guides/artifact/artifact_definition.png (100%) rename docs/{docs => docs-infrahub}/media/guides/artifact/artifact_detail.png (100%) rename docs/{docs => docs-infrahub}/media/guides/artifact/artifact_view.png (100%) rename docs/{docs => docs-infrahub}/media/guides/check_proposed_change.png (100%) rename docs/{docs => docs-infrahub}/media/guides/create_schema_1.png (100%) rename docs/{docs => docs-infrahub}/media/guides/create_schema_2.png (100%) rename docs/{docs => docs-infrahub}/media/guides/create_schema_3.png (100%) rename docs/{docs => docs-infrahub}/media/guides/create_schema_generics.png (100%) rename docs/{docs => docs-infrahub}/media/guides/create_schema_graphql_1.png (100%) rename docs/{docs => docs-infrahub}/media/guides/resource-manager-create-device.png (100%) rename docs/{docs => docs-infrahub}/media/high_level_architecture.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/high_level_architecture_ha.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/infrahub-favicon.png (100%) rename docs/{docs => docs-infrahub}/media/infrahub-readme.gif (100%) rename docs/{docs => docs-infrahub}/media/infrahub_sync_process.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/otto.png (100%) rename docs/{docs => docs-infrahub}/media/overview-data.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/overview-interfaces.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/overview-schema.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/overview-transformations.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/overview-versioning.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/overview.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/reference/schema/location_menu.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_12_0/branch_create_form.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_12_0/proposed_change_checks.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_12_0/proposed_change_failed_checks.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_12_0/proposed_change_tasks.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_12_0/schema_visualizer.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_12_0/search_bar_01.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_12_0/search_bar_02.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_13_0/filter_in_list.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_13_0/graphiql.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_13_0/help_panel.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_13_0/ipam_01.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_13_0/ipam_02.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_13_0/proposed_change_form.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_13_0/search_in_list.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_13_0/search_schema.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_14_0/resource_manager_form.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_14_0/resource_manager_overview.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_15_0/generic_relationship_select.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_15_0/hierarchical_view.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_16_0/diff_view_enhancements.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_16_0/diff_view_enhancements_before.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_16_0/hide_auto_generated_groups.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_16_0/number_pool.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_0_16_0/number_pool_detail.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_1_0/1_0_ui.png (100%) rename docs/{docs => docs-infrahub}/media/release_notes/infrahub_1_0/permissions_1_0.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/repository_architecture.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/temporal_graph.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/topics/artifact/architecture.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/topics/artifact/node_detail_view_artifact_tab.png (100%) rename docs/{docs => docs-infrahub}/media/topics/checks.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/topics/generator/generator_overview.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/topics/resources_testing_framework.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/transformation.excalidraw.svg (100%) rename docs/{docs => docs-infrahub}/media/tutorial_1_branch_creation.png (100%) rename docs/{docs => docs-infrahub}/media/tutorial_1_branch_details.png (100%) rename docs/{docs => docs-infrahub}/media/tutorial_1_branch_diff.png (100%) rename docs/{docs => docs-infrahub}/media/tutorial_1_branch_list.png (100%) rename docs/{docs => docs-infrahub}/media/tutorial_1_organization_create.png (100%) rename docs/{docs => docs-infrahub}/media/tutorial_1_organization_details.png (100%) rename docs/{docs => docs-infrahub}/media/tutorial_1_organization_edit.png (100%) rename docs/{docs => docs-infrahub}/media/tutorial_1_organizations.png (100%) rename docs/{docs => docs-infrahub}/media/tutorial_2_historical.png (100%) rename docs/{docs => docs-infrahub}/media/tutorial_3_schema.png (100%) rename docs/{docs => docs-infrahub}/media/tutorial_4_metadata.png (100%) rename docs/{docs => docs-infrahub}/media/tutorial_4_metadata_edit.png (100%) rename docs/{docs => docs-infrahub}/media/tutorial_6_branch_creation.png (100%) rename docs/{docs => docs-infrahub}/media/tutorial_6_interface_update.png (100%) rename docs/{docs => docs-infrahub}/media/tutorial_resource_manager_add_device_form.png (100%) rename docs/{docs => docs-infrahub}/media/tutorial_resource_manager_loopbacks_pool.png (100%) rename docs/{docs => docs-infrahub}/media/tutorial_rfile_update_jinja.gif (100%) rename docs/{docs => docs-infrahub}/media/validators.cy.ts/validators-1-list-fail.png (100%) rename docs/{docs => docs-infrahub}/media/validators.cy.ts/validators-1-list-success.png (100%) rename docs/{docs => docs-infrahub}/overview/data.mdx (100%) rename docs/{docs => docs-infrahub}/overview/generators.mdx (100%) rename docs/{docs => docs-infrahub}/overview/integrations.mdx (100%) rename docs/{docs => docs-infrahub}/overview/interfaces.mdx (100%) rename docs/{docs => docs-infrahub}/overview/readme.mdx (100%) rename docs/{docs => docs-infrahub}/overview/schema.mdx (100%) rename docs/{docs => docs-infrahub}/overview/transformations.mdx (100%) rename docs/{docs => docs-infrahub}/overview/versioning.mdx (100%) rename docs/{docs => docs-infrahub}/python-sdk/guides/batch.mdx (100%) rename docs/{docs => docs-infrahub}/python-sdk/guides/branches.mdx (100%) rename docs/{docs => docs-infrahub}/python-sdk/guides/client.mdx (100%) rename docs/{docs => docs-infrahub}/python-sdk/guides/create_update_delete.mdx (100%) rename docs/{docs => docs-infrahub}/python-sdk/guides/installation.mdx (100%) rename docs/{docs => docs-infrahub}/python-sdk/guides/object-storage.mdx (100%) rename docs/{docs => docs-infrahub}/python-sdk/guides/query_data.mdx (100%) rename docs/{docs => docs-infrahub}/python-sdk/guides/resource-manager.mdx (100%) rename docs/{docs => docs-infrahub}/python-sdk/guides/store.mdx (100%) rename docs/{docs => docs-infrahub}/python-sdk/guides/tracking.mdx (100%) rename docs/{docs => docs-infrahub}/python-sdk/readme.mdx (100%) rename docs/{docs => docs-infrahub}/python-sdk/reference/config.mdx (100%) rename docs/{docs => docs-infrahub}/python-sdk/topics/tracking.mdx (100%) rename docs/{docs => docs-infrahub}/readme.mdx (100%) rename docs/{docs => docs-infrahub}/reference/api-server.mdx (100%) rename docs/{docs => docs-infrahub}/reference/configuration.mdx (100%) rename docs/{docs => docs-infrahub}/reference/dotinfrahub.mdx (100%) rename docs/{docs => docs-infrahub}/reference/git-agent.mdx (100%) rename docs/{docs => docs-infrahub}/reference/infrahub-cli/infrahub-db.mdx (100%) rename docs/{docs => docs-infrahub}/reference/infrahub-cli/infrahub-git-agent.mdx (100%) rename docs/{docs => docs-infrahub}/reference/infrahub-cli/infrahub-server.mdx (100%) rename docs/{docs => docs-infrahub}/reference/infrahub-tests.mdx (100%) rename docs/{docs => docs-infrahub}/reference/menu.mdx (100%) rename docs/{docs => docs-infrahub}/reference/message-bus-events.mdx (100%) rename docs/{docs => docs-infrahub}/reference/permissions.mdx (100%) rename docs/{docs => docs-infrahub}/reference/schema-validation.mdx (100%) rename docs/{docs => docs-infrahub}/reference/schema/attribute.mdx (100%) rename docs/{docs => docs-infrahub}/reference/schema/generic.mdx (100%) rename docs/{docs => docs-infrahub}/reference/schema/groups.mdx (100%) rename docs/{docs => docs-infrahub}/reference/schema/node-extension.mdx (100%) rename docs/{docs => docs-infrahub}/reference/schema/node.mdx (100%) rename docs/{docs => docs-infrahub}/reference/schema/relationship.mdx (100%) rename docs/{docs => docs-infrahub}/reference/schema/validator-migration.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_10.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_11.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_12.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_13.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_14.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_15_0.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_15_1.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_15_2.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_15_3.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_16_0.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_16_1.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_16_2.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_16_3.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_16_4.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_6.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_7.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_8.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-0_9.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-1_0_0.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-1_0_1.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-1_0_10.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-1_0_2.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-1_0_3.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-1_0_4.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-1_0_5.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-1_0_6.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-1_0_7.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-1_0_8.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/infrahub/release-1_0_9.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/python-sdk/release-0_13.mdx (100%) rename docs/{docs => docs-infrahub}/release-notes/python-sdk/release-1_0-DRAFT.mdx (100%) rename docs/{docs => docs-infrahub}/schemas/edge_topology.d2 (100%) rename docs/{docs => docs-infrahub}/schemas/edge_topology.svg (100%) rename docs/{docs => docs-infrahub}/snippets/pre-reqs-base.mdx (100%) rename docs/{docs => docs-infrahub}/snippets/pre-reqs-frontend.mdx (100%) rename docs/{docs => docs-infrahub}/topics/architecture.mdx (100%) rename docs/{docs => docs-infrahub}/topics/artifact.mdx (100%) rename docs/{docs => docs-infrahub}/topics/auth.mdx (100%) rename docs/{docs => docs-infrahub}/topics/check.mdx (100%) rename docs/{docs => docs-infrahub}/topics/database-backup.mdx (100%) rename docs/{docs => docs-infrahub}/topics/event-handling.mdx (100%) rename docs/{docs => docs-infrahub}/topics/generator.mdx (100%) rename docs/{docs => docs-infrahub}/topics/graphql.mdx (100%) rename docs/{docs => docs-infrahub}/topics/groups.mdx (100%) rename docs/{docs => docs-infrahub}/topics/hardware-requirements.mdx (100%) rename docs/{docs => docs-infrahub}/topics/infrahub-yml.mdx (100%) rename docs/{docs => docs-infrahub}/topics/ipam.mdx (100%) rename docs/{docs => docs-infrahub}/topics/local-demo-environment.mdx (100%) rename docs/{docs => docs-infrahub}/topics/metadata.mdx (100%) rename docs/{docs => docs-infrahub}/topics/object-storage.mdx (100%) rename docs/{docs => docs-infrahub}/topics/permissions-roles.mdx (100%) rename docs/{docs => docs-infrahub}/topics/profiles.mdx (100%) rename docs/{docs => docs-infrahub}/topics/proposed-change.mdx (100%) rename docs/{docs => docs-infrahub}/topics/repository.mdx (100%) rename docs/{docs => docs-infrahub}/topics/resource-manager.mdx (100%) rename docs/{docs => docs-infrahub}/topics/resources-testing-framework.mdx (100%) rename docs/{docs => docs-infrahub}/topics/schema.mdx (100%) rename docs/{docs => docs-infrahub}/topics/transformation.mdx (100%) rename docs/{docs => docs-infrahub}/topics/version-control.mdx (100%) rename docs/{docs => docs-infrahub}/tutorials/getting-started/branches.mdx (100%) rename docs/{docs => docs-infrahub}/tutorials/getting-started/creating-an-object.mdx (100%) rename docs/{docs => docs-infrahub}/tutorials/getting-started/git-integration.mdx (100%) rename docs/{docs => docs-infrahub}/tutorials/getting-started/graphql-mutation.mdx (100%) rename docs/{docs => docs-infrahub}/tutorials/getting-started/graphql-query.mdx (100%) rename docs/{docs => docs-infrahub}/tutorials/getting-started/historical-data.mdx (100%) rename docs/{docs => docs-infrahub}/tutorials/getting-started/introduction-to-infrahub.mdx (100%) rename docs/{docs => docs-infrahub}/tutorials/getting-started/lineage-information.mdx (100%) rename docs/{docs => docs-infrahub}/tutorials/getting-started/readme.mdx (100%) rename docs/{docs => docs-infrahub}/tutorials/getting-started/rendering-configuration.mdx (100%) rename docs/{docs => docs-infrahub}/tutorials/getting-started/resource-manager.mdx (100%) rename docs/{docs => docs-infrahub}/tutorials/getting-started/schema.mdx (100%) create mode 100644 docs/docs-projects/readme.mdx create mode 100644 docs/sidebars-infrahub.ts diff --git a/docs/demo-dc-fabric/code_snippets/0001_graphql_add_repo.gql b/docs/docs-demo/code_snippets/0001_graphql_add_repo.gql similarity index 100% rename from docs/demo-dc-fabric/code_snippets/0001_graphql_add_repo.gql rename to docs/docs-demo/code_snippets/0001_graphql_add_repo.gql diff --git a/docs/demo-dc-fabric/code_snippets/0002_shell_run_generator.sh b/docs/docs-demo/code_snippets/0002_shell_run_generator.sh similarity index 100% rename from docs/demo-dc-fabric/code_snippets/0002_shell_run_generator.sh rename to docs/docs-demo/code_snippets/0002_shell_run_generator.sh diff --git a/docs/demo-dc-fabric/infrahub-demo-dc-fabric.excalidraw.svg b/docs/docs-demo/infrahub-demo-dc-fabric.excalidraw.svg similarity index 100% rename from docs/demo-dc-fabric/infrahub-demo-dc-fabric.excalidraw.svg rename to docs/docs-demo/infrahub-demo-dc-fabric.excalidraw.svg diff --git a/docs/demo-dc-fabric/readme.mdx b/docs/docs-demo/readme.mdx similarity index 100% rename from docs/demo-dc-fabric/readme.mdx rename to docs/docs-demo/readme.mdx diff --git a/docs/demo-dc-fabric/step_by_step.mdx b/docs/docs-demo/step_by_step.mdx similarity index 100% rename from docs/demo-dc-fabric/step_by_step.mdx rename to docs/docs-demo/step_by_step.mdx diff --git a/docs/docs-infrahub/convert_links.py b/docs/docs-infrahub/convert_links.py new file mode 100644 index 0000000..36b2497 --- /dev/null +++ b/docs/docs-infrahub/convert_links.py @@ -0,0 +1,45 @@ +import re +from pathlib import Path +import os + +def convert_absolute_to_relative(source_path: Path, absolute_path: str) -> str: + """Convert an absolute path to a relative path based on the source file location.""" + # Remove leading slash to make it relative to the root + target_path = Path(absolute_path.lstrip('/')) + + # Get the relative path from source directory to target + relative_path = os.path.relpath(target_path, source_path.parent) + + return relative_path + +def process_file(file_path: Path) -> None: + """Process a single markdown file and convert absolute links to relative.""" + content = file_path.read_text() + + # Regular expression to find markdown links + pattern = r'\[([^\]]+)\]\((/[^)]+)\)' + + def replace_link(match): + link_text = match.group(1) + absolute_path = match.group(2) + relative_path = convert_absolute_to_relative(file_path, absolute_path) + return f'[{link_text}]({relative_path})' + + new_content = re.sub(pattern, replace_link, content) + + # Only write if content has changed + if new_content != content: + print(f"Updating {file_path}") + file_path.write_text(new_content) + +def main(): + # Find all markdown files in current directory and subdirectories + root_dir = Path('.') + markdown_files = list(root_dir.rglob('*.md')) + list(root_dir.rglob('*.mdx')) + + for file_path in markdown_files: + process_file(file_path) + +if __name__ == '__main__': + main() + diff --git a/docs/docs/development/backend.mdx b/docs/docs-infrahub/development/backend.mdx similarity index 100% rename from docs/docs/development/backend.mdx rename to docs/docs-infrahub/development/backend.mdx diff --git a/docs/docs/development/changelog.mdx b/docs/docs-infrahub/development/changelog.mdx similarity index 100% rename from docs/docs/development/changelog.mdx rename to docs/docs-infrahub/development/changelog.mdx diff --git a/docs/docs/development/docs.mdx b/docs/docs-infrahub/development/docs.mdx similarity index 100% rename from docs/docs/development/docs.mdx rename to docs/docs-infrahub/development/docs.mdx diff --git a/docs/docs/development/editor.mdx b/docs/docs-infrahub/development/editor.mdx similarity index 100% rename from docs/docs/development/editor.mdx rename to docs/docs-infrahub/development/editor.mdx diff --git a/docs/docs/development/frontend/getting-set-up.mdx b/docs/docs-infrahub/development/frontend/getting-set-up.mdx similarity index 100% rename from docs/docs/development/frontend/getting-set-up.mdx rename to docs/docs-infrahub/development/frontend/getting-set-up.mdx diff --git a/docs/docs/development/frontend/readme.mdx b/docs/docs-infrahub/development/frontend/readme.mdx similarity index 100% rename from docs/docs/development/frontend/readme.mdx rename to docs/docs-infrahub/development/frontend/readme.mdx diff --git a/docs/docs/development/frontend/testing-guidelines.mdx b/docs/docs-infrahub/development/frontend/testing-guidelines.mdx similarity index 100% rename from docs/docs/development/frontend/testing-guidelines.mdx rename to docs/docs-infrahub/development/frontend/testing-guidelines.mdx diff --git a/docs/docs/faq/faq.mdx b/docs/docs-infrahub/faq/faq.mdx similarity index 100% rename from docs/docs/faq/faq.mdx rename to docs/docs-infrahub/faq/faq.mdx diff --git a/docs/docs/guides/accounts-permissions.mdx b/docs/docs-infrahub/guides/accounts-permissions.mdx similarity index 100% rename from docs/docs/guides/accounts-permissions.mdx rename to docs/docs-infrahub/guides/accounts-permissions.mdx diff --git a/docs/docs/guides/artifact.mdx b/docs/docs-infrahub/guides/artifact.mdx similarity index 100% rename from docs/docs/guides/artifact.mdx rename to docs/docs-infrahub/guides/artifact.mdx diff --git a/docs/docs/guides/check.mdx b/docs/docs-infrahub/guides/check.mdx similarity index 100% rename from docs/docs/guides/check.mdx rename to docs/docs-infrahub/guides/check.mdx diff --git a/docs/docs/guides/create-schema.mdx b/docs/docs-infrahub/guides/create-schema.mdx similarity index 100% rename from docs/docs/guides/create-schema.mdx rename to docs/docs-infrahub/guides/create-schema.mdx diff --git a/docs/docs/guides/database-backup.mdx b/docs/docs-infrahub/guides/database-backup.mdx similarity index 100% rename from docs/docs/guides/database-backup.mdx rename to docs/docs-infrahub/guides/database-backup.mdx diff --git a/docs/docs/guides/generator.mdx b/docs/docs-infrahub/guides/generator.mdx similarity index 100% rename from docs/docs/guides/generator.mdx rename to docs/docs-infrahub/guides/generator.mdx diff --git a/docs/docs/guides/groups.mdx b/docs/docs-infrahub/guides/groups.mdx similarity index 100% rename from docs/docs/guides/groups.mdx rename to docs/docs-infrahub/guides/groups.mdx diff --git a/docs/docs/guides/import-schema.mdx b/docs/docs-infrahub/guides/import-schema.mdx similarity index 100% rename from docs/docs/guides/import-schema.mdx rename to docs/docs-infrahub/guides/import-schema.mdx diff --git a/docs/docs/guides/installation.mdx b/docs/docs-infrahub/guides/installation.mdx similarity index 100% rename from docs/docs/guides/installation.mdx rename to docs/docs-infrahub/guides/installation.mdx diff --git a/docs/docs/guides/jinja2-transform.mdx b/docs/docs-infrahub/guides/jinja2-transform.mdx similarity index 100% rename from docs/docs/guides/jinja2-transform.mdx rename to docs/docs-infrahub/guides/jinja2-transform.mdx diff --git a/docs/docs/guides/managing-api-tokens.mdx b/docs/docs-infrahub/guides/managing-api-tokens.mdx similarity index 100% rename from docs/docs/guides/managing-api-tokens.mdx rename to docs/docs-infrahub/guides/managing-api-tokens.mdx diff --git a/docs/docs/guides/menu.mdx b/docs/docs-infrahub/guides/menu.mdx similarity index 100% rename from docs/docs/guides/menu.mdx rename to docs/docs-infrahub/guides/menu.mdx diff --git a/docs/docs/guides/object-storage.mdx b/docs/docs-infrahub/guides/object-storage.mdx similarity index 100% rename from docs/docs/guides/object-storage.mdx rename to docs/docs-infrahub/guides/object-storage.mdx diff --git a/docs/docs/guides/profiles.mdx b/docs/docs-infrahub/guides/profiles.mdx similarity index 100% rename from docs/docs/guides/profiles.mdx rename to docs/docs-infrahub/guides/profiles.mdx diff --git a/docs/docs/guides/python-transform.mdx b/docs/docs-infrahub/guides/python-transform.mdx similarity index 100% rename from docs/docs/guides/python-transform.mdx rename to docs/docs-infrahub/guides/python-transform.mdx diff --git a/docs/docs/guides/repository.mdx b/docs/docs-infrahub/guides/repository.mdx similarity index 100% rename from docs/docs/guides/repository.mdx rename to docs/docs-infrahub/guides/repository.mdx diff --git a/docs/docs/guides/resource-manager.mdx b/docs/docs-infrahub/guides/resource-manager.mdx similarity index 100% rename from docs/docs/guides/resource-manager.mdx rename to docs/docs-infrahub/guides/resource-manager.mdx diff --git a/docs/docs/guides/sso.mdx b/docs/docs-infrahub/guides/sso.mdx similarity index 100% rename from docs/docs/guides/sso.mdx rename to docs/docs-infrahub/guides/sso.mdx diff --git a/docs/docs/infrahubctl.mdx b/docs/docs-infrahub/infrahubctl.mdx similarity index 100% rename from docs/docs/infrahubctl.mdx rename to docs/docs-infrahub/infrahubctl.mdx diff --git a/docs/docs/infrahubctl/infrahubctl-branch.mdx b/docs/docs-infrahub/infrahubctl/infrahubctl-branch.mdx similarity index 100% rename from docs/docs/infrahubctl/infrahubctl-branch.mdx rename to docs/docs-infrahub/infrahubctl/infrahubctl-branch.mdx diff --git a/docs/docs/infrahubctl/infrahubctl-check.mdx b/docs/docs-infrahub/infrahubctl/infrahubctl-check.mdx similarity index 100% rename from docs/docs/infrahubctl/infrahubctl-check.mdx rename to docs/docs-infrahub/infrahubctl/infrahubctl-check.mdx diff --git a/docs/docs/infrahubctl/infrahubctl-dump.mdx b/docs/docs-infrahub/infrahubctl/infrahubctl-dump.mdx similarity index 100% rename from docs/docs/infrahubctl/infrahubctl-dump.mdx rename to docs/docs-infrahub/infrahubctl/infrahubctl-dump.mdx diff --git a/docs/docs/infrahubctl/infrahubctl-generator.mdx b/docs/docs-infrahub/infrahubctl/infrahubctl-generator.mdx similarity index 100% rename from docs/docs/infrahubctl/infrahubctl-generator.mdx rename to docs/docs-infrahub/infrahubctl/infrahubctl-generator.mdx diff --git a/docs/docs/infrahubctl/infrahubctl-load.mdx b/docs/docs-infrahub/infrahubctl/infrahubctl-load.mdx similarity index 100% rename from docs/docs/infrahubctl/infrahubctl-load.mdx rename to docs/docs-infrahub/infrahubctl/infrahubctl-load.mdx diff --git a/docs/docs/infrahubctl/infrahubctl-menu.mdx b/docs/docs-infrahub/infrahubctl/infrahubctl-menu.mdx similarity index 100% rename from docs/docs/infrahubctl/infrahubctl-menu.mdx rename to docs/docs-infrahub/infrahubctl/infrahubctl-menu.mdx diff --git a/docs/docs/infrahubctl/infrahubctl-object.mdx b/docs/docs-infrahub/infrahubctl/infrahubctl-object.mdx similarity index 100% rename from docs/docs/infrahubctl/infrahubctl-object.mdx rename to docs/docs-infrahub/infrahubctl/infrahubctl-object.mdx diff --git a/docs/docs/infrahubctl/infrahubctl-protocols.mdx b/docs/docs-infrahub/infrahubctl/infrahubctl-protocols.mdx similarity index 100% rename from docs/docs/infrahubctl/infrahubctl-protocols.mdx rename to docs/docs-infrahub/infrahubctl/infrahubctl-protocols.mdx diff --git a/docs/docs/infrahubctl/infrahubctl-render.mdx b/docs/docs-infrahub/infrahubctl/infrahubctl-render.mdx similarity index 100% rename from docs/docs/infrahubctl/infrahubctl-render.mdx rename to docs/docs-infrahub/infrahubctl/infrahubctl-render.mdx diff --git a/docs/docs/infrahubctl/infrahubctl-repository.mdx b/docs/docs-infrahub/infrahubctl/infrahubctl-repository.mdx similarity index 100% rename from docs/docs/infrahubctl/infrahubctl-repository.mdx rename to docs/docs-infrahub/infrahubctl/infrahubctl-repository.mdx diff --git a/docs/docs/infrahubctl/infrahubctl-run.mdx b/docs/docs-infrahub/infrahubctl/infrahubctl-run.mdx similarity index 100% rename from docs/docs/infrahubctl/infrahubctl-run.mdx rename to docs/docs-infrahub/infrahubctl/infrahubctl-run.mdx diff --git a/docs/docs/infrahubctl/infrahubctl-schema.mdx b/docs/docs-infrahub/infrahubctl/infrahubctl-schema.mdx similarity index 100% rename from docs/docs/infrahubctl/infrahubctl-schema.mdx rename to docs/docs-infrahub/infrahubctl/infrahubctl-schema.mdx diff --git a/docs/docs/infrahubctl/infrahubctl-transform.mdx b/docs/docs-infrahub/infrahubctl/infrahubctl-transform.mdx similarity index 100% rename from docs/docs/infrahubctl/infrahubctl-transform.mdx rename to docs/docs-infrahub/infrahubctl/infrahubctl-transform.mdx diff --git a/docs/docs/infrahubctl/infrahubctl-validate.mdx b/docs/docs-infrahub/infrahubctl/infrahubctl-validate.mdx similarity index 100% rename from docs/docs/infrahubctl/infrahubctl-validate.mdx rename to docs/docs-infrahub/infrahubctl/infrahubctl-validate.mdx diff --git a/docs/docs/infrahubctl/infrahubctl-version.mdx b/docs/docs-infrahub/infrahubctl/infrahubctl-version.mdx similarity index 100% rename from docs/docs/infrahubctl/infrahubctl-version.mdx rename to docs/docs-infrahub/infrahubctl/infrahubctl-version.mdx diff --git a/docs/docs/integrations/infrahub-ansible/readme.mdx b/docs/docs-infrahub/integrations/infrahub-ansible/readme.mdx similarity index 100% rename from docs/docs/integrations/infrahub-ansible/readme.mdx rename to docs/docs-infrahub/integrations/infrahub-ansible/readme.mdx diff --git a/docs/docs/integrations/nornir-infrahub/readme.mdx b/docs/docs-infrahub/integrations/nornir-infrahub/readme.mdx similarity index 100% rename from docs/docs/integrations/nornir-infrahub/readme.mdx rename to docs/docs-infrahub/integrations/nornir-infrahub/readme.mdx diff --git a/docs/docs/integrations/readme.mdx b/docs/docs-infrahub/integrations/readme.mdx similarity index 100% rename from docs/docs/integrations/readme.mdx rename to docs/docs-infrahub/integrations/readme.mdx diff --git a/docs/docs/integrations/sync/guides/creation.mdx b/docs/docs-infrahub/integrations/sync/guides/creation.mdx similarity index 100% rename from docs/docs/integrations/sync/guides/creation.mdx rename to docs/docs-infrahub/integrations/sync/guides/creation.mdx diff --git a/docs/docs/integrations/sync/guides/installation.mdx b/docs/docs-infrahub/integrations/sync/guides/installation.mdx similarity index 100% rename from docs/docs/integrations/sync/guides/installation.mdx rename to docs/docs-infrahub/integrations/sync/guides/installation.mdx diff --git a/docs/docs/integrations/sync/guides/run.mdx b/docs/docs-infrahub/integrations/sync/guides/run.mdx similarity index 100% rename from docs/docs/integrations/sync/guides/run.mdx rename to docs/docs-infrahub/integrations/sync/guides/run.mdx diff --git a/docs/docs/integrations/sync/readme.mdx b/docs/docs-infrahub/integrations/sync/readme.mdx similarity index 100% rename from docs/docs/integrations/sync/readme.mdx rename to docs/docs-infrahub/integrations/sync/readme.mdx diff --git a/docs/docs/integrations/sync/reference/cli.mdx b/docs/docs-infrahub/integrations/sync/reference/cli.mdx similarity index 100% rename from docs/docs/integrations/sync/reference/cli.mdx rename to docs/docs-infrahub/integrations/sync/reference/cli.mdx diff --git a/docs/docs/integrations/sync/reference/config.mdx b/docs/docs-infrahub/integrations/sync/reference/config.mdx similarity index 100% rename from docs/docs/integrations/sync/reference/config.mdx rename to docs/docs-infrahub/integrations/sync/reference/config.mdx diff --git a/docs/docs/media/Infrahub-horizontal.svg b/docs/docs-infrahub/media/Infrahub-horizontal.svg similarity index 100% rename from docs/docs/media/Infrahub-horizontal.svg rename to docs/docs-infrahub/media/Infrahub-horizontal.svg diff --git a/docs/docs/media/artifacts.cy.ts/artifacts-1-definition-details.png b/docs/docs-infrahub/media/artifacts.cy.ts/artifacts-1-definition-details.png similarity index 100% rename from docs/docs/media/artifacts.cy.ts/artifacts-1-definition-details.png rename to docs/docs-infrahub/media/artifacts.cy.ts/artifacts-1-definition-details.png diff --git a/docs/docs/media/artifacts.cy.ts/artifacts-2-artifact-details.png b/docs/docs-infrahub/media/artifacts.cy.ts/artifacts-2-artifact-details.png similarity index 100% rename from docs/docs/media/artifacts.cy.ts/artifacts-2-artifact-details.png rename to docs/docs-infrahub/media/artifacts.cy.ts/artifacts-2-artifact-details.png diff --git a/docs/docs/media/branch_conflict.excalidraw.svg b/docs/docs-infrahub/media/branch_conflict.excalidraw.svg similarity index 100% rename from docs/docs/media/branch_conflict.excalidraw.svg rename to docs/docs-infrahub/media/branch_conflict.excalidraw.svg diff --git a/docs/docs/media/branch_merge.excalidraw.svg b/docs/docs-infrahub/media/branch_merge.excalidraw.svg similarity index 100% rename from docs/docs/media/branch_merge.excalidraw.svg rename to docs/docs-infrahub/media/branch_merge.excalidraw.svg diff --git a/docs/docs/media/branch_rebase_no_conflict.excalidraw.svg b/docs/docs-infrahub/media/branch_rebase_no_conflict.excalidraw.svg similarity index 100% rename from docs/docs/media/branch_rebase_no_conflict.excalidraw.svg rename to docs/docs-infrahub/media/branch_rebase_no_conflict.excalidraw.svg diff --git a/docs/docs/media/create_repository.png b/docs/docs-infrahub/media/create_repository.png similarity index 100% rename from docs/docs/media/create_repository.png rename to docs/docs-infrahub/media/create_repository.png diff --git a/docs/docs/media/demo_edge.excalidraw.svg b/docs/docs-infrahub/media/demo_edge.excalidraw.svg similarity index 100% rename from docs/docs/media/demo_edge.excalidraw.svg rename to docs/docs-infrahub/media/demo_edge.excalidraw.svg diff --git a/docs/docs/media/demo_edge_topology.png b/docs/docs-infrahub/media/demo_edge_topology.png similarity index 100% rename from docs/docs/media/demo_edge_topology.png rename to docs/docs-infrahub/media/demo_edge_topology.png diff --git a/docs/docs/media/github_access_settings.png b/docs/docs-infrahub/media/github_access_settings.png similarity index 100% rename from docs/docs/media/github_access_settings.png rename to docs/docs-infrahub/media/github_access_settings.png diff --git a/docs/docs/media/github_create_fork.png b/docs/docs-infrahub/media/github_create_fork.png similarity index 100% rename from docs/docs/media/github_create_fork.png rename to docs/docs-infrahub/media/github_create_fork.png diff --git a/docs/docs/media/github_fined_grain_access_token_setup.png b/docs/docs-infrahub/media/github_fined_grain_access_token_setup.png similarity index 100% rename from docs/docs/media/github_fined_grain_access_token_setup.png rename to docs/docs-infrahub/media/github_fined_grain_access_token_setup.png diff --git a/docs/docs/media/github_forked_repo.png b/docs/docs-infrahub/media/github_forked_repo.png similarity index 100% rename from docs/docs/media/github_forked_repo.png rename to docs/docs-infrahub/media/github_forked_repo.png diff --git a/docs/docs/media/github_view_all_branches.png b/docs/docs-infrahub/media/github_view_all_branches.png similarity index 100% rename from docs/docs/media/github_view_all_branches.png rename to docs/docs-infrahub/media/github_view_all_branches.png diff --git a/docs/docs/media/group_tagconfig_grp_adding_members.png b/docs/docs-infrahub/media/group_tagconfig_grp_adding_members.png similarity index 100% rename from docs/docs/media/group_tagconfig_grp_adding_members.png rename to docs/docs-infrahub/media/group_tagconfig_grp_adding_members.png diff --git a/docs/docs/media/group_tagconfig_grp_new_grp.png b/docs/docs-infrahub/media/group_tagconfig_grp_new_grp.png similarity index 100% rename from docs/docs/media/group_tagconfig_grp_new_grp.png rename to docs/docs-infrahub/media/group_tagconfig_grp_new_grp.png diff --git a/docs/docs/media/group_tagconfig_grp_new_members.png b/docs/docs-infrahub/media/group_tagconfig_grp_new_members.png similarity index 100% rename from docs/docs/media/group_tagconfig_grp_new_members.png rename to docs/docs-infrahub/media/group_tagconfig_grp_new_members.png diff --git a/docs/docs/media/guides/artifact/artifact_definition.png b/docs/docs-infrahub/media/guides/artifact/artifact_definition.png similarity index 100% rename from docs/docs/media/guides/artifact/artifact_definition.png rename to docs/docs-infrahub/media/guides/artifact/artifact_definition.png diff --git a/docs/docs/media/guides/artifact/artifact_detail.png b/docs/docs-infrahub/media/guides/artifact/artifact_detail.png similarity index 100% rename from docs/docs/media/guides/artifact/artifact_detail.png rename to docs/docs-infrahub/media/guides/artifact/artifact_detail.png diff --git a/docs/docs/media/guides/artifact/artifact_view.png b/docs/docs-infrahub/media/guides/artifact/artifact_view.png similarity index 100% rename from docs/docs/media/guides/artifact/artifact_view.png rename to docs/docs-infrahub/media/guides/artifact/artifact_view.png diff --git a/docs/docs/media/guides/check_proposed_change.png b/docs/docs-infrahub/media/guides/check_proposed_change.png similarity index 100% rename from docs/docs/media/guides/check_proposed_change.png rename to docs/docs-infrahub/media/guides/check_proposed_change.png diff --git a/docs/docs/media/guides/create_schema_1.png b/docs/docs-infrahub/media/guides/create_schema_1.png similarity index 100% rename from docs/docs/media/guides/create_schema_1.png rename to docs/docs-infrahub/media/guides/create_schema_1.png diff --git a/docs/docs/media/guides/create_schema_2.png b/docs/docs-infrahub/media/guides/create_schema_2.png similarity index 100% rename from docs/docs/media/guides/create_schema_2.png rename to docs/docs-infrahub/media/guides/create_schema_2.png diff --git a/docs/docs/media/guides/create_schema_3.png b/docs/docs-infrahub/media/guides/create_schema_3.png similarity index 100% rename from docs/docs/media/guides/create_schema_3.png rename to docs/docs-infrahub/media/guides/create_schema_3.png diff --git a/docs/docs/media/guides/create_schema_generics.png b/docs/docs-infrahub/media/guides/create_schema_generics.png similarity index 100% rename from docs/docs/media/guides/create_schema_generics.png rename to docs/docs-infrahub/media/guides/create_schema_generics.png diff --git a/docs/docs/media/guides/create_schema_graphql_1.png b/docs/docs-infrahub/media/guides/create_schema_graphql_1.png similarity index 100% rename from docs/docs/media/guides/create_schema_graphql_1.png rename to docs/docs-infrahub/media/guides/create_schema_graphql_1.png diff --git a/docs/docs/media/guides/resource-manager-create-device.png b/docs/docs-infrahub/media/guides/resource-manager-create-device.png similarity index 100% rename from docs/docs/media/guides/resource-manager-create-device.png rename to docs/docs-infrahub/media/guides/resource-manager-create-device.png diff --git a/docs/docs/media/high_level_architecture.excalidraw.svg b/docs/docs-infrahub/media/high_level_architecture.excalidraw.svg similarity index 100% rename from docs/docs/media/high_level_architecture.excalidraw.svg rename to docs/docs-infrahub/media/high_level_architecture.excalidraw.svg diff --git a/docs/docs/media/high_level_architecture_ha.excalidraw.svg b/docs/docs-infrahub/media/high_level_architecture_ha.excalidraw.svg similarity index 100% rename from docs/docs/media/high_level_architecture_ha.excalidraw.svg rename to docs/docs-infrahub/media/high_level_architecture_ha.excalidraw.svg diff --git a/docs/docs/media/infrahub-favicon.png b/docs/docs-infrahub/media/infrahub-favicon.png similarity index 100% rename from docs/docs/media/infrahub-favicon.png rename to docs/docs-infrahub/media/infrahub-favicon.png diff --git a/docs/docs/media/infrahub-readme.gif b/docs/docs-infrahub/media/infrahub-readme.gif similarity index 100% rename from docs/docs/media/infrahub-readme.gif rename to docs/docs-infrahub/media/infrahub-readme.gif diff --git a/docs/docs/media/infrahub_sync_process.excalidraw.svg b/docs/docs-infrahub/media/infrahub_sync_process.excalidraw.svg similarity index 100% rename from docs/docs/media/infrahub_sync_process.excalidraw.svg rename to docs/docs-infrahub/media/infrahub_sync_process.excalidraw.svg diff --git a/docs/docs/media/otto.png b/docs/docs-infrahub/media/otto.png similarity index 100% rename from docs/docs/media/otto.png rename to docs/docs-infrahub/media/otto.png diff --git a/docs/docs/media/overview-data.excalidraw.svg b/docs/docs-infrahub/media/overview-data.excalidraw.svg similarity index 100% rename from docs/docs/media/overview-data.excalidraw.svg rename to docs/docs-infrahub/media/overview-data.excalidraw.svg diff --git a/docs/docs/media/overview-interfaces.excalidraw.svg b/docs/docs-infrahub/media/overview-interfaces.excalidraw.svg similarity index 100% rename from docs/docs/media/overview-interfaces.excalidraw.svg rename to docs/docs-infrahub/media/overview-interfaces.excalidraw.svg diff --git a/docs/docs/media/overview-schema.excalidraw.svg b/docs/docs-infrahub/media/overview-schema.excalidraw.svg similarity index 100% rename from docs/docs/media/overview-schema.excalidraw.svg rename to docs/docs-infrahub/media/overview-schema.excalidraw.svg diff --git a/docs/docs/media/overview-transformations.excalidraw.svg b/docs/docs-infrahub/media/overview-transformations.excalidraw.svg similarity index 100% rename from docs/docs/media/overview-transformations.excalidraw.svg rename to docs/docs-infrahub/media/overview-transformations.excalidraw.svg diff --git a/docs/docs/media/overview-versioning.excalidraw.svg b/docs/docs-infrahub/media/overview-versioning.excalidraw.svg similarity index 100% rename from docs/docs/media/overview-versioning.excalidraw.svg rename to docs/docs-infrahub/media/overview-versioning.excalidraw.svg diff --git a/docs/docs/media/overview.excalidraw.svg b/docs/docs-infrahub/media/overview.excalidraw.svg similarity index 100% rename from docs/docs/media/overview.excalidraw.svg rename to docs/docs-infrahub/media/overview.excalidraw.svg diff --git a/docs/docs/media/reference/schema/location_menu.png b/docs/docs-infrahub/media/reference/schema/location_menu.png similarity index 100% rename from docs/docs/media/reference/schema/location_menu.png rename to docs/docs-infrahub/media/reference/schema/location_menu.png diff --git a/docs/docs/media/release_notes/infrahub_0_12_0/branch_create_form.png b/docs/docs-infrahub/media/release_notes/infrahub_0_12_0/branch_create_form.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_12_0/branch_create_form.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_12_0/branch_create_form.png diff --git a/docs/docs/media/release_notes/infrahub_0_12_0/proposed_change_checks.png b/docs/docs-infrahub/media/release_notes/infrahub_0_12_0/proposed_change_checks.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_12_0/proposed_change_checks.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_12_0/proposed_change_checks.png diff --git a/docs/docs/media/release_notes/infrahub_0_12_0/proposed_change_failed_checks.png b/docs/docs-infrahub/media/release_notes/infrahub_0_12_0/proposed_change_failed_checks.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_12_0/proposed_change_failed_checks.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_12_0/proposed_change_failed_checks.png diff --git a/docs/docs/media/release_notes/infrahub_0_12_0/proposed_change_tasks.png b/docs/docs-infrahub/media/release_notes/infrahub_0_12_0/proposed_change_tasks.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_12_0/proposed_change_tasks.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_12_0/proposed_change_tasks.png diff --git a/docs/docs/media/release_notes/infrahub_0_12_0/schema_visualizer.png b/docs/docs-infrahub/media/release_notes/infrahub_0_12_0/schema_visualizer.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_12_0/schema_visualizer.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_12_0/schema_visualizer.png diff --git a/docs/docs/media/release_notes/infrahub_0_12_0/search_bar_01.png b/docs/docs-infrahub/media/release_notes/infrahub_0_12_0/search_bar_01.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_12_0/search_bar_01.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_12_0/search_bar_01.png diff --git a/docs/docs/media/release_notes/infrahub_0_12_0/search_bar_02.png b/docs/docs-infrahub/media/release_notes/infrahub_0_12_0/search_bar_02.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_12_0/search_bar_02.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_12_0/search_bar_02.png diff --git a/docs/docs/media/release_notes/infrahub_0_13_0/filter_in_list.png b/docs/docs-infrahub/media/release_notes/infrahub_0_13_0/filter_in_list.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_13_0/filter_in_list.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_13_0/filter_in_list.png diff --git a/docs/docs/media/release_notes/infrahub_0_13_0/graphiql.png b/docs/docs-infrahub/media/release_notes/infrahub_0_13_0/graphiql.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_13_0/graphiql.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_13_0/graphiql.png diff --git a/docs/docs/media/release_notes/infrahub_0_13_0/help_panel.png b/docs/docs-infrahub/media/release_notes/infrahub_0_13_0/help_panel.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_13_0/help_panel.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_13_0/help_panel.png diff --git a/docs/docs/media/release_notes/infrahub_0_13_0/ipam_01.png b/docs/docs-infrahub/media/release_notes/infrahub_0_13_0/ipam_01.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_13_0/ipam_01.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_13_0/ipam_01.png diff --git a/docs/docs/media/release_notes/infrahub_0_13_0/ipam_02.png b/docs/docs-infrahub/media/release_notes/infrahub_0_13_0/ipam_02.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_13_0/ipam_02.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_13_0/ipam_02.png diff --git a/docs/docs/media/release_notes/infrahub_0_13_0/proposed_change_form.png b/docs/docs-infrahub/media/release_notes/infrahub_0_13_0/proposed_change_form.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_13_0/proposed_change_form.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_13_0/proposed_change_form.png diff --git a/docs/docs/media/release_notes/infrahub_0_13_0/search_in_list.png b/docs/docs-infrahub/media/release_notes/infrahub_0_13_0/search_in_list.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_13_0/search_in_list.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_13_0/search_in_list.png diff --git a/docs/docs/media/release_notes/infrahub_0_13_0/search_schema.png b/docs/docs-infrahub/media/release_notes/infrahub_0_13_0/search_schema.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_13_0/search_schema.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_13_0/search_schema.png diff --git a/docs/docs/media/release_notes/infrahub_0_14_0/resource_manager_form.png b/docs/docs-infrahub/media/release_notes/infrahub_0_14_0/resource_manager_form.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_14_0/resource_manager_form.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_14_0/resource_manager_form.png diff --git a/docs/docs/media/release_notes/infrahub_0_14_0/resource_manager_overview.png b/docs/docs-infrahub/media/release_notes/infrahub_0_14_0/resource_manager_overview.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_14_0/resource_manager_overview.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_14_0/resource_manager_overview.png diff --git a/docs/docs/media/release_notes/infrahub_0_15_0/generic_relationship_select.png b/docs/docs-infrahub/media/release_notes/infrahub_0_15_0/generic_relationship_select.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_15_0/generic_relationship_select.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_15_0/generic_relationship_select.png diff --git a/docs/docs/media/release_notes/infrahub_0_15_0/hierarchical_view.png b/docs/docs-infrahub/media/release_notes/infrahub_0_15_0/hierarchical_view.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_15_0/hierarchical_view.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_15_0/hierarchical_view.png diff --git a/docs/docs/media/release_notes/infrahub_0_16_0/diff_view_enhancements.png b/docs/docs-infrahub/media/release_notes/infrahub_0_16_0/diff_view_enhancements.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_16_0/diff_view_enhancements.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_16_0/diff_view_enhancements.png diff --git a/docs/docs/media/release_notes/infrahub_0_16_0/diff_view_enhancements_before.png b/docs/docs-infrahub/media/release_notes/infrahub_0_16_0/diff_view_enhancements_before.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_16_0/diff_view_enhancements_before.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_16_0/diff_view_enhancements_before.png diff --git a/docs/docs/media/release_notes/infrahub_0_16_0/hide_auto_generated_groups.png b/docs/docs-infrahub/media/release_notes/infrahub_0_16_0/hide_auto_generated_groups.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_16_0/hide_auto_generated_groups.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_16_0/hide_auto_generated_groups.png diff --git a/docs/docs/media/release_notes/infrahub_0_16_0/number_pool.png b/docs/docs-infrahub/media/release_notes/infrahub_0_16_0/number_pool.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_16_0/number_pool.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_16_0/number_pool.png diff --git a/docs/docs/media/release_notes/infrahub_0_16_0/number_pool_detail.png b/docs/docs-infrahub/media/release_notes/infrahub_0_16_0/number_pool_detail.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_0_16_0/number_pool_detail.png rename to docs/docs-infrahub/media/release_notes/infrahub_0_16_0/number_pool_detail.png diff --git a/docs/docs/media/release_notes/infrahub_1_0/1_0_ui.png b/docs/docs-infrahub/media/release_notes/infrahub_1_0/1_0_ui.png similarity index 100% rename from docs/docs/media/release_notes/infrahub_1_0/1_0_ui.png rename to docs/docs-infrahub/media/release_notes/infrahub_1_0/1_0_ui.png diff --git a/docs/docs/media/release_notes/infrahub_1_0/permissions_1_0.excalidraw.svg b/docs/docs-infrahub/media/release_notes/infrahub_1_0/permissions_1_0.excalidraw.svg similarity index 100% rename from docs/docs/media/release_notes/infrahub_1_0/permissions_1_0.excalidraw.svg rename to docs/docs-infrahub/media/release_notes/infrahub_1_0/permissions_1_0.excalidraw.svg diff --git a/docs/docs/media/repository_architecture.excalidraw.svg b/docs/docs-infrahub/media/repository_architecture.excalidraw.svg similarity index 100% rename from docs/docs/media/repository_architecture.excalidraw.svg rename to docs/docs-infrahub/media/repository_architecture.excalidraw.svg diff --git a/docs/docs/media/temporal_graph.excalidraw.svg b/docs/docs-infrahub/media/temporal_graph.excalidraw.svg similarity index 100% rename from docs/docs/media/temporal_graph.excalidraw.svg rename to docs/docs-infrahub/media/temporal_graph.excalidraw.svg diff --git a/docs/docs/media/topics/artifact/architecture.excalidraw.svg b/docs/docs-infrahub/media/topics/artifact/architecture.excalidraw.svg similarity index 100% rename from docs/docs/media/topics/artifact/architecture.excalidraw.svg rename to docs/docs-infrahub/media/topics/artifact/architecture.excalidraw.svg diff --git a/docs/docs/media/topics/artifact/node_detail_view_artifact_tab.png b/docs/docs-infrahub/media/topics/artifact/node_detail_view_artifact_tab.png similarity index 100% rename from docs/docs/media/topics/artifact/node_detail_view_artifact_tab.png rename to docs/docs-infrahub/media/topics/artifact/node_detail_view_artifact_tab.png diff --git a/docs/docs/media/topics/checks.excalidraw.svg b/docs/docs-infrahub/media/topics/checks.excalidraw.svg similarity index 100% rename from docs/docs/media/topics/checks.excalidraw.svg rename to docs/docs-infrahub/media/topics/checks.excalidraw.svg diff --git a/docs/docs/media/topics/generator/generator_overview.excalidraw.svg b/docs/docs-infrahub/media/topics/generator/generator_overview.excalidraw.svg similarity index 100% rename from docs/docs/media/topics/generator/generator_overview.excalidraw.svg rename to docs/docs-infrahub/media/topics/generator/generator_overview.excalidraw.svg diff --git a/docs/docs/media/topics/resources_testing_framework.excalidraw.svg b/docs/docs-infrahub/media/topics/resources_testing_framework.excalidraw.svg similarity index 100% rename from docs/docs/media/topics/resources_testing_framework.excalidraw.svg rename to docs/docs-infrahub/media/topics/resources_testing_framework.excalidraw.svg diff --git a/docs/docs/media/transformation.excalidraw.svg b/docs/docs-infrahub/media/transformation.excalidraw.svg similarity index 100% rename from docs/docs/media/transformation.excalidraw.svg rename to docs/docs-infrahub/media/transformation.excalidraw.svg diff --git a/docs/docs/media/tutorial_1_branch_creation.png b/docs/docs-infrahub/media/tutorial_1_branch_creation.png similarity index 100% rename from docs/docs/media/tutorial_1_branch_creation.png rename to docs/docs-infrahub/media/tutorial_1_branch_creation.png diff --git a/docs/docs/media/tutorial_1_branch_details.png b/docs/docs-infrahub/media/tutorial_1_branch_details.png similarity index 100% rename from docs/docs/media/tutorial_1_branch_details.png rename to docs/docs-infrahub/media/tutorial_1_branch_details.png diff --git a/docs/docs/media/tutorial_1_branch_diff.png b/docs/docs-infrahub/media/tutorial_1_branch_diff.png similarity index 100% rename from docs/docs/media/tutorial_1_branch_diff.png rename to docs/docs-infrahub/media/tutorial_1_branch_diff.png diff --git a/docs/docs/media/tutorial_1_branch_list.png b/docs/docs-infrahub/media/tutorial_1_branch_list.png similarity index 100% rename from docs/docs/media/tutorial_1_branch_list.png rename to docs/docs-infrahub/media/tutorial_1_branch_list.png diff --git a/docs/docs/media/tutorial_1_organization_create.png b/docs/docs-infrahub/media/tutorial_1_organization_create.png similarity index 100% rename from docs/docs/media/tutorial_1_organization_create.png rename to docs/docs-infrahub/media/tutorial_1_organization_create.png diff --git a/docs/docs/media/tutorial_1_organization_details.png b/docs/docs-infrahub/media/tutorial_1_organization_details.png similarity index 100% rename from docs/docs/media/tutorial_1_organization_details.png rename to docs/docs-infrahub/media/tutorial_1_organization_details.png diff --git a/docs/docs/media/tutorial_1_organization_edit.png b/docs/docs-infrahub/media/tutorial_1_organization_edit.png similarity index 100% rename from docs/docs/media/tutorial_1_organization_edit.png rename to docs/docs-infrahub/media/tutorial_1_organization_edit.png diff --git a/docs/docs/media/tutorial_1_organizations.png b/docs/docs-infrahub/media/tutorial_1_organizations.png similarity index 100% rename from docs/docs/media/tutorial_1_organizations.png rename to docs/docs-infrahub/media/tutorial_1_organizations.png diff --git a/docs/docs/media/tutorial_2_historical.png b/docs/docs-infrahub/media/tutorial_2_historical.png similarity index 100% rename from docs/docs/media/tutorial_2_historical.png rename to docs/docs-infrahub/media/tutorial_2_historical.png diff --git a/docs/docs/media/tutorial_3_schema.png b/docs/docs-infrahub/media/tutorial_3_schema.png similarity index 100% rename from docs/docs/media/tutorial_3_schema.png rename to docs/docs-infrahub/media/tutorial_3_schema.png diff --git a/docs/docs/media/tutorial_4_metadata.png b/docs/docs-infrahub/media/tutorial_4_metadata.png similarity index 100% rename from docs/docs/media/tutorial_4_metadata.png rename to docs/docs-infrahub/media/tutorial_4_metadata.png diff --git a/docs/docs/media/tutorial_4_metadata_edit.png b/docs/docs-infrahub/media/tutorial_4_metadata_edit.png similarity index 100% rename from docs/docs/media/tutorial_4_metadata_edit.png rename to docs/docs-infrahub/media/tutorial_4_metadata_edit.png diff --git a/docs/docs/media/tutorial_6_branch_creation.png b/docs/docs-infrahub/media/tutorial_6_branch_creation.png similarity index 100% rename from docs/docs/media/tutorial_6_branch_creation.png rename to docs/docs-infrahub/media/tutorial_6_branch_creation.png diff --git a/docs/docs/media/tutorial_6_interface_update.png b/docs/docs-infrahub/media/tutorial_6_interface_update.png similarity index 100% rename from docs/docs/media/tutorial_6_interface_update.png rename to docs/docs-infrahub/media/tutorial_6_interface_update.png diff --git a/docs/docs/media/tutorial_resource_manager_add_device_form.png b/docs/docs-infrahub/media/tutorial_resource_manager_add_device_form.png similarity index 100% rename from docs/docs/media/tutorial_resource_manager_add_device_form.png rename to docs/docs-infrahub/media/tutorial_resource_manager_add_device_form.png diff --git a/docs/docs/media/tutorial_resource_manager_loopbacks_pool.png b/docs/docs-infrahub/media/tutorial_resource_manager_loopbacks_pool.png similarity index 100% rename from docs/docs/media/tutorial_resource_manager_loopbacks_pool.png rename to docs/docs-infrahub/media/tutorial_resource_manager_loopbacks_pool.png diff --git a/docs/docs/media/tutorial_rfile_update_jinja.gif b/docs/docs-infrahub/media/tutorial_rfile_update_jinja.gif similarity index 100% rename from docs/docs/media/tutorial_rfile_update_jinja.gif rename to docs/docs-infrahub/media/tutorial_rfile_update_jinja.gif diff --git a/docs/docs/media/validators.cy.ts/validators-1-list-fail.png b/docs/docs-infrahub/media/validators.cy.ts/validators-1-list-fail.png similarity index 100% rename from docs/docs/media/validators.cy.ts/validators-1-list-fail.png rename to docs/docs-infrahub/media/validators.cy.ts/validators-1-list-fail.png diff --git a/docs/docs/media/validators.cy.ts/validators-1-list-success.png b/docs/docs-infrahub/media/validators.cy.ts/validators-1-list-success.png similarity index 100% rename from docs/docs/media/validators.cy.ts/validators-1-list-success.png rename to docs/docs-infrahub/media/validators.cy.ts/validators-1-list-success.png diff --git a/docs/docs/overview/data.mdx b/docs/docs-infrahub/overview/data.mdx similarity index 100% rename from docs/docs/overview/data.mdx rename to docs/docs-infrahub/overview/data.mdx diff --git a/docs/docs/overview/generators.mdx b/docs/docs-infrahub/overview/generators.mdx similarity index 100% rename from docs/docs/overview/generators.mdx rename to docs/docs-infrahub/overview/generators.mdx diff --git a/docs/docs/overview/integrations.mdx b/docs/docs-infrahub/overview/integrations.mdx similarity index 100% rename from docs/docs/overview/integrations.mdx rename to docs/docs-infrahub/overview/integrations.mdx diff --git a/docs/docs/overview/interfaces.mdx b/docs/docs-infrahub/overview/interfaces.mdx similarity index 100% rename from docs/docs/overview/interfaces.mdx rename to docs/docs-infrahub/overview/interfaces.mdx diff --git a/docs/docs/overview/readme.mdx b/docs/docs-infrahub/overview/readme.mdx similarity index 100% rename from docs/docs/overview/readme.mdx rename to docs/docs-infrahub/overview/readme.mdx diff --git a/docs/docs/overview/schema.mdx b/docs/docs-infrahub/overview/schema.mdx similarity index 100% rename from docs/docs/overview/schema.mdx rename to docs/docs-infrahub/overview/schema.mdx diff --git a/docs/docs/overview/transformations.mdx b/docs/docs-infrahub/overview/transformations.mdx similarity index 100% rename from docs/docs/overview/transformations.mdx rename to docs/docs-infrahub/overview/transformations.mdx diff --git a/docs/docs/overview/versioning.mdx b/docs/docs-infrahub/overview/versioning.mdx similarity index 100% rename from docs/docs/overview/versioning.mdx rename to docs/docs-infrahub/overview/versioning.mdx diff --git a/docs/docs/python-sdk/guides/batch.mdx b/docs/docs-infrahub/python-sdk/guides/batch.mdx similarity index 100% rename from docs/docs/python-sdk/guides/batch.mdx rename to docs/docs-infrahub/python-sdk/guides/batch.mdx diff --git a/docs/docs/python-sdk/guides/branches.mdx b/docs/docs-infrahub/python-sdk/guides/branches.mdx similarity index 100% rename from docs/docs/python-sdk/guides/branches.mdx rename to docs/docs-infrahub/python-sdk/guides/branches.mdx diff --git a/docs/docs/python-sdk/guides/client.mdx b/docs/docs-infrahub/python-sdk/guides/client.mdx similarity index 100% rename from docs/docs/python-sdk/guides/client.mdx rename to docs/docs-infrahub/python-sdk/guides/client.mdx diff --git a/docs/docs/python-sdk/guides/create_update_delete.mdx b/docs/docs-infrahub/python-sdk/guides/create_update_delete.mdx similarity index 100% rename from docs/docs/python-sdk/guides/create_update_delete.mdx rename to docs/docs-infrahub/python-sdk/guides/create_update_delete.mdx diff --git a/docs/docs/python-sdk/guides/installation.mdx b/docs/docs-infrahub/python-sdk/guides/installation.mdx similarity index 100% rename from docs/docs/python-sdk/guides/installation.mdx rename to docs/docs-infrahub/python-sdk/guides/installation.mdx diff --git a/docs/docs/python-sdk/guides/object-storage.mdx b/docs/docs-infrahub/python-sdk/guides/object-storage.mdx similarity index 100% rename from docs/docs/python-sdk/guides/object-storage.mdx rename to docs/docs-infrahub/python-sdk/guides/object-storage.mdx diff --git a/docs/docs/python-sdk/guides/query_data.mdx b/docs/docs-infrahub/python-sdk/guides/query_data.mdx similarity index 100% rename from docs/docs/python-sdk/guides/query_data.mdx rename to docs/docs-infrahub/python-sdk/guides/query_data.mdx diff --git a/docs/docs/python-sdk/guides/resource-manager.mdx b/docs/docs-infrahub/python-sdk/guides/resource-manager.mdx similarity index 100% rename from docs/docs/python-sdk/guides/resource-manager.mdx rename to docs/docs-infrahub/python-sdk/guides/resource-manager.mdx diff --git a/docs/docs/python-sdk/guides/store.mdx b/docs/docs-infrahub/python-sdk/guides/store.mdx similarity index 100% rename from docs/docs/python-sdk/guides/store.mdx rename to docs/docs-infrahub/python-sdk/guides/store.mdx diff --git a/docs/docs/python-sdk/guides/tracking.mdx b/docs/docs-infrahub/python-sdk/guides/tracking.mdx similarity index 100% rename from docs/docs/python-sdk/guides/tracking.mdx rename to docs/docs-infrahub/python-sdk/guides/tracking.mdx diff --git a/docs/docs/python-sdk/readme.mdx b/docs/docs-infrahub/python-sdk/readme.mdx similarity index 100% rename from docs/docs/python-sdk/readme.mdx rename to docs/docs-infrahub/python-sdk/readme.mdx diff --git a/docs/docs/python-sdk/reference/config.mdx b/docs/docs-infrahub/python-sdk/reference/config.mdx similarity index 100% rename from docs/docs/python-sdk/reference/config.mdx rename to docs/docs-infrahub/python-sdk/reference/config.mdx diff --git a/docs/docs/python-sdk/topics/tracking.mdx b/docs/docs-infrahub/python-sdk/topics/tracking.mdx similarity index 100% rename from docs/docs/python-sdk/topics/tracking.mdx rename to docs/docs-infrahub/python-sdk/topics/tracking.mdx diff --git a/docs/docs/readme.mdx b/docs/docs-infrahub/readme.mdx similarity index 100% rename from docs/docs/readme.mdx rename to docs/docs-infrahub/readme.mdx diff --git a/docs/docs/reference/api-server.mdx b/docs/docs-infrahub/reference/api-server.mdx similarity index 100% rename from docs/docs/reference/api-server.mdx rename to docs/docs-infrahub/reference/api-server.mdx diff --git a/docs/docs/reference/configuration.mdx b/docs/docs-infrahub/reference/configuration.mdx similarity index 100% rename from docs/docs/reference/configuration.mdx rename to docs/docs-infrahub/reference/configuration.mdx diff --git a/docs/docs/reference/dotinfrahub.mdx b/docs/docs-infrahub/reference/dotinfrahub.mdx similarity index 100% rename from docs/docs/reference/dotinfrahub.mdx rename to docs/docs-infrahub/reference/dotinfrahub.mdx diff --git a/docs/docs/reference/git-agent.mdx b/docs/docs-infrahub/reference/git-agent.mdx similarity index 100% rename from docs/docs/reference/git-agent.mdx rename to docs/docs-infrahub/reference/git-agent.mdx diff --git a/docs/docs/reference/infrahub-cli/infrahub-db.mdx b/docs/docs-infrahub/reference/infrahub-cli/infrahub-db.mdx similarity index 100% rename from docs/docs/reference/infrahub-cli/infrahub-db.mdx rename to docs/docs-infrahub/reference/infrahub-cli/infrahub-db.mdx diff --git a/docs/docs/reference/infrahub-cli/infrahub-git-agent.mdx b/docs/docs-infrahub/reference/infrahub-cli/infrahub-git-agent.mdx similarity index 100% rename from docs/docs/reference/infrahub-cli/infrahub-git-agent.mdx rename to docs/docs-infrahub/reference/infrahub-cli/infrahub-git-agent.mdx diff --git a/docs/docs/reference/infrahub-cli/infrahub-server.mdx b/docs/docs-infrahub/reference/infrahub-cli/infrahub-server.mdx similarity index 100% rename from docs/docs/reference/infrahub-cli/infrahub-server.mdx rename to docs/docs-infrahub/reference/infrahub-cli/infrahub-server.mdx diff --git a/docs/docs/reference/infrahub-tests.mdx b/docs/docs-infrahub/reference/infrahub-tests.mdx similarity index 100% rename from docs/docs/reference/infrahub-tests.mdx rename to docs/docs-infrahub/reference/infrahub-tests.mdx diff --git a/docs/docs/reference/menu.mdx b/docs/docs-infrahub/reference/menu.mdx similarity index 100% rename from docs/docs/reference/menu.mdx rename to docs/docs-infrahub/reference/menu.mdx diff --git a/docs/docs/reference/message-bus-events.mdx b/docs/docs-infrahub/reference/message-bus-events.mdx similarity index 100% rename from docs/docs/reference/message-bus-events.mdx rename to docs/docs-infrahub/reference/message-bus-events.mdx diff --git a/docs/docs/reference/permissions.mdx b/docs/docs-infrahub/reference/permissions.mdx similarity index 100% rename from docs/docs/reference/permissions.mdx rename to docs/docs-infrahub/reference/permissions.mdx diff --git a/docs/docs/reference/schema-validation.mdx b/docs/docs-infrahub/reference/schema-validation.mdx similarity index 100% rename from docs/docs/reference/schema-validation.mdx rename to docs/docs-infrahub/reference/schema-validation.mdx diff --git a/docs/docs/reference/schema/attribute.mdx b/docs/docs-infrahub/reference/schema/attribute.mdx similarity index 100% rename from docs/docs/reference/schema/attribute.mdx rename to docs/docs-infrahub/reference/schema/attribute.mdx diff --git a/docs/docs/reference/schema/generic.mdx b/docs/docs-infrahub/reference/schema/generic.mdx similarity index 100% rename from docs/docs/reference/schema/generic.mdx rename to docs/docs-infrahub/reference/schema/generic.mdx diff --git a/docs/docs/reference/schema/groups.mdx b/docs/docs-infrahub/reference/schema/groups.mdx similarity index 100% rename from docs/docs/reference/schema/groups.mdx rename to docs/docs-infrahub/reference/schema/groups.mdx diff --git a/docs/docs/reference/schema/node-extension.mdx b/docs/docs-infrahub/reference/schema/node-extension.mdx similarity index 100% rename from docs/docs/reference/schema/node-extension.mdx rename to docs/docs-infrahub/reference/schema/node-extension.mdx diff --git a/docs/docs/reference/schema/node.mdx b/docs/docs-infrahub/reference/schema/node.mdx similarity index 100% rename from docs/docs/reference/schema/node.mdx rename to docs/docs-infrahub/reference/schema/node.mdx diff --git a/docs/docs/reference/schema/relationship.mdx b/docs/docs-infrahub/reference/schema/relationship.mdx similarity index 100% rename from docs/docs/reference/schema/relationship.mdx rename to docs/docs-infrahub/reference/schema/relationship.mdx diff --git a/docs/docs/reference/schema/validator-migration.mdx b/docs/docs-infrahub/reference/schema/validator-migration.mdx similarity index 100% rename from docs/docs/reference/schema/validator-migration.mdx rename to docs/docs-infrahub/reference/schema/validator-migration.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_10.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_10.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_10.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_10.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_11.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_11.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_11.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_11.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_12.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_12.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_12.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_12.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_13.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_13.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_13.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_13.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_14.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_14.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_14.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_14.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_15_0.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_15_0.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_15_0.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_15_0.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_15_1.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_15_1.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_15_1.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_15_1.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_15_2.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_15_2.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_15_2.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_15_2.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_15_3.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_15_3.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_15_3.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_15_3.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_16_0.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_16_0.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_16_0.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_16_0.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_16_1.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_16_1.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_16_1.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_16_1.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_16_2.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_16_2.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_16_2.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_16_2.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_16_3.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_16_3.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_16_3.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_16_3.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_16_4.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_16_4.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_16_4.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_16_4.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_6.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_6.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_6.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_6.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_7.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_7.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_7.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_7.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_8.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_8.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_8.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_8.mdx diff --git a/docs/docs/release-notes/infrahub/release-0_9.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_9.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-0_9.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-0_9.mdx diff --git a/docs/docs/release-notes/infrahub/release-1_0_0.mdx b/docs/docs-infrahub/release-notes/infrahub/release-1_0_0.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-1_0_0.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-1_0_0.mdx diff --git a/docs/docs/release-notes/infrahub/release-1_0_1.mdx b/docs/docs-infrahub/release-notes/infrahub/release-1_0_1.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-1_0_1.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-1_0_1.mdx diff --git a/docs/docs/release-notes/infrahub/release-1_0_10.mdx b/docs/docs-infrahub/release-notes/infrahub/release-1_0_10.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-1_0_10.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-1_0_10.mdx diff --git a/docs/docs/release-notes/infrahub/release-1_0_2.mdx b/docs/docs-infrahub/release-notes/infrahub/release-1_0_2.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-1_0_2.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-1_0_2.mdx diff --git a/docs/docs/release-notes/infrahub/release-1_0_3.mdx b/docs/docs-infrahub/release-notes/infrahub/release-1_0_3.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-1_0_3.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-1_0_3.mdx diff --git a/docs/docs/release-notes/infrahub/release-1_0_4.mdx b/docs/docs-infrahub/release-notes/infrahub/release-1_0_4.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-1_0_4.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-1_0_4.mdx diff --git a/docs/docs/release-notes/infrahub/release-1_0_5.mdx b/docs/docs-infrahub/release-notes/infrahub/release-1_0_5.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-1_0_5.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-1_0_5.mdx diff --git a/docs/docs/release-notes/infrahub/release-1_0_6.mdx b/docs/docs-infrahub/release-notes/infrahub/release-1_0_6.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-1_0_6.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-1_0_6.mdx diff --git a/docs/docs/release-notes/infrahub/release-1_0_7.mdx b/docs/docs-infrahub/release-notes/infrahub/release-1_0_7.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-1_0_7.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-1_0_7.mdx diff --git a/docs/docs/release-notes/infrahub/release-1_0_8.mdx b/docs/docs-infrahub/release-notes/infrahub/release-1_0_8.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-1_0_8.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-1_0_8.mdx diff --git a/docs/docs/release-notes/infrahub/release-1_0_9.mdx b/docs/docs-infrahub/release-notes/infrahub/release-1_0_9.mdx similarity index 100% rename from docs/docs/release-notes/infrahub/release-1_0_9.mdx rename to docs/docs-infrahub/release-notes/infrahub/release-1_0_9.mdx diff --git a/docs/docs/release-notes/python-sdk/release-0_13.mdx b/docs/docs-infrahub/release-notes/python-sdk/release-0_13.mdx similarity index 100% rename from docs/docs/release-notes/python-sdk/release-0_13.mdx rename to docs/docs-infrahub/release-notes/python-sdk/release-0_13.mdx diff --git a/docs/docs/release-notes/python-sdk/release-1_0-DRAFT.mdx b/docs/docs-infrahub/release-notes/python-sdk/release-1_0-DRAFT.mdx similarity index 100% rename from docs/docs/release-notes/python-sdk/release-1_0-DRAFT.mdx rename to docs/docs-infrahub/release-notes/python-sdk/release-1_0-DRAFT.mdx diff --git a/docs/docs/schemas/edge_topology.d2 b/docs/docs-infrahub/schemas/edge_topology.d2 similarity index 100% rename from docs/docs/schemas/edge_topology.d2 rename to docs/docs-infrahub/schemas/edge_topology.d2 diff --git a/docs/docs/schemas/edge_topology.svg b/docs/docs-infrahub/schemas/edge_topology.svg similarity index 100% rename from docs/docs/schemas/edge_topology.svg rename to docs/docs-infrahub/schemas/edge_topology.svg diff --git a/docs/docs/snippets/pre-reqs-base.mdx b/docs/docs-infrahub/snippets/pre-reqs-base.mdx similarity index 100% rename from docs/docs/snippets/pre-reqs-base.mdx rename to docs/docs-infrahub/snippets/pre-reqs-base.mdx diff --git a/docs/docs/snippets/pre-reqs-frontend.mdx b/docs/docs-infrahub/snippets/pre-reqs-frontend.mdx similarity index 100% rename from docs/docs/snippets/pre-reqs-frontend.mdx rename to docs/docs-infrahub/snippets/pre-reqs-frontend.mdx diff --git a/docs/docs/topics/architecture.mdx b/docs/docs-infrahub/topics/architecture.mdx similarity index 100% rename from docs/docs/topics/architecture.mdx rename to docs/docs-infrahub/topics/architecture.mdx diff --git a/docs/docs/topics/artifact.mdx b/docs/docs-infrahub/topics/artifact.mdx similarity index 100% rename from docs/docs/topics/artifact.mdx rename to docs/docs-infrahub/topics/artifact.mdx diff --git a/docs/docs/topics/auth.mdx b/docs/docs-infrahub/topics/auth.mdx similarity index 100% rename from docs/docs/topics/auth.mdx rename to docs/docs-infrahub/topics/auth.mdx diff --git a/docs/docs/topics/check.mdx b/docs/docs-infrahub/topics/check.mdx similarity index 100% rename from docs/docs/topics/check.mdx rename to docs/docs-infrahub/topics/check.mdx diff --git a/docs/docs/topics/database-backup.mdx b/docs/docs-infrahub/topics/database-backup.mdx similarity index 100% rename from docs/docs/topics/database-backup.mdx rename to docs/docs-infrahub/topics/database-backup.mdx diff --git a/docs/docs/topics/event-handling.mdx b/docs/docs-infrahub/topics/event-handling.mdx similarity index 100% rename from docs/docs/topics/event-handling.mdx rename to docs/docs-infrahub/topics/event-handling.mdx diff --git a/docs/docs/topics/generator.mdx b/docs/docs-infrahub/topics/generator.mdx similarity index 100% rename from docs/docs/topics/generator.mdx rename to docs/docs-infrahub/topics/generator.mdx diff --git a/docs/docs/topics/graphql.mdx b/docs/docs-infrahub/topics/graphql.mdx similarity index 100% rename from docs/docs/topics/graphql.mdx rename to docs/docs-infrahub/topics/graphql.mdx diff --git a/docs/docs/topics/groups.mdx b/docs/docs-infrahub/topics/groups.mdx similarity index 100% rename from docs/docs/topics/groups.mdx rename to docs/docs-infrahub/topics/groups.mdx diff --git a/docs/docs/topics/hardware-requirements.mdx b/docs/docs-infrahub/topics/hardware-requirements.mdx similarity index 100% rename from docs/docs/topics/hardware-requirements.mdx rename to docs/docs-infrahub/topics/hardware-requirements.mdx diff --git a/docs/docs/topics/infrahub-yml.mdx b/docs/docs-infrahub/topics/infrahub-yml.mdx similarity index 100% rename from docs/docs/topics/infrahub-yml.mdx rename to docs/docs-infrahub/topics/infrahub-yml.mdx diff --git a/docs/docs/topics/ipam.mdx b/docs/docs-infrahub/topics/ipam.mdx similarity index 100% rename from docs/docs/topics/ipam.mdx rename to docs/docs-infrahub/topics/ipam.mdx diff --git a/docs/docs/topics/local-demo-environment.mdx b/docs/docs-infrahub/topics/local-demo-environment.mdx similarity index 100% rename from docs/docs/topics/local-demo-environment.mdx rename to docs/docs-infrahub/topics/local-demo-environment.mdx diff --git a/docs/docs/topics/metadata.mdx b/docs/docs-infrahub/topics/metadata.mdx similarity index 100% rename from docs/docs/topics/metadata.mdx rename to docs/docs-infrahub/topics/metadata.mdx diff --git a/docs/docs/topics/object-storage.mdx b/docs/docs-infrahub/topics/object-storage.mdx similarity index 100% rename from docs/docs/topics/object-storage.mdx rename to docs/docs-infrahub/topics/object-storage.mdx diff --git a/docs/docs/topics/permissions-roles.mdx b/docs/docs-infrahub/topics/permissions-roles.mdx similarity index 100% rename from docs/docs/topics/permissions-roles.mdx rename to docs/docs-infrahub/topics/permissions-roles.mdx diff --git a/docs/docs/topics/profiles.mdx b/docs/docs-infrahub/topics/profiles.mdx similarity index 100% rename from docs/docs/topics/profiles.mdx rename to docs/docs-infrahub/topics/profiles.mdx diff --git a/docs/docs/topics/proposed-change.mdx b/docs/docs-infrahub/topics/proposed-change.mdx similarity index 100% rename from docs/docs/topics/proposed-change.mdx rename to docs/docs-infrahub/topics/proposed-change.mdx diff --git a/docs/docs/topics/repository.mdx b/docs/docs-infrahub/topics/repository.mdx similarity index 100% rename from docs/docs/topics/repository.mdx rename to docs/docs-infrahub/topics/repository.mdx diff --git a/docs/docs/topics/resource-manager.mdx b/docs/docs-infrahub/topics/resource-manager.mdx similarity index 100% rename from docs/docs/topics/resource-manager.mdx rename to docs/docs-infrahub/topics/resource-manager.mdx diff --git a/docs/docs/topics/resources-testing-framework.mdx b/docs/docs-infrahub/topics/resources-testing-framework.mdx similarity index 100% rename from docs/docs/topics/resources-testing-framework.mdx rename to docs/docs-infrahub/topics/resources-testing-framework.mdx diff --git a/docs/docs/topics/schema.mdx b/docs/docs-infrahub/topics/schema.mdx similarity index 100% rename from docs/docs/topics/schema.mdx rename to docs/docs-infrahub/topics/schema.mdx diff --git a/docs/docs/topics/transformation.mdx b/docs/docs-infrahub/topics/transformation.mdx similarity index 100% rename from docs/docs/topics/transformation.mdx rename to docs/docs-infrahub/topics/transformation.mdx diff --git a/docs/docs/topics/version-control.mdx b/docs/docs-infrahub/topics/version-control.mdx similarity index 100% rename from docs/docs/topics/version-control.mdx rename to docs/docs-infrahub/topics/version-control.mdx diff --git a/docs/docs/tutorials/getting-started/branches.mdx b/docs/docs-infrahub/tutorials/getting-started/branches.mdx similarity index 100% rename from docs/docs/tutorials/getting-started/branches.mdx rename to docs/docs-infrahub/tutorials/getting-started/branches.mdx diff --git a/docs/docs/tutorials/getting-started/creating-an-object.mdx b/docs/docs-infrahub/tutorials/getting-started/creating-an-object.mdx similarity index 100% rename from docs/docs/tutorials/getting-started/creating-an-object.mdx rename to docs/docs-infrahub/tutorials/getting-started/creating-an-object.mdx diff --git a/docs/docs/tutorials/getting-started/git-integration.mdx b/docs/docs-infrahub/tutorials/getting-started/git-integration.mdx similarity index 100% rename from docs/docs/tutorials/getting-started/git-integration.mdx rename to docs/docs-infrahub/tutorials/getting-started/git-integration.mdx diff --git a/docs/docs/tutorials/getting-started/graphql-mutation.mdx b/docs/docs-infrahub/tutorials/getting-started/graphql-mutation.mdx similarity index 100% rename from docs/docs/tutorials/getting-started/graphql-mutation.mdx rename to docs/docs-infrahub/tutorials/getting-started/graphql-mutation.mdx diff --git a/docs/docs/tutorials/getting-started/graphql-query.mdx b/docs/docs-infrahub/tutorials/getting-started/graphql-query.mdx similarity index 100% rename from docs/docs/tutorials/getting-started/graphql-query.mdx rename to docs/docs-infrahub/tutorials/getting-started/graphql-query.mdx diff --git a/docs/docs/tutorials/getting-started/historical-data.mdx b/docs/docs-infrahub/tutorials/getting-started/historical-data.mdx similarity index 100% rename from docs/docs/tutorials/getting-started/historical-data.mdx rename to docs/docs-infrahub/tutorials/getting-started/historical-data.mdx diff --git a/docs/docs/tutorials/getting-started/introduction-to-infrahub.mdx b/docs/docs-infrahub/tutorials/getting-started/introduction-to-infrahub.mdx similarity index 100% rename from docs/docs/tutorials/getting-started/introduction-to-infrahub.mdx rename to docs/docs-infrahub/tutorials/getting-started/introduction-to-infrahub.mdx diff --git a/docs/docs/tutorials/getting-started/lineage-information.mdx b/docs/docs-infrahub/tutorials/getting-started/lineage-information.mdx similarity index 100% rename from docs/docs/tutorials/getting-started/lineage-information.mdx rename to docs/docs-infrahub/tutorials/getting-started/lineage-information.mdx diff --git a/docs/docs/tutorials/getting-started/readme.mdx b/docs/docs-infrahub/tutorials/getting-started/readme.mdx similarity index 100% rename from docs/docs/tutorials/getting-started/readme.mdx rename to docs/docs-infrahub/tutorials/getting-started/readme.mdx diff --git a/docs/docs/tutorials/getting-started/rendering-configuration.mdx b/docs/docs-infrahub/tutorials/getting-started/rendering-configuration.mdx similarity index 100% rename from docs/docs/tutorials/getting-started/rendering-configuration.mdx rename to docs/docs-infrahub/tutorials/getting-started/rendering-configuration.mdx diff --git a/docs/docs/tutorials/getting-started/resource-manager.mdx b/docs/docs-infrahub/tutorials/getting-started/resource-manager.mdx similarity index 100% rename from docs/docs/tutorials/getting-started/resource-manager.mdx rename to docs/docs-infrahub/tutorials/getting-started/resource-manager.mdx diff --git a/docs/docs/tutorials/getting-started/schema.mdx b/docs/docs-infrahub/tutorials/getting-started/schema.mdx similarity index 100% rename from docs/docs/tutorials/getting-started/schema.mdx rename to docs/docs-infrahub/tutorials/getting-started/schema.mdx diff --git a/docs/docs-projects/readme.mdx b/docs/docs-projects/readme.mdx new file mode 100644 index 0000000..6a0dd9b --- /dev/null +++ b/docs/docs-projects/readme.mdx @@ -0,0 +1,9 @@ +--- +title: Introduction +--- + +Infrahub from [OpsMill](https://opsmill.com) is taking a new approach to Infrastructure Management by providing a new generation of datastore to organize and control all the data that defines how an infrastructure should run. Infrahub offers a central hub to manage the data, templates and playbooks that power your infrastructure by combining the version control and branch management capabilities of Git with the flexible data model and UI of a graph database. + +## Learn about Infrahub + +Blah diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 19c29fb..82da415 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -42,9 +42,8 @@ const config: Config = { "classic", { docs: { - editUrl: "https://github.com/opsmill/infrahub/tree/stable/docs", - path: "docs", - routeBasePath: "/", + path: "docs-projects", + routeBasePath: "projects", sidebarCollapsed: true, sidebarPath: "./sidebars.ts", }, @@ -59,11 +58,23 @@ const config: Config = { [ '@docusaurus/plugin-content-docs', { - id: 'demo', - path: 'demo-dc-fabric', - routeBasePath: 'demo', + id: 'docs-infrahub', + path: 'docs-infrahub', + routeBasePath: '/', sidebarCollapsed: true, + sidebarPath: './sidebars-infrahub.ts', + editUrl: "https://github.com/opsmill/infrahub/tree/stable/docs", + }, + ], + [ + '@docusaurus/plugin-content-docs', + { + id: 'docs-demo', + path: 'docs-demo', + routeBasePath: 'demo', + sidebarCollapsed: false, sidebarPath: './sidebars-demo.ts', + editUrl: "https://github.com/opsmill/infrahub-demo-dc-fabric/tree/main/docs", }, ], ], @@ -91,16 +102,22 @@ const config: Config = { position: 'left', label: 'Projects', items: [ + { + type: "docSidebar", + sidebarId: "landingSidebar", + label: "Infrahub Projects", + }, { type: "docSidebar", sidebarId: "docsSidebar", label: "Infrahub Documentation", + docsPluginId: "docs-infrahub", }, { type: "docSidebar", sidebarId: "demoSidebar", label: "demo-dc-fabric", - docsPluginId: "demo", + docsPluginId: "docs-demo", }, ], }, diff --git a/docs/sidebars-infrahub.ts b/docs/sidebars-infrahub.ts new file mode 100644 index 0000000..c9e61aa --- /dev/null +++ b/docs/sidebars-infrahub.ts @@ -0,0 +1,364 @@ +import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; + +/** + * Creating a sidebar enables you to: + - create an ordered group of docs + - render a sidebar for each doc of that group + - provide next/previous navigation + + The sidebars can be generated from the filesystem, or explicitly defined here. + + Create as many sidebars as you want. + */ +const sidebars: SidebarsConfig = { + docsSidebar: [ + 'readme', + { + type: 'category', + label: 'Infrahub Overview', + link: { type: 'doc', id: 'overview/readme' }, + items: [ + 'overview/interfaces', + 'overview/schema', + 'overview/data', + 'overview/transformations', + 'overview/versioning', + 'overview/generators', + 'overview/integrations', + ], + }, + { + type: 'category', + label: 'Tutorials', + link: { + type: 'generated-index', + slug: 'tutorials' + }, + items: [ + { + type: 'category', + label: 'Getting started', + link: { type: 'doc', id: 'tutorials/getting-started/readme' }, + items: [ + 'tutorials/getting-started/introduction-to-infrahub', + 'tutorials/getting-started/schema', + 'tutorials/getting-started/creating-an-object', + 'tutorials/getting-started/branches', + 'tutorials/getting-started/historical-data', + 'tutorials/getting-started/lineage-information', + 'tutorials/getting-started/resource-manager', + 'tutorials/getting-started/git-integration', + 'tutorials/getting-started/rendering-configuration', + 'tutorials/getting-started/graphql-query', + 'tutorials/getting-started/graphql-mutation' + ], + }, + ], + }, + { + type: 'category', + label: 'Guides', + link: { + type: 'generated-index', + slug: 'guides' + }, + items: [ + 'guides/installation', + 'guides/create-schema', + 'guides/import-schema', + 'guides/menu', + 'guides/accounts-permissions', + 'guides/groups', + 'guides/generator', + 'guides/repository', + 'guides/jinja2-transform', + 'guides/python-transform', + 'guides/artifact', + 'guides/database-backup', + 'guides/profiles', + 'guides/object-storage', + 'guides/sso', + 'guides/check', + 'guides/resource-manager', + 'guides/managing-api-tokens', + ], + }, + { + type: 'category', + label: 'Topics', + link: { + type: 'generated-index', + slug: 'topics' + }, + items: [ + 'topics/infrahub-yml', + 'topics/architecture', + 'topics/artifact', + 'topics/check', + 'topics/metadata', + 'topics/database-backup', + 'topics/local-demo-environment', + 'topics/generator', + 'topics/graphql', + 'topics/groups', + 'topics/hardware-requirements', + 'topics/version-control', + 'topics/ipam', + 'topics/object-storage', + 'topics/permissions-roles', + 'topics/profiles', + 'topics/proposed-change', + 'topics/repository', + 'topics/resource-manager', + 'topics/resources-testing-framework', + 'topics/schema', + 'topics/transformation', + 'topics/auth', + ], + }, + { + type: 'category', + label: 'Reference', + link: { + type: 'generated-index', + slug: 'reference' + }, + items: [ + { + type: 'category', + label: 'Schema', + link: { + type: 'generated-index', + slug: 'reference/schema', + }, + items: [ + 'reference/schema/node', + 'reference/schema/node-extension', + 'reference/schema/attribute', + 'reference/schema/groups', + 'reference/schema/relationship', + 'reference/schema/generic', + 'reference/schema/validator-migration', + ], + }, + 'reference/menu', + { + type: 'category', + label: 'infrahub cli', + link: { + type: 'generated-index', + slug: 'reference/infrahub-cli', + }, + items: [ + 'reference/infrahub-cli/infrahub-db', + 'reference/infrahub-cli/infrahub-git-agent', + 'reference/infrahub-cli/infrahub-server' + ], + }, + 'reference/configuration', + 'reference/git-agent', + 'reference/message-bus-events', + 'reference/api-server', + 'reference/dotinfrahub', + 'reference/infrahub-tests', + 'reference/permissions', + 'reference/schema-validation' + ], + }, + { + type: 'category', + label: 'Python SDK', + link: { + type: 'doc', + id: 'python-sdk/readme' + }, + items: [ + { + type: 'category', + label: 'Guides', + items: [ + 'python-sdk/guides/installation', + 'python-sdk/guides/client', + 'python-sdk/guides/query_data', + 'python-sdk/guides/create_update_delete', + 'python-sdk/guides/branches', + 'python-sdk/guides/store', + 'python-sdk/guides/tracking', + 'python-sdk/guides/batch', + 'python-sdk/guides/object-storage', + 'python-sdk/guides/resource-manager' + ], + }, + { + type: 'category', + label: 'Topics', + items: [ + 'python-sdk/topics/tracking' + ], + }, + { + type: 'category', + label: 'Reference', + items: [ + 'python-sdk/reference/config' + ], + }, + ], + }, + { + type: 'category', + label: 'infrahubctl', + link: { type: 'doc', id: 'infrahubctl' }, + items: [{ type: 'autogenerated', dirName: 'infrahubctl' }], + }, + { + type: 'category', + label: 'Integrations', + link: { + type: 'doc', + id: 'integrations/readme' + }, + items: [ + { + type: 'category', + label: 'Infrahub Ansible Collection', + link: { + type: 'doc', + id: 'integrations/infrahub-ansible/readme' + }, + items: [ + { + }, + ], + }, + { + type: 'category', + label: 'Infrahub Sync', + link: { + type: 'doc', + id: 'integrations/sync/readme' + }, + items: [ + { + type: 'category', + label: 'Guides', + items: [ + 'integrations/sync/guides/installation', + 'integrations/sync/guides/creation', + 'integrations/sync/guides/run', + ], + }, + { + type: 'category', + label: 'Reference', + items: [ + 'integrations/sync/reference/config', + 'integrations/sync/reference/cli', + ], + }, + ], + }, + { + type: 'category', + label: 'Nornir plugin for Infrahub', + link: { + type: 'doc', + id: 'integrations/nornir-infrahub/readme' + }, + items: [ + { + }, + ], + }, + ] + }, + { + type: 'category', + label: 'Development', + link: { + type: 'generated-index', + slug: 'development' + }, + + items: [ + 'development/editor', + 'development/changelog', + 'development/backend', + { + type: 'category', + label: 'Frontend guide', + link: { type: 'doc', id: 'development/frontend/readme' }, + items: [ + 'development/frontend/getting-set-up', + 'development/frontend/testing-guidelines', + ], + }, + 'development/docs' + ], + }, + { + type: 'category', + label: 'Release Notes', + link: { + type: 'generated-index', + slug: 'release-notes' + }, + items: [ + { + type: 'category', + label: 'Infrahub', + link: { + type: 'generated-index', + slug: 'release-notes/infrahub', + }, + items: [ + 'release-notes/infrahub/release-1_0_10', + 'release-notes/infrahub/release-1_0_9', + 'release-notes/infrahub/release-1_0_8', + 'release-notes/infrahub/release-1_0_7', + 'release-notes/infrahub/release-1_0_6', + 'release-notes/infrahub/release-1_0_5', + 'release-notes/infrahub/release-1_0_4', + 'release-notes/infrahub/release-1_0_3', + 'release-notes/infrahub/release-1_0_2', + 'release-notes/infrahub/release-1_0_1', + 'release-notes/infrahub/release-1_0_0', + 'release-notes/infrahub/release-0_16_4', + 'release-notes/infrahub/release-0_16_3', + 'release-notes/infrahub/release-0_16_2', + 'release-notes/infrahub/release-0_16_1', + 'release-notes/infrahub/release-0_16_0', + 'release-notes/infrahub/release-0_15_3', + 'release-notes/infrahub/release-0_15_2', + 'release-notes/infrahub/release-0_15_1', + 'release-notes/infrahub/release-0_15_0', + 'release-notes/infrahub/release-0_14', + 'release-notes/infrahub/release-0_13', + 'release-notes/infrahub/release-0_12', + 'release-notes/infrahub/release-0_11', + 'release-notes/infrahub/release-0_10', + 'release-notes/infrahub/release-0_9', + 'release-notes/infrahub/release-0_8', + 'release-notes/infrahub/release-0_7', + 'release-notes/infrahub/release-0_6' + ], + }, + { + type: 'category', + label: 'Python SDK', + link: { + type: 'generated-index', + slug: 'release-notes/python-sdk', + }, + items: [ + // 'release-notes/python-sdk/release-1_0-DRAFT', + 'release-notes/python-sdk/release-0_13' + ], + }, + ], + }, + 'faq/faq', + ], +}; + +export default sidebars; diff --git a/docs/sidebars.ts b/docs/sidebars.ts index c9e61aa..27c5e80 100644 --- a/docs/sidebars.ts +++ b/docs/sidebars.ts @@ -1,364 +1,9 @@ -import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; +import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; -/** - * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. - */ const sidebars: SidebarsConfig = { - docsSidebar: [ + landingSidebar: [ 'readme', - { - type: 'category', - label: 'Infrahub Overview', - link: { type: 'doc', id: 'overview/readme' }, - items: [ - 'overview/interfaces', - 'overview/schema', - 'overview/data', - 'overview/transformations', - 'overview/versioning', - 'overview/generators', - 'overview/integrations', - ], - }, - { - type: 'category', - label: 'Tutorials', - link: { - type: 'generated-index', - slug: 'tutorials' - }, - items: [ - { - type: 'category', - label: 'Getting started', - link: { type: 'doc', id: 'tutorials/getting-started/readme' }, - items: [ - 'tutorials/getting-started/introduction-to-infrahub', - 'tutorials/getting-started/schema', - 'tutorials/getting-started/creating-an-object', - 'tutorials/getting-started/branches', - 'tutorials/getting-started/historical-data', - 'tutorials/getting-started/lineage-information', - 'tutorials/getting-started/resource-manager', - 'tutorials/getting-started/git-integration', - 'tutorials/getting-started/rendering-configuration', - 'tutorials/getting-started/graphql-query', - 'tutorials/getting-started/graphql-mutation' - ], - }, - ], - }, - { - type: 'category', - label: 'Guides', - link: { - type: 'generated-index', - slug: 'guides' - }, - items: [ - 'guides/installation', - 'guides/create-schema', - 'guides/import-schema', - 'guides/menu', - 'guides/accounts-permissions', - 'guides/groups', - 'guides/generator', - 'guides/repository', - 'guides/jinja2-transform', - 'guides/python-transform', - 'guides/artifact', - 'guides/database-backup', - 'guides/profiles', - 'guides/object-storage', - 'guides/sso', - 'guides/check', - 'guides/resource-manager', - 'guides/managing-api-tokens', - ], - }, - { - type: 'category', - label: 'Topics', - link: { - type: 'generated-index', - slug: 'topics' - }, - items: [ - 'topics/infrahub-yml', - 'topics/architecture', - 'topics/artifact', - 'topics/check', - 'topics/metadata', - 'topics/database-backup', - 'topics/local-demo-environment', - 'topics/generator', - 'topics/graphql', - 'topics/groups', - 'topics/hardware-requirements', - 'topics/version-control', - 'topics/ipam', - 'topics/object-storage', - 'topics/permissions-roles', - 'topics/profiles', - 'topics/proposed-change', - 'topics/repository', - 'topics/resource-manager', - 'topics/resources-testing-framework', - 'topics/schema', - 'topics/transformation', - 'topics/auth', - ], - }, - { - type: 'category', - label: 'Reference', - link: { - type: 'generated-index', - slug: 'reference' - }, - items: [ - { - type: 'category', - label: 'Schema', - link: { - type: 'generated-index', - slug: 'reference/schema', - }, - items: [ - 'reference/schema/node', - 'reference/schema/node-extension', - 'reference/schema/attribute', - 'reference/schema/groups', - 'reference/schema/relationship', - 'reference/schema/generic', - 'reference/schema/validator-migration', - ], - }, - 'reference/menu', - { - type: 'category', - label: 'infrahub cli', - link: { - type: 'generated-index', - slug: 'reference/infrahub-cli', - }, - items: [ - 'reference/infrahub-cli/infrahub-db', - 'reference/infrahub-cli/infrahub-git-agent', - 'reference/infrahub-cli/infrahub-server' - ], - }, - 'reference/configuration', - 'reference/git-agent', - 'reference/message-bus-events', - 'reference/api-server', - 'reference/dotinfrahub', - 'reference/infrahub-tests', - 'reference/permissions', - 'reference/schema-validation' - ], - }, - { - type: 'category', - label: 'Python SDK', - link: { - type: 'doc', - id: 'python-sdk/readme' - }, - items: [ - { - type: 'category', - label: 'Guides', - items: [ - 'python-sdk/guides/installation', - 'python-sdk/guides/client', - 'python-sdk/guides/query_data', - 'python-sdk/guides/create_update_delete', - 'python-sdk/guides/branches', - 'python-sdk/guides/store', - 'python-sdk/guides/tracking', - 'python-sdk/guides/batch', - 'python-sdk/guides/object-storage', - 'python-sdk/guides/resource-manager' - ], - }, - { - type: 'category', - label: 'Topics', - items: [ - 'python-sdk/topics/tracking' - ], - }, - { - type: 'category', - label: 'Reference', - items: [ - 'python-sdk/reference/config' - ], - }, - ], - }, - { - type: 'category', - label: 'infrahubctl', - link: { type: 'doc', id: 'infrahubctl' }, - items: [{ type: 'autogenerated', dirName: 'infrahubctl' }], - }, - { - type: 'category', - label: 'Integrations', - link: { - type: 'doc', - id: 'integrations/readme' - }, - items: [ - { - type: 'category', - label: 'Infrahub Ansible Collection', - link: { - type: 'doc', - id: 'integrations/infrahub-ansible/readme' - }, - items: [ - { - }, - ], - }, - { - type: 'category', - label: 'Infrahub Sync', - link: { - type: 'doc', - id: 'integrations/sync/readme' - }, - items: [ - { - type: 'category', - label: 'Guides', - items: [ - 'integrations/sync/guides/installation', - 'integrations/sync/guides/creation', - 'integrations/sync/guides/run', - ], - }, - { - type: 'category', - label: 'Reference', - items: [ - 'integrations/sync/reference/config', - 'integrations/sync/reference/cli', - ], - }, - ], - }, - { - type: 'category', - label: 'Nornir plugin for Infrahub', - link: { - type: 'doc', - id: 'integrations/nornir-infrahub/readme' - }, - items: [ - { - }, - ], - }, - ] - }, - { - type: 'category', - label: 'Development', - link: { - type: 'generated-index', - slug: 'development' - }, - - items: [ - 'development/editor', - 'development/changelog', - 'development/backend', - { - type: 'category', - label: 'Frontend guide', - link: { type: 'doc', id: 'development/frontend/readme' }, - items: [ - 'development/frontend/getting-set-up', - 'development/frontend/testing-guidelines', - ], - }, - 'development/docs' - ], - }, - { - type: 'category', - label: 'Release Notes', - link: { - type: 'generated-index', - slug: 'release-notes' - }, - items: [ - { - type: 'category', - label: 'Infrahub', - link: { - type: 'generated-index', - slug: 'release-notes/infrahub', - }, - items: [ - 'release-notes/infrahub/release-1_0_10', - 'release-notes/infrahub/release-1_0_9', - 'release-notes/infrahub/release-1_0_8', - 'release-notes/infrahub/release-1_0_7', - 'release-notes/infrahub/release-1_0_6', - 'release-notes/infrahub/release-1_0_5', - 'release-notes/infrahub/release-1_0_4', - 'release-notes/infrahub/release-1_0_3', - 'release-notes/infrahub/release-1_0_2', - 'release-notes/infrahub/release-1_0_1', - 'release-notes/infrahub/release-1_0_0', - 'release-notes/infrahub/release-0_16_4', - 'release-notes/infrahub/release-0_16_3', - 'release-notes/infrahub/release-0_16_2', - 'release-notes/infrahub/release-0_16_1', - 'release-notes/infrahub/release-0_16_0', - 'release-notes/infrahub/release-0_15_3', - 'release-notes/infrahub/release-0_15_2', - 'release-notes/infrahub/release-0_15_1', - 'release-notes/infrahub/release-0_15_0', - 'release-notes/infrahub/release-0_14', - 'release-notes/infrahub/release-0_13', - 'release-notes/infrahub/release-0_12', - 'release-notes/infrahub/release-0_11', - 'release-notes/infrahub/release-0_10', - 'release-notes/infrahub/release-0_9', - 'release-notes/infrahub/release-0_8', - 'release-notes/infrahub/release-0_7', - 'release-notes/infrahub/release-0_6' - ], - }, - { - type: 'category', - label: 'Python SDK', - link: { - type: 'generated-index', - slug: 'release-notes/python-sdk', - }, - items: [ - // 'release-notes/python-sdk/release-1_0-DRAFT', - 'release-notes/python-sdk/release-0_13' - ], - }, - ], - }, - 'faq/faq', - ], + ] }; export default sidebars; From 3d89be10545c9d6466815939820af2094d6265fd Mon Sep 17 00:00:00 2001 From: Pete Crocker Date: Thu, 2 Jan 2025 14:36:09 +0000 Subject: [PATCH 2/4] testing menu --- docs/docs-infrahub/development/backend.mdx | 2 +- docs/docs-infrahub/development/docs.mdx | 4 +-- .../development/frontend/getting-set-up.mdx | 2 +- .../guides/accounts-permissions.mdx | 5 ++- docs/docs-infrahub/guides/check.mdx | 8 ++--- docs/docs-infrahub/guides/create-schema.mdx | 6 ++-- docs/docs-infrahub/guides/database-backup.mdx | 2 +- docs/docs-infrahub/guides/generator.mdx | 14 ++++---- docs/docs-infrahub/guides/groups.mdx | 2 +- docs/docs-infrahub/guides/import-schema.mdx | 4 +-- docs/docs-infrahub/guides/installation.mdx | 8 ++--- .../docs-infrahub/guides/jinja2-transform.mdx | 6 ++-- docs/docs-infrahub/guides/menu.mdx | 4 +-- docs/docs-infrahub/guides/object-storage.mdx | 2 +- .../docs-infrahub/guides/python-transform.mdx | 10 +++--- docs/docs-infrahub/guides/repository.mdx | 18 +++++------ .../docs-infrahub/guides/resource-manager.mdx | 8 ++--- docs/docs-infrahub/infrahubctl.mdx | 2 +- .../python-sdk/guides/client.mdx | 2 +- .../python-sdk/guides/object-storage.mdx | 2 +- .../python-sdk/guides/query_data.mdx | 2 +- .../python-sdk/guides/resource-manager.mdx | 2 +- .../python-sdk/guides/tracking.mdx | 2 +- docs/docs-infrahub/python-sdk/readme.mdx | 18 +++++------ .../python-sdk/topics/tracking.mdx | 2 +- docs/docs-infrahub/reference/dotinfrahub.mdx | 6 ++-- .../reference/infrahub-tests.mdx | 4 +-- docs/docs-infrahub/reference/menu.mdx | 2 +- .../reference/message-bus-events.mdx | 2 +- docs/docs-infrahub/reference/permissions.mdx | 2 +- .../reference/schema-validation.mdx | 2 +- .../release-notes/infrahub/release-0_13.mdx | 8 ++--- .../release-notes/infrahub/release-0_16_0.mdx | 6 ++-- docs/docs-infrahub/topics/auth.mdx | 6 ++-- docs/docs-infrahub/topics/check.mdx | 2 +- docs/docs-infrahub/topics/database-backup.mdx | 2 +- docs/docs-infrahub/topics/generator.mdx | 2 +- docs/docs-infrahub/topics/groups.mdx | 2 +- .../topics/hardware-requirements.mdx | 2 +- docs/docs-infrahub/topics/infrahub-yml.mdx | 32 +++++++++---------- .../topics/local-demo-environment.mdx | 4 +-- docs/docs-infrahub/topics/object-storage.mdx | 6 ++-- .../topics/permissions-roles.mdx | 8 ++--- docs/docs-infrahub/topics/repository.mdx | 12 +++---- .../docs-infrahub/topics/resource-manager.mdx | 2 +- .../topics/resources-testing-framework.mdx | 8 ++--- docs/docs-infrahub/topics/schema.mdx | 12 +++---- docs/docs-infrahub/topics/transformation.mdx | 10 +++--- docs/docs-infrahub/topics/version-control.mdx | 4 +-- .../tutorials/getting-started/branches.mdx | 2 +- .../getting-started/git-integration.mdx | 10 +++--- .../introduction-to-infrahub.mdx | 2 +- .../getting-started/lineage-information.mdx | 2 +- .../tutorials/getting-started/readme.mdx | 8 ++--- .../rendering-configuration.mdx | 2 +- .../tutorials/getting-started/schema.mdx | 2 +- docs/docs-projects/readme.mdx | 9 ------ docs/docs/readme.mdx | 28 ++++++++++++++++ docs/docusaurus.config.ts | 22 ++++++------- 59 files changed, 194 insertions(+), 176 deletions(-) delete mode 100644 docs/docs-projects/readme.mdx create mode 100644 docs/docs/readme.mdx diff --git a/docs/docs-infrahub/development/backend.mdx b/docs/docs-infrahub/development/backend.mdx index f32b116..39ff8a0 100644 --- a/docs/docs-infrahub/development/backend.mdx +++ b/docs/docs-infrahub/development/backend.mdx @@ -87,7 +87,7 @@ infrahub-database-1 memgraph/memgraph:2.13.0 "/usr/lib/memgraph/m…" infrahub-message-queue-1 rabbitmq:3.12-management "docker-entrypoint.s…" message-queue 2 hours ago Up 2 hours (healthy) 4369/tcp, 5671/tcp, 0.0.0.0:5672->5672/tcp, 15671/tcp, 15691-15692/tcp, 25672/tcp, 0.0.0.0:15672->15672/tcp ``` -When following a guide, like the [installation guide](/guides/installation.mdx), the command `demo.start` is mentioned. It is slightly different from the `dev.deps` that is mentioned here. The `demo.start` will bring up a demo environment as a whole including services and Infrahub while the `dev.deps` will only start the services as seen in the code block above. +When following a guide, like the [installation guide](../guides/installation.mdx), the command `demo.start` is mentioned. It is slightly different from the `dev.deps` that is mentioned here. The `demo.start` will bring up a demo environment as a whole including services and Infrahub while the `dev.deps` will only start the services as seen in the code block above. ## Running Infrahub test suite diff --git a/docs/docs-infrahub/development/docs.mdx b/docs/docs-infrahub/development/docs.mdx index 367ce8a..f33e8db 100644 --- a/docs/docs-infrahub/development/docs.mdx +++ b/docs/docs-infrahub/development/docs.mdx @@ -242,7 +242,7 @@ For a deeper dive into reference docs, refer to the [diátaxis reference page](h ## Application screenshots -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](/development/frontend/testing-guidelines#e2e-tests). You'll find the e2e tests specifically designed for tutorials located in `frontend/app/tests/e2e/tutorial`. +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](../development/frontend/testing-guidelines#e2e-tests). You'll find the e2e tests specifically designed for tutorials located in `frontend/app/tests/e2e/tutorial`. ### Updating all screenshots manually @@ -279,7 +279,7 @@ The screenshots will be saved in `docs/docs/media`. You can then use them in our #### 1. Locate on which test the screenshot should be added -If the test does not exist yet, create must create it first. Refer to the [write e2e tests](/development/frontend/testing-guidelines#writing-e2e-tests) for more information. +If the test does not exist yet, create must create it first. Refer to the [write e2e tests](../development/frontend/testing-guidelines#writing-e2e-tests) for more information. #### 2. Add the screenshot diff --git a/docs/docs-infrahub/development/frontend/getting-set-up.mdx b/docs/docs-infrahub/development/frontend/getting-set-up.mdx index b03630d..5a32c96 100644 --- a/docs/docs-infrahub/development/frontend/getting-set-up.mdx +++ b/docs/docs-infrahub/development/frontend/getting-set-up.mdx @@ -34,7 +34,7 @@ npm install npm start ``` -To can access your local server at [http://localhost:8080/](http://localhost:8080/). If you are not familiar with Infrahub, learn by following our [tutorial](/tutorials/getting-started/). +To can access your local server at [http://localhost:8080/](http://localhost:8080/). If you are not familiar with Infrahub, learn by following our [tutorial](../../tutorials/getting-started). ## 3. Run all tests diff --git a/docs/docs-infrahub/guides/accounts-permissions.mdx b/docs/docs-infrahub/guides/accounts-permissions.mdx index d9efd88..474e7cc 100644 --- a/docs/docs-infrahub/guides/accounts-permissions.mdx +++ b/docs/docs-infrahub/guides/accounts-permissions.mdx @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem'; In Infrahub, managing access and control starts with creating accounts, assigning them to groups, and managing their roles and permissions. This guide outlines how to create new accounts, accounts groups, and assign roles and permissions. -For more information on roles and permissions, see the [Roles and Permissions](/topics/permissions-roles) topic. +For more information on roles and permissions, see the [Roles and Permissions](../topics/permissions-roles) topic. ## Creating a new account @@ -131,8 +131,7 @@ In the GraphQL sandbox, execute the following mutation to create a new role: ## Managing permissions Permissions can be managed through roles assigned to users or groups. -Infrahub supports **Global** and **Object-specific** permissions, allowing fine-grained control over what users can do within the system. -For a complete list of available global and object permissions, see the [Roles and Permissions documentation](/reference/permissions.mdx). +For a complete list of available global and object permissions, see the [Roles and Permissions documentation](../reference/permissions.mdx). ### Creating and global permissions diff --git a/docs/docs-infrahub/guides/check.mdx b/docs/docs-infrahub/guides/check.mdx index b71d1c5..ebfd703 100644 --- a/docs/docs-infrahub/guides/check.mdx +++ b/docs/docs-infrahub/guides/check.mdx @@ -4,11 +4,11 @@ title: Creating a Check ## Creating a Check -Within Infrahub a [Check](/topics/check) is defined in an [external repository](/topics/repository). However, during development and troubleshooting it is easiest to start from your local computer and run the check using [infrahubctl check](/infrahubctl/infrahubctl-check). +Within Infrahub a [Check](../topics/check) is defined in an [external repository](../topics/repository). However, during development and troubleshooting it is easiest to start from your local computer and run the check using [infrahubctl check](../infrahubctl/infrahubctl-check). The goal of this guide is to develop a `Check` and add it to Infrahub, we will achieve this by following these steps. -1. Identify the relevant data in the database that you want to use as input for the check using a [GraphQL query](/topics/graphql), that can take an input parameter to filter the data +1. Identify the relevant data in the database that you want to use as input for the check using a [GraphQL query](../topics/graphql), that can take an input parameter to filter the data 2. Write a Python script that will process and validate the data using your custom business logic 3. Create an entry for the check within an .infrahub.yml file 4. Create a Git repository @@ -110,7 +110,7 @@ Then save the `TagsQuery` as a text file named `tags_check.gql`. ### 2. Create the Python check file -The next step is to create the Check Python business logic. The check is a Python class that inherits from `InfrahubCheck` from the [Python SDK](/python-sdk). Create a file called `tags_check.py`: +The next step is to create the Check Python business logic. The check is a Python class that inherits from `InfrahubCheck` from the [Python SDK](../python-sdk). Create a file called `tags_check.py`: ```python import re @@ -234,7 +234,7 @@ We have now successfully created a check. Most of the checks you will create wou ### 6. Adding the repository to Infrahub -In order to avoid having the same instructions over and over please refer to the guide [adding a repository to Infrahub](/guides/repository) in order to sync the repository you created and make it available within Infrahub. +In order to avoid having the same instructions over and over please refer to the guide [adding a repository to Infrahub](../guides/repository) in order to sync the repository you created and make it available within Infrahub. ### 7. Using the check within Infrahub diff --git a/docs/docs-infrahub/guides/create-schema.mdx b/docs/docs-infrahub/guides/create-schema.mdx index 4f6af57..bd9f5f6 100644 --- a/docs/docs-infrahub/guides/create-schema.mdx +++ b/docs/docs-infrahub/guides/create-schema.mdx @@ -20,13 +20,13 @@ In this guide we will create a schema for a network device and its interfaces. By no mean this is meant to be a complete schema for a network device, there is far more complexity that goes into modeling a schema for a network device, it is just used as an example to guide you through the process. -For a more detailed explanation of the different Attributes and Relations, you can check out our [Schema Topic](/topics/schema). +For a more detailed explanation of the different Attributes and Relations, you can check out our [Schema Topic](../topics/schema). Throughout this guide we will load different schemas into Infrahub into different branches. The fact that multiple schemas can exist simultaneously is a core feature of Infrahub. It is a recommendation and best practice to always use a branch to make changes to the schema. :::note -To help with the development process of a schema definition file, you can leverage [schema validation](/reference/schema-validation) within your editor. +To help with the development process of a schema definition file, you can leverage [schema validation](../reference/schema-validation) within your editor. ::: @@ -341,7 +341,7 @@ In the detailed view of the device in the Web UI, we can now see that the device ## 4. Improving our schema -Although the schema already closely represents what we wanted to achieve, there are still a few improvements we would like to make. For this, we are going to use Infrahub's schema migrations feature. More details can be found in [the Schema topic](/topics/schema#schema-update-and-data-migrations). +Although the schema already closely represents what we wanted to achieve, there are still a few improvements we would like to make. For this, we are going to use Infrahub's schema migrations feature. More details can be found in [the Schema topic](../topics/schema#schema-update-and-data-migrations). 1. adding and `mtu` and `enabled` attribute on the generic `NetworkInterface` 4. deleting the `description` attribute of the generic `NetworkInterface` diff --git a/docs/docs-infrahub/guides/database-backup.mdx b/docs/docs-infrahub/guides/database-backup.mdx index bbb3f6b..ba048fe 100644 --- a/docs/docs-infrahub/guides/database-backup.mdx +++ b/docs/docs-infrahub/guides/database-backup.mdx @@ -5,7 +5,7 @@ title: Database backup and restore # Database backup and restore examples This is a guide on how to backup and restore your database using an Infrahub command line tool. -Please [see this topic](/topics/database-backup) for the requirements for using the tool and an explanation of how it works. +Please [see this topic](../topics/database-backup) for the requirements for using the tool and an explanation of how it works. This guide assumes that you cloned the Infrahub repository to your machine, but you can also copy the content of [this tool's Python file](https://github.com/opsmill/infrahub/tree/stable/utilities/db_backup/__main__.py) into a local Python file and run it that way. diff --git a/docs/docs-infrahub/guides/generator.mdx b/docs/docs-infrahub/guides/generator.mdx index 6e8b6dd..6cbebe7 100644 --- a/docs/docs-infrahub/guides/generator.mdx +++ b/docs/docs-infrahub/guides/generator.mdx @@ -6,11 +6,11 @@ import TabItem from '@theme/TabItem'; # Creating a generator in Infrahub -Within Infrahub a generator is defined in an [external repository](/topics/repository). However, during development and troubleshooting it is easiest to start from your local computer and run the transform using [infrahubctl generator](/infrahubctl/infrahubctl-generator). +Within Infrahub a generator is defined in an [external repository](../topics/repository). However, during development and troubleshooting it is easiest to start from your local computer and run the transform using [infrahubctl generator](../infrahubctl/infrahubctl-generator). The goal of this guide is to develop a Generator and add it to Infrahub, we will achieve this by following these steps. -1. Identify the relevant data you want to extract from the database using a [GraphQL query](/topics/graphql), that can take an input parameter to filter the data +1. Identify the relevant data you want to extract from the database using a [GraphQL query](../topics/graphql), that can take an input parameter to filter the data 2. Write a Python script that uses the GraphQL query to read information from the system and generates new data based on the response 3. Create an entry for the generator within an .infrahub.yml file. 4. Create a Git repository @@ -24,7 +24,7 @@ What your generator will look like will depend on what your schema looks like an As the default Infrahub schema doesn't have a lot of object types to use as a test, we will illustrate how this could work by adding two nodes to the schema. -Load the following schema using the [infrahubctl schema](/infrahubctl/infrahubctl-schema) command. +Load the following schema using the [infrahubctl schema](../infrahubctl/infrahubctl-schema) command. ```yaml # yaml-language-server: $schema=https://schema.infrahub.app/infrahub/schema/latest.json @@ -122,7 +122,7 @@ Store this class within a new file called widget_generator.py. ## 3. Create an .infrahub.yml file -The [.infrahub.yml](/topics/infrahub-yml) file allows you to tie the different [components of a generator](/topics/generator) together into a working unit. +The [.infrahub.yml](../topics/infrahub-yml) file allows you to tie the different [components of a generator](../topics/generator) together into a working unit. ```yaml # yaml-language-server: $schema=https://schema.infrahub.app/python-sdk/repository-config/latest.json @@ -156,7 +156,7 @@ queries: -See [this topic](/topics/infrahub-yml) for a full explanation of everything that can be defined in the `.infrahub.yml` file. +See [this topic](../topics/infrahub-yml) for a full explanation of everything that can be defined in the `.infrahub.yml` file. ## 4. Create a Git repository @@ -185,7 +185,7 @@ widget_generator (widget_generator.py::Generator) Target: widgets :::note -When running a generator with `infrahubctl` the [SDK tracking](/python-sdk/topics/tracking) feature isn't used. The reason for this is that internally Infrahub uses the ID of the generator_definition to control the tracking, this isn't available from the outside. For this reason it is recommended to create test branches when developing generators and validating the results. +When running a generator with `infrahubctl` the [SDK tracking](../python-sdk/topics/tracking) feature isn't used. The reason for this is that internally Infrahub uses the ID of the generator_definition to control the tracking, this isn't available from the outside. For this reason it is recommended to create test branches when developing generators and validating the results. ::: @@ -202,4 +202,4 @@ infrahubctl generator widget_generator --branch=test-branch1 name=widget2 Now you should see the tree TestResource objects within `test-branch1` one for the first widget and two for the second one. -With this step completed you can [add your repository to Infrahub](/guides/repository) and then the generators will be executed as part of the proposed change pipeline. +With this step completed you can [add your repository to Infrahub](../guides/repository) and then the generators will be executed as part of the proposed change pipeline. diff --git a/docs/docs-infrahub/guides/groups.mdx b/docs/docs-infrahub/guides/groups.mdx index 93420e3..ee5e3f1 100644 --- a/docs/docs-infrahub/guides/groups.mdx +++ b/docs/docs-infrahub/guides/groups.mdx @@ -5,7 +5,7 @@ title: Creating a Group # Creating a Group in Infrahub -Within Infrahub a [Group](/topics/groups) can be created in multiple ways: in the UI, GraphQL, SDK and allow you to create and manage collections of objects. +Within Infrahub a [Group](../topics/groups) can be created in multiple ways: in the UI, GraphQL, SDK and allow you to create and manage collections of objects. As the first step we need to create a group. We will be adding the `red` and `blue` tag to the `TagConfigGroup` group that we created in the previous step. diff --git a/docs/docs-infrahub/guides/import-schema.mdx b/docs/docs-infrahub/guides/import-schema.mdx index c9e5cad..a2b157c 100644 --- a/docs/docs-infrahub/guides/import-schema.mdx +++ b/docs/docs-infrahub/guides/import-schema.mdx @@ -31,7 +31,7 @@ extensions: :::note -To help with the development process of a schema definition file, you can leverage [schema validation](/reference/schema-validation) within your editor. +To help with the development process of a schema definition file, you can leverage [schema validation](../reference/schema-validation) within your editor. ::: @@ -50,7 +50,7 @@ infrahubctl schema load + ### GitHub Codespaces The Infrahub GitHub repository is designed to launch an instance via [GitHub Codespaces](https://docs.github.com/en/codespaces/overview). We have two devcontainer configurations: -* **infrahub:** a deployment running without any [Schema](/tutorials/getting-started/schema) or data pre-installed -* **infrahub-demo:** a deployment running the [demo environment](/topics/local-demo-environment) +* **infrahub:** a deployment running without any [Schema](../tutorials/getting-started/schema) or data pre-installed +* **infrahub-demo:** a deployment running the [demo environment](../topics/local-demo-environment) | No Data | Demo Data | |---|---| diff --git a/docs/docs-infrahub/guides/jinja2-transform.mdx b/docs/docs-infrahub/guides/jinja2-transform.mdx index 3d38a09..672a978 100644 --- a/docs/docs-infrahub/guides/jinja2-transform.mdx +++ b/docs/docs-infrahub/guides/jinja2-transform.mdx @@ -4,11 +4,11 @@ title: Creating a Jinja transform # Creating a Jinja rendered file (transform) -Within Infrahub a [Transform](/topics/transformation) is defined in an [external repository](/topics/repository). However, during development and troubleshooting it is easiest to start from your local computer and run the render using [infrahubctl render](/infrahubctl/infrahubctl-render). +Within Infrahub a [Transform](../topics/transformation) is defined in an [external repository](../topics/repository). However, during development and troubleshooting it is easiest to start from your local computer and run the render using [infrahubctl render](../infrahubctl/infrahubctl-render). The goal of this guide is to develop a Jinja Transform and add it to Infrahub, we will achieve this by following these steps. -1. Identify the relevant data you want to extract from the database using a [GraphQL query](/topics/graphql), that can take an input parameter to filter the data +1. Identify the relevant data you want to extract from the database using a [GraphQL query](../topics/graphql), that can take an input parameter to filter the data 2. Write a Jinja2 file that use the GraphQL query to read information from the system and render the data into a new format 3. Create an entry for the Jinja2 Transform within an .infrahub.yml file. 4. Create a Git repository @@ -226,7 +226,7 @@ If `--branch` is not provided it will automatically use the name of the local br ## 6. Adding the repository to Infrahub -In order to avoid having the same instructions over and over please refer to the guide [adding a repository to Infrahub](/guides/repository) in order to sync the repository you created and make it available within Infrahub. +In order to avoid having the same instructions over and over please refer to the guide [adding a repository to Infrahub](../guides/repository) in order to sync the repository you created and make it available within Infrahub. ## 7. Accessing the Transform from the API diff --git a/docs/docs-infrahub/guides/menu.mdx b/docs/docs-infrahub/guides/menu.mdx index 1d9b6bc..358ddfc 100644 --- a/docs/docs-infrahub/guides/menu.mdx +++ b/docs/docs-infrahub/guides/menu.mdx @@ -173,5 +173,5 @@ Load the menu into Infrahub using the following command infrahubctl menu load /path/to/menu.yml ``` -More information on `infrahubctl` command line utility can be found [here](/infrahubctl). -More information on the `menu` subcommand can be found [here](/infrahubctl/infrahubctl-menu). +More information on `infrahubctl` command line utility can be found [here](../infrahubctl). +More information on the `menu` subcommand can be found [here](../infrahubctl/infrahubctl-menu). diff --git a/docs/docs-infrahub/guides/object-storage.mdx b/docs/docs-infrahub/guides/object-storage.mdx index 9bd0a49..76ffe47 100644 --- a/docs/docs-infrahub/guides/object-storage.mdx +++ b/docs/docs-infrahub/guides/object-storage.mdx @@ -3,7 +3,7 @@ title: Using the object-storage --- In this guide we will be showing you how you can store and retrieve objects or files in Infrahub's object-storage. -For more information on the object-storage please see the [object-storage topic](/topics/object-storage). +For more information on the object-storage please see the [object-storage topic](../topics/object-storage). ## Uploading a file to the object-storage diff --git a/docs/docs-infrahub/guides/python-transform.mdx b/docs/docs-infrahub/guides/python-transform.mdx index a28be49..8c5ddc7 100644 --- a/docs/docs-infrahub/guides/python-transform.mdx +++ b/docs/docs-infrahub/guides/python-transform.mdx @@ -6,11 +6,11 @@ import TabItem from '@theme/TabItem'; # Creating a Python transform -Within Infrahub a [Transform](/topics/transformation) is defined in an [external repository](/topics/repository). However, during development and troubleshooting it is easiest to start from your local computer and run the transform using [infrahubctl transform](/infrahubctl/infrahubctl-transform). +Within Infrahub a [Transform](../topics/transformation) is defined in an [external repository](../topics/repository). However, during development and troubleshooting it is easiest to start from your local computer and run the transform using [infrahubctl transform](../infrahubctl/infrahubctl-transform). The goal of this guide is to develop a Python Transform and add it to Infrahub, we will achieve this by following these steps. -1. Identify the relevant data you want to extract from the database using a [GraphQL query](/topics/graphql), that can take an input parameter to filter the data +1. Identify the relevant data you want to extract from the database using a [GraphQL query](../topics/graphql), that can take an input parameter to filter the data 2. Write a Python script that use the GraphQL query to read information from the system and transforms the data into a new format 3. Create an entry for the transform within an .infrahub.yml file. 4. Create a Git repository @@ -138,7 +138,7 @@ Here the query will require an input parameter called `$name` what will refer to ## 2. Create the Python transform file -The next step is to create the actual Python transform. The transform is a Python class that inherits from InfrahubTransform from the [Python SDK](/python-sdk). Create a file called `tags_transform.py`: +The next step is to create the actual Python transform. The transform is a Python class that inherits from InfrahubTransform from the [Python SDK](../python-sdk). Create a file called `tags_transform.py`: ```python from infrahub_sdk.transforms import InfrahubTransform @@ -244,7 +244,7 @@ queries: -See [this topic](/topics/infrahub-yml) for a full explanation of everything that can be defined in the `.infrahub.yml` file. +See [this topic](../topics/infrahub-yml) for a full explanation of everything that can be defined in the `.infrahub.yml` file. ## 4. Create a Git repository @@ -298,7 +298,7 @@ We have now successfully created a transform. Most of the transforms you will cr ## 6. Adding the repository to Infrahub -In order to avoid having the same instructions over and over please refer to the guide [adding a repository to Infrahub](/guides/repository) in order to sync the repository you created and make it available within Infrahub. +In order to avoid having the same instructions over and over please refer to the guide [adding a repository to Infrahub](../guides/repository) in order to sync the repository you created and make it available within Infrahub. ## 7. Accessing the transform from the API diff --git a/docs/docs-infrahub/guides/repository.mdx b/docs/docs-infrahub/guides/repository.mdx index b77a5a2..1fcbea2 100644 --- a/docs/docs-infrahub/guides/repository.mdx +++ b/docs/docs-infrahub/guides/repository.mdx @@ -8,8 +8,8 @@ import TabItem from '@theme/TabItem'; Infrahub supports two different types of connections to external Git repositories: -- [**Repository**](/topics/repository#repository) fully integrates with Git version control, including branch tracking and two-way branch synchronization. -- [**Read-only Repository**](/topics/repository#read-only-repository) links a particular branch in Infrahub to a particular ref in the Git repository. It will only read from the Git repository. It will never make any changes to the external repository. +- [**Repository**](../topics/repository#repository) fully integrates with Git version control, including branch tracking and two-way branch synchronization. +- [**Read-only Repository**](../topics/repository#read-only-repository) links a particular branch in Infrahub to a particular ref in the Git repository. It will only read from the Git repository. It will never make any changes to the external repository. ## Recommendations @@ -72,7 +72,7 @@ In the UI, you should see your new repository. If the repository you added has ` ### Via the GraphQL interface -Using the GraphQL Interface, it is possible to add a `Repository` or `Read-only Repository` via a [Mutation](/topics/graphql). +Using the GraphQL Interface, it is possible to add a `Repository` or `Read-only Repository` via a [Mutation](../topics/graphql). {/*TODO: Detail usage if using external GraphQL browser i.e. insomnia*/} 1. Open the [GraphQL Interface](http://localhost:8000/graphql). @@ -155,7 +155,7 @@ The repository should be visible under [Unified Storage / Repository](http://loc ### Via the Infrahub SDK -1. Install and setup the [Infrahub SDK](/python-sdk) +1. Install and setup the [Infrahub SDK](../python-sdk) 2. If needed, i.e., your repository is private, create a Credential object to hold your username / password. We highly recommend to provide credentials for Repository to allow branch creation from Infrahub. ```python @@ -215,7 +215,7 @@ The repository should be visible under [Unified Storage / Repository](http://loc ## Pulling changes for read-only repository -`Read-only Repository` and `Repository` work in different ways when it comes to tracking changes on the remote repository. Please refer to the [Repository Topic](/topics/repository#read-only-vs-core) for further details. +`Read-only Repository` and `Repository` work in different ways when it comes to tracking changes on the remote repository. Please refer to the [Repository Topic](../topics/repository#read-only-vs-core) for further details. :::warning @@ -261,7 +261,7 @@ Unlike `Repository`, Infrahub does not automatically update `Read-only Repositor ## Troubleshooting repository -Various issues could affect repositories. The [Repository Status](/topics/repository#repository-statuses) gives you further details about the root cause. +Various issues could affect repositories. The [Repository Status](../topics/repository#repository-statuses) gives you further details about the root cause. Also, directly from the UI you can access the output of low level repository operations: @@ -329,7 +329,7 @@ services: image: custom/infrahub:0.16.0 ``` -A development environment can then be spun up with `invoke demo.start` command as, explained in the [Installing Infrahub guide](/guides/installation). +A development environment can then be spun up with `invoke demo.start` command as, explained in the [Installing Infrahub guide](../guides/installation). ## Disable certificate verification @@ -373,7 +373,7 @@ services: image: custom/infrahub:0.16.0 ``` -A development environment can then be spun up with `invoke demo.start` command as, explained in the [Installing Infrahub guide](/guides/installation). +A development environment can then be spun up with `invoke demo.start` command as, explained in the [Installing Infrahub guide](../guides/installation). ## Using a proxy server @@ -417,4 +417,4 @@ services: image: custom/infrahub:0.16.0 ``` -A development environment can then be spun up with `invoke demo.start` command as, explained in the [Installing Infrahub guide](/guides/installation). +A development environment can then be spun up with `invoke demo.start` command as, explained in the [Installing Infrahub guide](../guides/installation). diff --git a/docs/docs-infrahub/guides/resource-manager.mdx b/docs/docs-infrahub/guides/resource-manager.mdx index cb75dbe..36ced88 100644 --- a/docs/docs-infrahub/guides/resource-manager.mdx +++ b/docs/docs-infrahub/guides/resource-manager.mdx @@ -174,7 +174,7 @@ We can use the resource manager to allocate resources out of a pool in 2 differe 1. Directly allocate a resource out of a pool. This is typically used when you need to allocate a resource that has no relation to other nodes. For example, allocating an IP address out of a pool that will be assigned to something that is not stored in Infrahub. 2. Allocate a resource out of a pool to a relationship of a node. For example, create a device and allocate an IP address out of a pool and assign it to the device -Please refer to the [Resource Manager Topic](/topics/resource-manager) for further details. +Please refer to the [Resource Manager Topic](../topics/resource-manager) for further details. #### Direct allocation of an IP address @@ -204,7 +204,7 @@ In the mutation we passed additional data to the allocated resource, in this cas #### Idempotent allocation of an IP address -You can allocate resources in an idempotent way by specifying an identifier in the GraphQL mutation. This identifier links the resource pool with the allocated resource allowing us to create idempotent allocation behavior. This is crucial when you want to allocate resources in an idempotent way using [generators](/topics/generator). +You can allocate resources in an idempotent way by specifying an identifier in the GraphQL mutation. This identifier links the resource pool with the allocated resource allowing us to create idempotent allocation behavior. This is crucial when you want to allocate resources in an idempotent way using [generators](../topics/generator). Execute this mutation twice, note the identifier. The resulting IP address should be the same, as well as the id. Replace the id with the id of the `CoreIPAddressPool` we created previously. @@ -332,7 +332,7 @@ We can use the resource manager to allocate resources out of a pool in 2 differe 1. Directly allocate a resource out of a pool. This is typically used when you need to allocate a resource that has no relation to other nodes. For example, allocating an IP address out of a pool that will be assigned to something that is not stored in Infrahub. 2. Allocate a resource out of a pool to a relationship of a node. For example, create a device and allocate an IP address out of a pool and assign it to the device -Please refer to the [Resource Manager Topic](/topics/resource-manager) for further details. +Please refer to the [Resource Manager Topic](../topics/resource-manager) for further details. #### Direct allocation of an IP prefix @@ -394,7 +394,7 @@ When you use the `from_pool` resolver, the resource allocation happens in an ide #### Idempotent allocation of an IP prefix -You can allocate resources in an idempotent way by specifying an identifier in the GraphQL mutation. This identifier links the resource pool with the allocated resource allowing us to create idempotent allocation behavior. This is crucial when you want to allocate resources in an idempotent way using [generators](/topics/generator). +You can allocate resources in an idempotent way by specifying an identifier in the GraphQL mutation. This identifier links the resource pool with the allocated resource allowing us to create idempotent allocation behavior. This is crucial when you want to allocate resources in an idempotent way using [generators](../topics/generator). Execute this mutation twice, note the identifier. The resulting IP prefix should be the same, as well as the id. Replace the id with the id of the `CoreIPPrefixPool` we created previously. diff --git a/docs/docs-infrahub/infrahubctl.mdx b/docs/docs-infrahub/infrahubctl.mdx index fd1d219..4bebcb1 100644 --- a/docs/docs-infrahub/infrahubctl.mdx +++ b/docs/docs-infrahub/infrahubctl.mdx @@ -18,7 +18,7 @@ It's meant to run on any laptop or server and it communicates with a remote Infr ## Installation -The `infrahubctl` command line utility is installed as a part of the [Infrahub SDK for Python](/python-sdk/guides/installation#ctl). +The `infrahubctl` command line utility is installed as a part of the [Infrahub SDK for Python](./python-sdk/guides/installation#ctl). ## Configuration diff --git a/docs/docs-infrahub/python-sdk/guides/client.mdx b/docs/docs-infrahub/python-sdk/guides/client.mdx index 9830e71..dccfe39 100644 --- a/docs/docs-infrahub/python-sdk/guides/client.mdx +++ b/docs/docs-infrahub/python-sdk/guides/client.mdx @@ -107,7 +107,7 @@ The client object can be configured by providing a `Config` object. Here we will -More details on the available configuration options can be found [SDK configuration reference](/python-sdk/reference/config). +More details on the available configuration options can be found [SDK configuration reference](../../python-sdk/reference/config). ## Setting the default branch diff --git a/docs/docs-infrahub/python-sdk/guides/object-storage.mdx b/docs/docs-infrahub/python-sdk/guides/object-storage.mdx index 4e35228..a272446 100644 --- a/docs/docs-infrahub/python-sdk/guides/object-storage.mdx +++ b/docs/docs-infrahub/python-sdk/guides/object-storage.mdx @@ -2,7 +2,7 @@ title: Using the object-storage --- -The Python SDK can be used to interface with Infrahub's [object-storage](/topics/object-storage). +The Python SDK can be used to interface with Infrahub's [object-storage](../../topics/object-storage). ## Storing string objects to the object-storage diff --git a/docs/docs-infrahub/python-sdk/guides/query_data.mdx b/docs/docs-infrahub/python-sdk/guides/query_data.mdx index 7085550..9085510 100644 --- a/docs/docs-infrahub/python-sdk/guides/query_data.mdx +++ b/docs/docs-infrahub/python-sdk/guides/query_data.mdx @@ -498,7 +498,7 @@ The `fetch` method can also be used to `fetch` the related nodes of a relationsh ### Prefetch relationships Related nodes of a relationship can be retrieved, using the `prefetch_relationships` argument for the different `query` methods. But this requires the usage of the internal client store -. More information can be found in the [Using the client store](/python-sdk/guides/store) guide. +. More information can be found in the [Using the client store](../../python-sdk/guides/store) guide. ## Query a node(s) in the past diff --git a/docs/docs-infrahub/python-sdk/guides/resource-manager.mdx b/docs/docs-infrahub/python-sdk/guides/resource-manager.mdx index 26379b9..5ada777 100644 --- a/docs/docs-infrahub/python-sdk/guides/resource-manager.mdx +++ b/docs/docs-infrahub/python-sdk/guides/resource-manager.mdx @@ -180,7 +180,7 @@ We will use `allocate_next_ip_address` to allocated an IP address out of the `Co We provided a data argument to method. This data argument is used to pass attributes and relationships that we want to set on the allocated resource. In this case we are setting to the description of the allocated IP Address. -You can allocate resources in an idempotent way by passing an identifier argument to the allocation method. This identifier links the resource pool with the allocated resource allowing us to create idempotent allocation behavior. This is crucial when you want to allocate resources in an idempotent way using [generators](/topics/generator). +You can allocate resources in an idempotent way by passing an identifier argument to the allocation method. This identifier links the resource pool with the allocated resource allowing us to create idempotent allocation behavior. This is crucial when you want to allocate resources in an idempotent way using [generators](../../topics/generator). In this example we are executing the `allocate_next_ip_address` method 2 times, using the same identifier. diff --git a/docs/docs-infrahub/python-sdk/guides/tracking.mdx b/docs/docs-infrahub/python-sdk/guides/tracking.mdx index b059ac9..293bd65 100644 --- a/docs/docs-infrahub/python-sdk/guides/tracking.mdx +++ b/docs/docs-infrahub/python-sdk/guides/tracking.mdx @@ -13,7 +13,7 @@ The Python SDK provides a feature known as *Tracking Mode*. This mode allows for Tracking mode is designed for scenarios where multiple operations or mutations are performed in sequence, and you want to consolidate or track these operations for efficiency or auditing purposes. It is ideal for scenarios requiring precise control and repeatability, such as idempotent scripting. Under the hood, tracking mode leverages a `CoreStandardGroup` object to aggregate and track these operations. -For a detailed exploration of tracking mode applications and how to use it for idempotent scripting, visit the [tracking topic](/python-sdk/topics/tracking). +For a detailed exploration of tracking mode applications and how to use it for idempotent scripting, visit the [tracking topic](../../python-sdk/topics/tracking). ## Automatic tracking diff --git a/docs/docs-infrahub/python-sdk/readme.mdx b/docs/docs-infrahub/python-sdk/readme.mdx index 80dd468..d4c4807 100644 --- a/docs/docs-infrahub/python-sdk/readme.mdx +++ b/docs/docs-infrahub/python-sdk/readme.mdx @@ -10,18 +10,18 @@ The Infrahub Python SDK greatly simplifies how you can interact with Infrahub pr ## Guides -- [Installing infrahub-sdk](/python-sdk/guides/installation) -- [Creating a client](/python-sdk/guides/client) -- [Querying data in Infrahub](/python-sdk/guides/query_data) -- [Managing nodes](/python-sdk/guides/create_update_delete) -- [Managing branches](/python-sdk/guides/branches) -- [Using the client store](/python-sdk/guides/store) -- [Using the client tracking mode](/python-sdk/guides/tracking) +- [Installing infrahub-sdk](../python-sdk/guides/installation) +- [Creating a client](../python-sdk/guides/client) +- [Querying data in Infrahub](../python-sdk/guides/query_data) +- [Managing nodes](../python-sdk/guides/create_update_delete) +- [Managing branches](../python-sdk/guides/branches) +- [Using the client store](../python-sdk/guides/store) +- [Using the client tracking mode](../python-sdk/guides/tracking) ## Topics -- [Understanding tracking in the Python SDK](/python-sdk/topics/tracking) +- [Understanding tracking in the Python SDK](../python-sdk/topics/tracking) ## Reference -- [Client configuration](/python-sdk/reference/config) +- [Client configuration](../python-sdk/reference/config) diff --git a/docs/docs-infrahub/python-sdk/topics/tracking.mdx b/docs/docs-infrahub/python-sdk/topics/tracking.mdx index 59ebdd4..85f62c3 100644 --- a/docs/docs-infrahub/python-sdk/topics/tracking.mdx +++ b/docs/docs-infrahub/python-sdk/topics/tracking.mdx @@ -57,4 +57,4 @@ An idempotent script using the Python SDK might involve the following steps: 3. **End the Session:** Conclude the tracking session, optionally updating the group context to reflect the changes made. 4. **Handle Errors:** In case of errors, use the tracking information to rollback or correct the state. -For more detailed guidance on implementing tracking in your scripts, refer to the [tracking guide](/python-sdk/guides/tracking). +For more detailed guidance on implementing tracking in your scripts, refer to the [tracking guide](../../python-sdk/guides/tracking). diff --git a/docs/docs-infrahub/reference/dotinfrahub.mdx b/docs/docs-infrahub/reference/dotinfrahub.mdx index 773e116..1d97039 100644 --- a/docs/docs-infrahub/reference/dotinfrahub.mdx +++ b/docs/docs-infrahub/reference/dotinfrahub.mdx @@ -6,17 +6,17 @@ title: Repository configuration file The repository configuration file allows you to define multiple resources that need to be imported into Infrahub. -The file should be formatted as a Yaml file, have the filename `.infrahub.yml` and should be stored at the root of the [repository](/topics/repository). +The file should be formatted as a Yaml file, have the filename `.infrahub.yml` and should be stored at the root of the [repository](../topics/repository). :::info -See [this topic](/topics/infrahub-yml) for more details on the available repository configuration options +See [this topic](../topics/infrahub-yml) for more details on the available repository configuration options ::: :::note -To help with the development process of a repository configuration file, you can leverage the schemas we publish for validation within your [editor](/development/editor) +To help with the development process of a repository configuration file, you can leverage the schemas we publish for validation within your [editor](../development/editor) ::: diff --git a/docs/docs-infrahub/reference/infrahub-tests.mdx b/docs/docs-infrahub/reference/infrahub-tests.mdx index 81b47d7..7ff5cd5 100644 --- a/docs/docs-infrahub/reference/infrahub-tests.mdx +++ b/docs/docs-infrahub/reference/infrahub-tests.mdx @@ -6,11 +6,11 @@ title: Tests configuration file The tests configuration file allows you to define multiple tests for Infrahub resources such as Jinja2 transforms, Python transforms, checks and GraphQL queries. -The file should be formatted as a YAML file, have a filename prefixed with `test_` like `test_all.yml` and should be stored somewhere in the [repository](/topics/repository). +The file should be formatted as a YAML file, have a filename prefixed with `test_` like `test_all.yml` and should be stored somewhere in the [repository](../topics/repository). :::info -See [this topic](/topics/resources-testing-framework) for more details on the available repository configuration options +See [this topic](../topics/resources-testing-framework) for more details on the available repository configuration options ::: diff --git a/docs/docs-infrahub/reference/menu.mdx b/docs/docs-infrahub/reference/menu.mdx index c3523e6..9fd2c3f 100644 --- a/docs/docs-infrahub/reference/menu.mdx +++ b/docs/docs-infrahub/reference/menu.mdx @@ -4,7 +4,7 @@ title: Menu definition file # Menu definition file -A menu definition file allows you to control the layout and structure of the menu on the left side of the Infrahub web interface. More information can be found in the [Controlling the menu guide](/guides/menu). +A menu definition file allows you to control the layout and structure of the menu on the left side of the Infrahub web interface. More information can be found in the [Controlling the menu guide](../guides/menu). The menu definition file is a YAML file that follows a particular structure or schema. diff --git a/docs/docs-infrahub/reference/message-bus-events.mdx b/docs/docs-infrahub/reference/message-bus-events.mdx index 41cf8bd..c250d0d 100644 --- a/docs/docs-infrahub/reference/message-bus-events.mdx +++ b/docs/docs-infrahub/reference/message-bus-events.mdx @@ -8,7 +8,7 @@ This document provides detailed documentation for all events used in the Infrahu :::info -For more detailed explanations on how to use these events within Infrahub, see the [event handling](/topics/event-handling) topic. +For more detailed explanations on how to use these events within Infrahub, see the [event handling](../topics/event-handling) topic. ::: diff --git a/docs/docs-infrahub/reference/permissions.mdx b/docs/docs-infrahub/reference/permissions.mdx index ccae2fe..8bf8c0d 100644 --- a/docs/docs-infrahub/reference/permissions.mdx +++ b/docs/docs-infrahub/reference/permissions.mdx @@ -8,7 +8,7 @@ This page provides detailed documentation for all available global and object pe :::info -For more detailed explanations on how to use these permissions within Infrahub, see the [roles and permissions](/topics/permissions-roles) topic. +For more detailed explanations on how to use these permissions within Infrahub, see the [roles and permissions](../topics/permissions-roles) topic. ::: diff --git a/docs/docs-infrahub/reference/schema-validation.mdx b/docs/docs-infrahub/reference/schema-validation.mdx index 5d76198..5dc696b 100644 --- a/docs/docs-infrahub/reference/schema-validation.mdx +++ b/docs/docs-infrahub/reference/schema-validation.mdx @@ -2,7 +2,7 @@ title: Schema validation --- -Infrahub requires the user to define multiple YAML files. One or more files defining the [schema in Infrahub](/topics/schema) and the [external repository configuration file](/topics/repository). +Infrahub requires the user to define multiple YAML files. One or more files defining the [schema in Infrahub](../topics/schema) and the [external repository configuration file](../topics/repository). To help with the process of creating and maintaining these files, we publish JSON schemas that allow you to validate the schema of these files. diff --git a/docs/docs-infrahub/release-notes/infrahub/release-0_13.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_13.mdx index f2fa54d..7f42667 100644 --- a/docs/docs-infrahub/release-notes/infrahub/release-0_13.mdx +++ b/docs/docs-infrahub/release-notes/infrahub/release-0_13.mdx @@ -42,7 +42,7 @@ The following `Generic` models are provided by default and can be extended as ne - `BuiltinIPPrefix`: used to model a network, sometimes referred as supernet/subnet - `BuiltinIPAddress`: used to model a single IP address -More information about IPAM is available in the [Documentation](/topics/ipam). +More information about IPAM is available in the [Documentation](../../topics/ipam). ![prefix View](../../media/release_notes/infrahub_0_13_0/ipam_01.png) @@ -55,7 +55,7 @@ A profile in Infrahub allow you to define a common set of attributes that should A node that has a profile assigned, will get the values of its attributes inherited from the assigned profile, if no value is defined for the attribute at the node, or if the default value is used. The attribute values of a node that were inherited from a profile can be overridden, by defining them at the node. -More information about Profiles is available in the [Documentation](/topics/profiles). +More information about Profiles is available in the [Documentation](../../topics/profiles). #### Leverage database indexes to improve performance @@ -95,7 +95,7 @@ Similar to the Transforms & Artifacts, Generator will be automatically executed The Generator itself is a Python class that is based on the `InfrahubGenerator` class from the SDK. Just like transforms and checks, the Generators are user defined. -More information about Generators is available in the [Documentation](/topics/generator). +More information about Generators is available in the [Documentation](../../topics/generator). #### Redesigned proposed change creation form @@ -136,7 +136,7 @@ The link will be displayed in the help popup in the frontend. The attribute `on_delete` is now available on all relationships. See section above. -More information about the schema is available in the [Documentation](/reference/schema). +More information about the schema is available in the [Documentation](../../reference/schema). ### API / GraphQL diff --git a/docs/docs-infrahub/release-notes/infrahub/release-0_16_0.mdx b/docs/docs-infrahub/release-notes/infrahub/release-0_16_0.mdx index bf28b63..4635726 100644 --- a/docs/docs-infrahub/release-notes/infrahub/release-0_16_0.mdx +++ b/docs/docs-infrahub/release-notes/infrahub/release-0_16_0.mdx @@ -51,7 +51,7 @@ Adding a Number Pool: See the Resource Manager documentation for more information on managing and utilizing Resource Pools: -- [Tutorials - Resource Manager](/tutorials/getting-started/resource-manager) +- [Tutorials - Resource Manager](../../tutorials/getting-started/resource-manager) ### Unified storage @@ -70,8 +70,8 @@ Added/changed features include: See the documentation for more information on using Git repositories with Infrahub: -- [Guides - Adding/updating external repositories](/guides/repository) -- [Topics - Repository](/topics/repository) +- [Guides - Adding/updating external repositories](../../guides/repository) +- [Topics - Repository](../../topics/repository) ### Schema diff --git a/docs/docs-infrahub/topics/auth.mdx b/docs/docs-infrahub/topics/auth.mdx index 63cbda2..d3cd717 100644 --- a/docs/docs-infrahub/topics/auth.mdx +++ b/docs/docs-infrahub/topics/auth.mdx @@ -21,7 +21,7 @@ Infrahub supports two authentication methods: | infrahubctl | Yes | Yes | | GraphQL Playground | No | Yes | -More information on managing API tokens can be found in the [Managing API Tokens Guide](/guides/managing-api-tokens). +More information on managing API tokens can be found in the [Managing API Tokens Guide](../guides/managing-api-tokens). :::info @@ -40,7 +40,7 @@ Users are allocated permissions through groups and roles. - **Groups** are related with **Roles**. - **Roles** are allocated **Permissions** (global or object-specific). -Using roles and groups to manage permissions, **Infrahub offers a scalable way** to control access for numerous users simultaneously. For more detailed information, visit the [role and permissions page](/topics/permissions-roles). +Using roles and groups to manage permissions, **Infrahub offers a scalable way** to control access for numerous users simultaneously. For more detailed information, visit the [role and permissions page](../topics/permissions-roles). ## Default setup @@ -110,4 +110,4 @@ Multiple identity providers can be enabled simultaneously, for example to suppor A user that was authenticated using SSO will be created in the local user store of Infrahub and optionally automatically added to groups, which can have roles assigned to them. -For more information on setting up single sign-on can be found in the [configuring single sign-on guide](/guides/sso). +For more information on setting up single sign-on can be found in the [configuring single sign-on guide](../guides/sso). diff --git a/docs/docs-infrahub/topics/check.mdx b/docs/docs-infrahub/topics/check.mdx index 2394ed9..021b4db 100644 --- a/docs/docs-infrahub/topics/check.mdx +++ b/docs/docs-infrahub/topics/check.mdx @@ -2,7 +2,7 @@ title: Check --- -Checks are user defined logic, stored in an [external repository linked to Infrahub](/topics/repository), that are run as part of a [proposed change](/topics/proposed-change). It allows a user to perform any kind of data validation logic during a proposed change. If a check does not complete successfully, then the proposed change cannot be merged. +Checks are user defined logic, stored in an [external repository linked to Infrahub](../topics/repository), that are run as part of a [proposed change](../topics/proposed-change). It allows a user to perform any kind of data validation logic during a proposed change. If a check does not complete successfully, then the proposed change cannot be merged. Some examples: diff --git a/docs/docs-infrahub/topics/database-backup.mdx b/docs/docs-infrahub/topics/database-backup.mdx index be99fa6..6379be6 100644 --- a/docs/docs-infrahub/topics/database-backup.mdx +++ b/docs/docs-infrahub/topics/database-backup.mdx @@ -6,7 +6,7 @@ title: Database backup and restore Infrahub provides a command-line interface tool to help backup and restore a full neo4j database. It is designed to be run from almost any host machine and has a much smaller set of requirements than running the full Infrahub application. We use docker containers to run commands against the Neo4j database to make this tool easier to install. -Please see [this guide](/guides/database-backup) for concrete examples of running backup and restore commands. +Please see [this guide](../guides/database-backup) for concrete examples of running backup and restore commands. ## Requirements {#backup-requirements} diff --git a/docs/docs-infrahub/topics/generator.mdx b/docs/docs-infrahub/topics/generator.mdx index 2463df1..95bb569 100644 --- a/docs/docs-infrahub/topics/generator.mdx +++ b/docs/docs-infrahub/topics/generator.mdx @@ -22,7 +22,7 @@ Generators are defined as a **generator definition** within an [.infrahub.yml](i ![](../media/topics/generator/generator_overview.excalidraw.svg) -Running an artifact definition will create new nodes as defined by the generator, or remove old ones that are no longer required. The removal of obsolete objects is handled using the [SDK tracking feature](/python-sdk/topics/tracking) +Running an artifact definition will create new nodes as defined by the generator, or remove old ones that are no longer required. The removal of obsolete objects is handled using the [SDK tracking feature](../python-sdk/topics/tracking) The targets point to a group that will consist of objects that are impacted by the generator. The members of this group can be any type of object within your schema, service objects, devices, contracts or anything you want the generator to act upon. diff --git a/docs/docs-infrahub/topics/groups.mdx b/docs/docs-infrahub/topics/groups.mdx index 5e3aea8..644d591 100644 --- a/docs/docs-infrahub/topics/groups.mdx +++ b/docs/docs-infrahub/topics/groups.mdx @@ -15,7 +15,7 @@ Groups in Infrahub allow you to create and manage collections of objects, enabli The **CoreGroup** is the generic model for all group types in Infrahub. It defines the essential attributes and relationships that can be extended by specialized group types to cater to specific requirements. -For detailed information, see the [Groups Reference Guide](/reference/schema/groups). +For detailed information, see the [Groups Reference Guide](../reference/schema/groups). ## Group concepts diff --git a/docs/docs-infrahub/topics/hardware-requirements.mdx b/docs/docs-infrahub/topics/hardware-requirements.mdx index a488388..377a895 100644 --- a/docs/docs-infrahub/topics/hardware-requirements.mdx +++ b/docs/docs-infrahub/topics/hardware-requirements.mdx @@ -9,7 +9,7 @@ The system on which you want to run Infrahub, has to meet the following hardware | Minimum | 6 | 12GB | SSD and/or >= 5000 IOPS | | Recommended | 8 | 16GB | SSD and/or >= 5000 IOPS | -If you only want to give Infrahub a try, or follow the [getting started tutorial](/tutorials/getting-started/), then you can use [GitHub Codespaces](/guides/installation#github-codespaces) as an alternative. +If you only want to give Infrahub a try, or follow the [getting started tutorial](../tutorials/getting-started), then you can use [GitHub Codespaces](../guides/installation#github-codespaces) as an alternative. ## Machine types for cloud providers diff --git a/docs/docs-infrahub/topics/infrahub-yml.mdx b/docs/docs-infrahub/topics/infrahub-yml.mdx index bb9f813..d3b09de 100644 --- a/docs/docs-infrahub/topics/infrahub-yml.mdx +++ b/docs/docs-infrahub/topics/infrahub-yml.mdx @@ -4,28 +4,28 @@ title: .infrahub.yml file format # `.infrahub.yml` file {#infrahub-yaml} -To make full use of a [remote repository](/topics/repository) within Infrahub, the remote repository must have a `.infrahub.yml` file defined at the root of the repository. This file enables Infrahub to identify the required imports and tie together the various components. +To make full use of a [remote repository](../topics/repository) within Infrahub, the remote repository must have a `.infrahub.yml` file defined at the root of the repository. This file enables Infrahub to identify the required imports and tie together the various components. An external repository can be used to link the following Infrahub objects to an Infrahub instance: -- [GraphQL Query](/topics/graphql) -- [Schema](/topics/schema) -- [Jinja2 Transform](/topics/transformation#rendered-file-jinja2-plugin) -- [Python Transformation](/topics/transformation#transformpython-python-plugin) -- [Artifact Definition](/topics/artifact) -- [Generator Definition](/topics/generator) +- [GraphQL Query](../topics/graphql) +- [Schema](../topics/schema) +- [Jinja2 Transform](../topics/transformation#rendered-file-jinja2-plugin) +- [Python Transformation](../topics/transformation#transformpython-python-plugin) +- [Artifact Definition](../topics/artifact) +- [Generator Definition](../topics/generator) :::info -- See [this guide](/guides/repository) for how to add or update an external repository in Infrahub -- See [this topic](/topics/repository) for more information on remote repositories in Infrahub -- See [this reference](/reference/dotinfrahub) for more information on the `.infrahub.yml` file format +- See [this guide](../guides/repository) for how to add or update an external repository in Infrahub +- See [this topic](../topics/repository) for more information on remote repositories in Infrahub +- See [this reference](../reference/dotinfrahub) for more information on the `.infrahub.yml` file format ::: :::note -To help with the development process of a repository configuration file, you can leverage [schema validation](/reference/schema-validation) within your editor. +To help with the development process of a repository configuration file, you can leverage [schema validation](../reference/schema-validation) within your editor. ::: @@ -46,7 +46,7 @@ GraphQL queries could be defined in file(s) with a `.gql` extension. Then querie ## Schema {#schema} -Schemas to be loaded as part of an external repository can be defined in file(s) as described [here](/topics/schema). The schemas must also be explicitly identified in the `.infrahub.yml` file under `schemas`. +Schemas to be loaded as part of an external repository can be defined in file(s) as described [here](../topics/schema). The schemas must also be explicitly identified in the `.infrahub.yml` file under `schemas`.
Example @@ -62,7 +62,7 @@ Infrahub will attempt to import any schemas defined in `.infrahub.yml` when pull ## Jinja2 transformation {#transform-jinja-2} -Jinja2 Transformations can be defined as described [here](/topics/transformation#rendered-file-jinja2-plugin). To load Jinja2 Transformations into Infrahub from an external repository, you must explicitly define them in the `.infrahub.yml` file. Each Jinja2 Transformations in the `.infrahub.yml` configuration file is defined by the following +Jinja2 Transformations can be defined as described [here](../topics/transformation#rendered-file-jinja2-plugin). To load Jinja2 Transformations into Infrahub from an external repository, you must explicitly define them in the `.infrahub.yml` file. Each Jinja2 Transformations in the `.infrahub.yml` configuration file is defined by the following - `name`: name of the transform - `query`: the name of an Infrahub `GraphQL query` to use with the transform @@ -84,7 +84,7 @@ Jinja2 Transformations can be defined as described [here](/topics/transformation ## Python transformation {#transform-python} -Python Transformations can be defined as described [here](/topics/transformation#transformpython-python-plugin). To load Python Transformations from an external repository, you must explicitly define them in the `.infrahub.yml` configuration file. The definition in `.infrahub.yml` includes the following +Python Transformations can be defined as described [here](../topics/transformation#transformpython-python-plugin). To load Python Transformations from an external repository, you must explicitly define them in the `.infrahub.yml` configuration file. The definition in `.infrahub.yml` includes the following - `name`: name of the transformation - `file_path`: path to the Python transformation within this repository @@ -104,7 +104,7 @@ Python Transformations can be defined as described [here](/topics/transformation ## Artifact definition {#artifact-definition} -Artifact Definitions can be created as described [here](/topics/artifact). To load Artifact Definitions from an external repository, you must explicitly define them in the `.infrahub.yml` configuration file. Each Artifact Definition in `.infrahub.yml` must include the following: +Artifact Definitions can be created as described [here](../topics/artifact). To load Artifact Definitions from an external repository, you must explicitly define them in the `.infrahub.yml` configuration file. Each Artifact Definition in `.infrahub.yml` must include the following: - `name`: the name of the Artifact Definition - `artifact_name`: the name of the Artifact created by this Artifact Definition @@ -131,7 +131,7 @@ Artifact Definitions can be created as described [here](/topics/artifact). To lo ## Generator definition {#generator-definition} -Generator Definitions can be created as described [here](/topics/generator). To load Generator Definitions from an external repository, you must explicitly define them in the `.infrahub.yml` configuration file. Each Generator Definition in `.infrahub.yml` must include the following: +Generator Definitions can be created as described [here](../topics/generator). To load Generator Definitions from an external repository, you must explicitly define them in the `.infrahub.yml` configuration file. Each Generator Definition in `.infrahub.yml` must include the following: - `name`: the name of the Generator Definition - `file_path`: path to the Generator Python file within this repository diff --git a/docs/docs-infrahub/topics/local-demo-environment.mdx b/docs/docs-infrahub/topics/local-demo-environment.mdx index e58a386..c9e97e9 100644 --- a/docs/docs-infrahub/topics/local-demo-environment.mdx +++ b/docs/docs-infrahub/topics/local-demo-environment.mdx @@ -33,13 +33,13 @@ It's designed to be controlled by `invoke` using a list of predefined commands. | **infrahub-server** | Dockerfile | Instance of the API server, running GraphQL | | **infrahub-git** | Dockerfile | Instance of the Task worker, managing the Git Repository | - + ## Getting started ### Prerequisites -The system that you want to use to run the demo environment has to meet the [hardware requirements](/topics/hardware-requirements). Alternatively you can run Infrahub in [GitHub codespaces](/guides/installation#github-codespaces). +The system that you want to use to run the demo environment has to meet the [hardware requirements](./hardware-requirements). Alternatively you can run Infrahub in [GitHub codespaces](../guides/installation#github-codespaces). In order to run the demo environment, the following applications must be installed on the systems: diff --git a/docs/docs-infrahub/topics/object-storage.mdx b/docs/docs-infrahub/topics/object-storage.mdx index b39a322..998eb22 100644 --- a/docs/docs-infrahub/topics/object-storage.mdx +++ b/docs/docs-infrahub/topics/object-storage.mdx @@ -7,7 +7,7 @@ title: Object-storage Infrahub provides an interface to store and retrieve files or objects in an object-storage. The object-storage is used internally within Infrahub to store rendered artifacts, but it can be used to store any text based file or content. You can interface with the object-storage through the REST API and Python SDK. -See the [object-storage guide](/guides/object-storage) and [object-storage Python SDK](/python-sdk/guides/object-storage) guide for more information. +See the [object-storage guide](../guides/object-storage) and [object-storage Python SDK](../python-sdk/guides/object-storage) guide for more information. ## Supported backends @@ -27,7 +27,7 @@ driver = "local" path = "/opt/infrahub/storage/" ``` -More details can be found in the [configuration documentation](/reference/configuration). +More details can be found in the [configuration documentation](../reference/configuration). ### AWS S3 storage @@ -46,7 +46,7 @@ bucket_name = "my-infrahub-bucket" endpoint_url = "https://s3.eu-central-1.amazonaws.com" ``` -More details can be found in the [configuration documentation](/reference/configuration). +More details can be found in the [configuration documentation](../reference/configuration). ## Object model diff --git a/docs/docs-infrahub/topics/permissions-roles.mdx b/docs/docs-infrahub/topics/permissions-roles.mdx index 9ef256b..5135783 100644 --- a/docs/docs-infrahub/topics/permissions-roles.mdx +++ b/docs/docs-infrahub/topics/permissions-roles.mdx @@ -8,19 +8,19 @@ Roles and permissions are essential for controlling user access and behavior in The permissions system is split into two main types: **Global** and **Object-specific**. These permissions aid in defining what users are permitted to do on particular system objects or throughout the system. -More information on users authentication, can be found in the [User management and authentication Topic](/topics/auth). +More information on users authentication, can be found in the [User management and authentication Topic](../topics/auth). ## Overview Permissions fall into two categories: **Global** and **Object-specific**, while roles act as **convenient bundles** of permissions. To simplify things further, **Account Groups** let you manage permissions for multiple users at once. -- **GlobalPermissions** gives users system-wide rights to perform specific actions. **[See full list of available global permissions](/reference/permissions.mdx#global-permissions).** -- **ObjectPermissions** are tied to individual objects within Infrahub and control what actions users can take on those objects. **[See full list of available object permissions](/reference/permissions.mdx#object-permissions).** +- **GlobalPermissions** gives users system-wide rights to perform specific actions. **[See full list of available global permissions](../reference/permissions.mdx#global-permissions).** +- **ObjectPermissions** are tied to individual objects within Infrahub and control what actions users can take on those objects. **[See full list of available object permissions](../reference/permissions.mdx#object-permissions).** - **AccountRoles** are groups of permissions you can assign to accounts. - **AccountGroups** allow you to manage permissions for multiple users all at once. Permissions are allocated to users through groups and roles. -For more detailed information on this allocation, you can check [Users permissions management Section](/topics/auth.mdx#users-permissions-management). +For more detailed information on this allocation, you can check [Users permissions management Section](../topics/auth.mdx#users-permissions-management). ## Types of permissions diff --git a/docs/docs-infrahub/topics/repository.mdx b/docs/docs-infrahub/topics/repository.mdx index c9f367a..2effad6 100644 --- a/docs/docs-infrahub/topics/repository.mdx +++ b/docs/docs-infrahub/topics/repository.mdx @@ -13,17 +13,17 @@ Infrahub supports two different types of connections to external Git repositorie - **Repository** fully integrates with Git version control, including branch tracking and two-way branch synchronization. - **Read-only Repository** links a particular branch in Infrahub to a particular ref in the Git repository. It will only read from the Git repository. It will never make any changes to the external repository. -See the [guide](/guides/repository) for instructions on creating repositories in Infrahub. +See the [guide](../guides/repository) for instructions on creating repositories in Infrahub. ## `.infrahub.yml` file {#infrahub-yaml} The `.infrahub.yml` configuration file specifies exactly what should be imported into Infrahub from the external repository, it could be transformations, GraphQL query, artifact definitions, generators ... -See [this topic](/topics/infrahub-yml) for a full explanation of everything that can be defined in the `.infrahub.yml` file. +See [this topic](../topics/infrahub-yml) for a full explanation of everything that can be defined in the `.infrahub.yml` file. ## Architecture {#architecture} -The [Infrahub web server](/reference/api-server) will never connect directly with external Git repositories. All interactions between Infrahub and remote Git repositories are handled by the [Task worker](/reference/git-agent). The Task worker(s) can work with any remote Git server that using either `git` or `http` protocols. The Infrahub web server can send commands to the Task worker via our message broker and the Task worker can send data back to the Infrahub web server via GraphQL mutations. +The [Infrahub web server](../reference/api-server) will never connect directly with external Git repositories. All interactions between Infrahub and remote Git repositories are handled by the [Task worker](../reference/git-agent). The Task worker(s) can work with any remote Git server that using either `git` or `http` protocols. The Infrahub web server can send commands to the Task worker via our message broker and the Task worker can send data back to the Infrahub web server via GraphQL mutations. ![](../media/repository_architecture.excalidraw.svg) @@ -47,19 +47,19 @@ Updates **to** remote | When merging Proposed Change | No Read-only Repositories will only pull data from an external repository into Infrahub and will never push any data to the external repository. A Read-only Repository will pull changes from a single `ref` (branch, tag, or commit) into the Infrahub branch(es) on which it exists. Read-only repositories are not automatically updated. To update a Read-only Repository, you must manually update the `ref` property to a new value, then the Task worker will pull the appropriate commit and create the appropriate objects in Infrahub. -See the [guide](/guides/repository) for instructions on pulling changes from read-only repositories in Infrahub. +See the [guide](../guides/repository) for instructions on pulling changes from read-only repositories in Infrahub. ### Repository {#repository} When you create a `Repository`, Infrahub will try to pull every branch defined in the external repository and create an associated Infrahub branch with the same name and matching data according to what is defined in the `.infrahub.yml` configuration file on the particular remote branch. Infrahub will attempt to sync updates from the external repository several times per minute in a background task that runs on the Task worker(s). -Editing a given GraphQL Query, Transform, Artifact Definition, or Schema within Infrahub **will not** result in those changes being pushed to the external repository and **could potentially be overwritten** when Infrahub pulls new commits from the external repository. Infrahub will only push changes to an external repository when a [Proposed Change](/topics/proposed-change) is merged for which the source and destination branch are both linked to branches on the same external repository. In this case, Infrahub will attempt to create a merge commit and push that commit to the destination branch on the external repository. +Editing a given GraphQL Query, Transform, Artifact Definition, or Schema within Infrahub **will not** result in those changes being pushed to the external repository and **could potentially be overwritten** when Infrahub pulls new commits from the external repository. Infrahub will only push changes to an external repository when a [Proposed Change](../topics/proposed-change) is merged for which the source and destination branch are both linked to branches on the same external repository. In this case, Infrahub will attempt to create a merge commit and push that commit to the destination branch on the external repository. ## Repository statuses Repository object has three status fields, all tracking various metrics. -See this [guide](/guides/repository) for instructions on troubleshooting repositories. +See this [guide](../guides/repository) for instructions on troubleshooting repositories. ### Admin status diff --git a/docs/docs-infrahub/topics/resource-manager.mdx b/docs/docs-infrahub/topics/resource-manager.mdx index a743511..56a08bd 100644 --- a/docs/docs-infrahub/topics/resource-manager.mdx +++ b/docs/docs-infrahub/topics/resource-manager.mdx @@ -22,4 +22,4 @@ Resources can be allocated in 2 different ways: - Direct allocation: A direct allocation is typically used when you don't need the resource to be related to another node in Infrahub, or if you want establish such a relation at a later time. For example, you want to allocated an IP address out of a pool that is not going to be linked to another node in Infrahub. - Relationship resource allocation: A resource can be allocated to a relationship of a node, when you create a new node. For example, when you want to create a device and assign an IP address out of a pool to an interface at device creation time. -See the [guide](/guides/resource-manager) for instructions on creating and using resource manager in Infrahub. +See the [guide](../guides/resource-manager) for instructions on creating and using resource manager in Infrahub. diff --git a/docs/docs-infrahub/topics/resources-testing-framework.mdx b/docs/docs-infrahub/topics/resources-testing-framework.mdx index d6c6279..d9a01b2 100644 --- a/docs/docs-infrahub/topics/resources-testing-framework.mdx +++ b/docs/docs-infrahub/topics/resources-testing-framework.mdx @@ -6,9 +6,9 @@ title: Resources testing framework ## Summary -Infrahub allows users to define tests to ensure that [transformations](/topics/transformation) and [checks](/topics/check) are working as intended. This can be an important step while writing Infrahub related resources as it makes sure that they keep returning the same expected values over time and version bumps. +Infrahub allows users to define tests to ensure that [transformations](../topics/transformation) and [checks](../topics/check) are working as intended. This can be an important step while writing Infrahub related resources as it makes sure that they keep returning the same expected values over time and version bumps. -These tests are based on [pytest](https://docs.pytest.org/) but do not require users to write any Python code. Tests can be run via a command line and the `pytest` executable but they are also integrated within the CI pipelines of [proposed changes](/topics/proposed-change). +These tests are based on [pytest](https://docs.pytest.org/) but do not require users to write any Python code. Tests can be run via a command line and the `pytest` executable but they are also integrated within the CI pipelines of [proposed changes](../topics/proposed-change). ## Types of test @@ -31,7 +31,7 @@ infrahub_tests: The `version: "1.0"` line defines the version of the test declaration file. The syntax of this file is subject to changes in the future as the testing framework gets improved. -All Jinja2 transforms, Python transforms, checks and GraphQL queries declared in a repository [configuration file](/reference/dotinfrahub) can be tested. +All Jinja2 transforms, Python transforms, checks and GraphQL queries declared in a repository [configuration file](../reference/dotinfrahub) can be tested. Tests are declared using a two level hierarchy, they are grouped by resources like: @@ -45,7 +45,7 @@ infrahub_tests: kind: TypeOfTest ``` -All available keys and their values are listed in the tests configuration file [reference](/reference/infrahub-tests). +All available keys and their values are listed in the tests configuration file [reference](../reference/infrahub-tests). ## Real life example diff --git a/docs/docs-infrahub/topics/schema.mdx b/docs/docs-infrahub/topics/schema.mdx index fedb1c7..e72c146 100644 --- a/docs/docs-infrahub/topics/schema.mdx +++ b/docs/docs-infrahub/topics/schema.mdx @@ -14,11 +14,11 @@ Out of the box, Infrahub doesn't have a schema for most things and it's up to us Unlike traditional databases that can only have one schema at a time, in Infrahub it is possible to have a different schema per branch. This is possible because the schema itself is stored in the database like any other object. -There are several ways to [load a new schema](/guides/import-schema). +There are several ways to [load a new schema](../guides/import-schema). :::note -To help with the development process of a schema definition file, you can leverage the schemas we publish for validation within your [editor](/reference/schema-validation) +To help with the development process of a schema definition file, you can leverage the schemas we publish for validation within your [editor](../reference/schema-validation) ::: @@ -260,7 +260,7 @@ The **direction** attribute defines the flow of the relationship: Even if a relationship is `bidirectional`, you still have to create it on both nodes to allow you to easily traverse them in both directions. -For detailed information, see the [Relationship Reference Guide](/reference/schema/relationship#direction) +For detailed information, see the [Relationship Reference Guide](../reference/schema/relationship#direction) ##### Identifier @@ -270,7 +270,7 @@ If no identifier is provided, one will be generated automatically. It is encoura If no identifier is specified, one will be automatically generated in the format `__`. Example: `infraautonomoussystem__organizationgeneric` -For detailed information, see the [Relationship Reference Guide](/reference/schema/relationship#identifier) +For detailed information, see the [Relationship Reference Guide](../reference/schema/relationship#identifier) ##### Examples @@ -864,7 +864,7 @@ The `infrahubctl schema load` command can be used to both upload a new schema an ### Git integration -You can defined a schema in an [external repository](/topics/repository). +You can defined a schema in an [external repository](../topics/repository). The schemas that should be loaded must be declared in the ``.infrahub.yml`` file, under schemas. Individual files and directory are both supported. @@ -966,7 +966,7 @@ Most changes to an existing schema are supported but there are a few properties - Properties that can't be updated on an Attribute: `branch` - Properties that can't be updated on an Relationship: `branch`, `direction`, `hierarchical` -[A reference guide for validators and migrations is available](/reference/schema/validator-migration) +[A reference guide for validators and migrations is available](../reference/schema/validator-migration) ### Known limitations diff --git a/docs/docs-infrahub/topics/transformation.mdx b/docs/docs-infrahub/topics/transformation.mdx index 6e282e7..08f029e 100644 --- a/docs/docs-infrahub/topics/transformation.mdx +++ b/docs/docs-infrahub/topics/transformation.mdx @@ -55,7 +55,7 @@ Infrahub can natively render any Jinja templates dynamically. Internally it's re #### Create a Jinja rendered transform -Please refer to the guide [Creating a Jinja Rendered Transform](/guides/jinja2-transform) for more information. +Please refer to the guide [Creating a Jinja Rendered Transform](../guides/jinja2-transform) for more information. #### Render a Jinja2 transform @@ -63,7 +63,7 @@ A Jinja2 Transform can be rendered with 3 different methods: - On demand via the REST API - As part of an [artifact](./artifact.mdx) -- In CLI for development and troubleshooting [infrahubctl render](/infrahubctl/infrahubctl-render) +- In CLI for development and troubleshooting [infrahubctl render](../infrahubctl/infrahubctl-render) ### TransformPython (Python plugin) @@ -73,7 +73,7 @@ A `TransformPython` is a transformation plugin written in Python. It can generat A TransformPython must be written as a Python class that inherits from `InfrahubTransform` and it must implement one `transform` method. The transform method must accept a dict and return one. -Please refer to the guide [Creating a Python transform](/guides/python-transform) for more information. +Please refer to the guide [Creating a Python transform](../guides/python-transform) for more information. #### Render a TransformPython @@ -81,7 +81,7 @@ A TransformPython can be rendered with 2 different methods: - On demand via the REST API - As part of an [Artifact](./artifact.mdx) -- Via the CLI for development and troubleshooting: [infrahubctl transform](/infrahubctl/infrahubctl-transform) +- Via the CLI for development and troubleshooting: [infrahubctl transform](../infrahubctl/infrahubctl-transform) ## Unit testing for transformation @@ -89,4 +89,4 @@ Infrahub provide a framework to create unit tests for your transformations with The tests can be executed locally for development purpose and they will also be executed as part of the CI Pipeline when the platform identify a change that could potentially impact your transformation. -For more information, please check out the [Resource Testing Framework](/topics/resources-testing-framework) page. +For more information, please check out the [Resource Testing Framework](../topics/resources-testing-framework) page. diff --git a/docs/docs-infrahub/topics/version-control.mdx b/docs/docs-infrahub/topics/version-control.mdx index e1423e8..4320565 100644 --- a/docs/docs-infrahub/topics/version-control.mdx +++ b/docs/docs-infrahub/topics/version-control.mdx @@ -28,7 +28,7 @@ It's possible to query a previous version of the database by providing a specifi The implementation of version control in Infrahub is inspired by Git but also different in several ways -A branch provide a safe environment to prepare and validate a change before integrating it into the default branch by opening a [Proposed Change](/topics/proposed-change). +A branch provide a safe environment to prepare and validate a change before integrating it into the default branch by opening a [Proposed Change](../topics/proposed-change). Branches are meant to be short lived, from a few seconds to a few weeks, and are hierarchical by nature which means that a branch can only be merged into the branch it was created from. @@ -104,7 +104,7 @@ To view all the changes in a branch :::info Only the changes in Branch Aware mode will be displayed in the diff view and only these changes will be included in a merge operation. -Check the [Branch Support section in the Schema documentation](/topics/schema#branch-support) for more information. +Check the [Branch Support section in the Schema documentation](../topics/schema#branch-support) for more information. ::: diff --git a/docs/docs-infrahub/tutorials/getting-started/branches.mdx b/docs/docs-infrahub/tutorials/getting-started/branches.mdx index 4c01d25..e54ae0e 100644 --- a/docs/docs-infrahub/tutorials/getting-started/branches.mdx +++ b/docs/docs-infrahub/tutorials/getting-started/branches.mdx @@ -165,6 +165,6 @@ Go back to the detailed page for the Tenant `my-first-tenant`. :::info Proposed Change -For an in-depth understanding of Infrahub's approach to handling differences between branches and merging them, please consult the [proposed change topic](/topics/proposed-change). +For an in-depth understanding of Infrahub's approach to handling differences between branches and merging them, please consult the [proposed change topic](../../topics/proposed-change). ::: diff --git a/docs/docs-infrahub/tutorials/getting-started/git-integration.mdx b/docs/docs-infrahub/tutorials/getting-started/git-integration.mdx index 944d014..18059f8 100644 --- a/docs/docs-infrahub/tutorials/getting-started/git-integration.mdx +++ b/docs/docs-infrahub/tutorials/getting-started/git-integration.mdx @@ -8,7 +8,7 @@ One of the three pillars Infrahub is built on is the idea of having unified stor 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. -Please refer to [Repository](/topics/repository) to learn more about it. +Please refer to [Repository](../../topics/repository) to learn more about it. ## Fork & Clone the repository for the demo @@ -24,7 +24,7 @@ The goal is to have a copy of this repository under your name. This way your tes Once you have created a fork in GitHub, you'll need a Personal Access Token to authorize Infrahub to access this repository. -[How to create a Personal Access Token in GitHub](/guides/repository#github-access-token) +[How to create a Personal Access Token in GitHub](../../guides/repository#github-access-token) :::note @@ -47,14 +47,14 @@ If you already cloned the repository in the past, ensure only the main branch is Currently the easiest way to add a repository is to use the web interface. -Refer to [Adding a repository guide](/guides/repository). +Refer to [Adding a repository guide](../../guides/repository). -After adding the `infrahub-demo-edge` repository you will be able to see several new [Transformations](/topics/transformation) and related objects: +After adding the `infrahub-demo-edge` repository you will be able to see several new [Transformations](../../topics/transformation) and related objects: - 2 Jinja Rendered File under [Jinja2 Transformation](http://localhost:8000/objects/CoreTransformJinja2/) (Menu > Deployment > Transformation) - 2 Python Transformation under [Python Transformation](http://localhost:8000/objects/CoreTransformPython) (Menu > Deployment > Transformation) - 2 [Artifact Definition](http://localhost:8000/objects/CoreArtifactDefinition) (Menu > Deployment > Artifact > Artifact Definition) -- 9 GraphQL [Queries](/topics/graphql) under [Objects / GraphQL Query](http://localhost:8000/objects/CoreGraphQLQuery/) (Menu > Unified Storage > GraphQL Query) +- 9 GraphQL [Queries](../../topics/graphql) under [Objects / GraphQL Query](http://localhost:8000/objects/CoreGraphQLQuery/) (Menu > Unified Storage > GraphQL Query) :::note Troubleshooting diff --git a/docs/docs-infrahub/tutorials/getting-started/introduction-to-infrahub.mdx b/docs/docs-infrahub/tutorials/getting-started/introduction-to-infrahub.mdx index 13afbb0..85bfe6c 100644 --- a/docs/docs-infrahub/tutorials/getting-started/introduction-to-infrahub.mdx +++ b/docs/docs-infrahub/tutorials/getting-started/introduction-to-infrahub.mdx @@ -26,4 +26,4 @@ During this tutorial we'll mainly use the Frontend, the `infrahubctl` CLI and th ## Installing Infrahub -Please follow the [Installation Guide](/guides/installation) to spin up Infrahub before continuing the tutorial. +Please follow the [Installation Guide](../../guides/installation) to spin up Infrahub before continuing the tutorial. diff --git a/docs/docs-infrahub/tutorials/getting-started/lineage-information.mdx b/docs/docs-infrahub/tutorials/getting-started/lineage-information.mdx index 025a78a..be0c568 100644 --- a/docs/docs-infrahub/tutorials/getting-started/lineage-information.mdx +++ b/docs/docs-infrahub/tutorials/getting-started/lineage-information.mdx @@ -6,7 +6,7 @@ title: Data lineage & metadata One of the core features of Infrahub is data lineage, which can be defined as `metadata` on all data points: attributes and relationships. -Please refer to [Data lineage and metadata](/topics/metadata) to learn more about it. +Please refer to [Data lineage and metadata](../../topics/metadata) to learn more about it. ## Explore the metadata defined in the demo dataset diff --git a/docs/docs-infrahub/tutorials/getting-started/readme.mdx b/docs/docs-infrahub/tutorials/getting-started/readme.mdx index f3e7d4e..96ce2b2 100644 --- a/docs/docs-infrahub/tutorials/getting-started/readme.mdx +++ b/docs/docs-infrahub/tutorials/getting-started/readme.mdx @@ -39,7 +39,7 @@ The tutorial is meant to be executed in order, as we'll be making some changes a ### Pre-requisites -The system that you want to use to run the demo environment has to meet the [hardware requirements](/topics/hardware-requirements). Alternatively you can run Infrahub in [GitHub codespaces](/guides/installation#github-codespaces). +The system that you want to use to run the demo environment has to meet the [hardware requirements](../../topics/hardware-requirements). Alternatively you can run Infrahub in [GitHub codespaces](../../guides/installation#github-codespaces). In order to run the demo environment, the following packages or applications must be installed on the systems: @@ -56,7 +56,7 @@ On a Laptop, both Docker & Docker Compose can be installed by installing [Docker ### Download Infrahub -Refer to the [Installation Documentation](/guides/installation). +Refer to the [Installation Documentation](../../guides/installation). ### First utilization @@ -83,9 +83,9 @@ While using the API the Authentication Token must be provided in a header named ::: -More accounts will be loaded with the [demo data](/topics/local-demo-environment#load-some-data). +More accounts will be loaded with the [demo data](../../topics/local-demo-environment#load-some-data). -Refer to [User management](/topics/auth/) page for more information regarding the possible rights. +Refer to [User management](../../topics/auth) page for more information regarding the possible rights. To follow the tutorial you should use the `admin` account but you can try the other accounts too to see how the interface behaves with different permission levels. diff --git a/docs/docs-infrahub/tutorials/getting-started/rendering-configuration.mdx b/docs/docs-infrahub/tutorials/getting-started/rendering-configuration.mdx index 3e60c93..4e08592 100644 --- a/docs/docs-infrahub/tutorials/getting-started/rendering-configuration.mdx +++ b/docs/docs-infrahub/tutorials/getting-started/rendering-configuration.mdx @@ -11,7 +11,7 @@ Infrahub has 2 types of transformations: - Jinja2 transformation - Python transformation -Please refer to [Transformation topic](/topics/transformation) to learn more about it. +Please refer to [Transformation topic](../../topics/transformation) to learn more about it. ## Generate the configuration of a device using Jinja2 diff --git a/docs/docs-infrahub/tutorials/getting-started/schema.mdx b/docs/docs-infrahub/tutorials/getting-started/schema.mdx index a3bee8a..cc55efe 100644 --- a/docs/docs-infrahub/tutorials/getting-started/schema.mdx +++ b/docs/docs-infrahub/tutorials/getting-started/schema.mdx @@ -26,7 +26,7 @@ You can explore the current schema by visiting the schema page, you can find it ![schema page screenshot](../../media/tutorial_3_schema.png) - + ## Extend the schema with some network related models diff --git a/docs/docs-projects/readme.mdx b/docs/docs-projects/readme.mdx deleted file mode 100644 index 6a0dd9b..0000000 --- a/docs/docs-projects/readme.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Introduction ---- - -Infrahub from [OpsMill](https://opsmill.com) is taking a new approach to Infrastructure Management by providing a new generation of datastore to organize and control all the data that defines how an infrastructure should run. Infrahub offers a central hub to manage the data, templates and playbooks that power your infrastructure by combining the version control and branch management capabilities of Git with the flexible data model and UI of a graph database. - -## Learn about Infrahub - -Blah diff --git a/docs/docs/readme.mdx b/docs/docs/readme.mdx new file mode 100644 index 0000000..a741e27 --- /dev/null +++ b/docs/docs/readme.mdx @@ -0,0 +1,28 @@ +--- +title: Infrahub Projects Documentation +--- + +Infrahub from [OpsMill](https://opsmill.com) is taking a new approach to Infrastructure Management by providing a new generation of datastore to organize and control all the data that defines how an infrastructure should run. Infrahub offers a central hub to manage the data, templates and playbooks that power your infrastructure by combining the version control and branch management capabilities of Git with the flexible data model and UI on top of a graph database. + +## Infrahub Documentation + + +Blah + +## Infrahub Projects + +### SDK + +Blah + +### Demo-dc-fabric + + + +This repository demos key Infrahub features using an example data center running VxLAN / EVPN and firewalls. It demonstrates the capabilities to use Infrahub with Arista AVD and Containerlab. Infrahub generates configurations that AVD deploys to a Containerlab topology. + +### Ansible + +Blah + +### Nornir diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 82da415..79683dc 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -42,8 +42,8 @@ const config: Config = { "classic", { docs: { - path: "docs-projects", - routeBasePath: "projects", + path: "docs", + routeBasePath: "/", sidebarCollapsed: true, sidebarPath: "./sidebars.ts", }, @@ -60,7 +60,7 @@ const config: Config = { { id: 'docs-infrahub', path: 'docs-infrahub', - routeBasePath: '/', + routeBasePath: 'infrahub', sidebarCollapsed: true, sidebarPath: './sidebars-infrahub.ts', editUrl: "https://github.com/opsmill/infrahub/tree/stable/docs", @@ -97,21 +97,21 @@ const config: Config = { srcDark: "img/infrahub-hori-dark.svg", }, items: [ + { + type: "docSidebar", + sidebarId: "docsSidebar", + label: "Infrahub Documentation", + docsPluginId: "docs-infrahub", + }, { type: 'dropdown', position: 'left', - label: 'Projects', + label: 'Infrahub Projects', items: [ { type: "docSidebar", sidebarId: "landingSidebar", - label: "Infrahub Projects", - }, - { - type: "docSidebar", - sidebarId: "docsSidebar", - label: "Infrahub Documentation", - docsPluginId: "docs-infrahub", + label: "Projects Overview", }, { type: "docSidebar", From 48fc94ad892b98b8468400aafc094f9fdd03781e Mon Sep 17 00:00:00 2001 From: Pete Crocker Date: Thu, 2 Jan 2025 15:41:36 +0000 Subject: [PATCH 3/4] change navbar --- docs/docusaurus.config.ts | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 79683dc..5c49a87 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -100,19 +100,37 @@ const config: Config = { { type: "docSidebar", sidebarId: "docsSidebar", - label: "Infrahub Documentation", + label: "Infrahub Docs", docsPluginId: "docs-infrahub", }, + { + label: 'Python SDK Docs', + href: 'https://docs.infrahub.app/python-sdk/', + }, { type: 'dropdown', position: 'left', - label: 'Infrahub Projects', + label: 'Integrations', items: [ { - type: "docSidebar", - sidebarId: "landingSidebar", - label: "Projects Overview", + label: 'Ansible', + href: 'https://docs.infrahub.app/integrations/infrahub-ansible/', + }, + { + label: 'infrahub-sync', + href: 'https://docs.infrahub.app/integrations/sync/', + }, + { + label: 'Nornir', + href: 'https://docs.infrahub.app/integrations/nornir-infrahub/', }, + ], + }, + { + type: 'dropdown', + position: 'left', + label: 'Demos', + items: [ { type: "docSidebar", sidebarId: "demoSidebar", @@ -134,7 +152,7 @@ const config: Config = { ], }, footer: { - copyright: `Copyright © ${new Date().getFullYear()} - Infrahub by OpsMill.`, + copyright: `Copyright © ${new Date().getFullYear()} - Infrahub by OpsMill.`, }, prism: { theme: prismThemes.oneDark, From d401e3027e92aacd10815ccf61b7689ead038516 Mon Sep 17 00:00:00 2001 From: Pete Crocker Date: Thu, 2 Jan 2025 15:42:33 +0000 Subject: [PATCH 4/4] linting --- docs/docs-infrahub/convert_links.py | 31 ++++++++++++++++------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/docs/docs-infrahub/convert_links.py b/docs/docs-infrahub/convert_links.py index 36b2497..c9abac9 100644 --- a/docs/docs-infrahub/convert_links.py +++ b/docs/docs-infrahub/convert_links.py @@ -2,44 +2,47 @@ from pathlib import Path import os + def convert_absolute_to_relative(source_path: Path, absolute_path: str) -> str: """Convert an absolute path to a relative path based on the source file location.""" # Remove leading slash to make it relative to the root - target_path = Path(absolute_path.lstrip('/')) - + target_path = Path(absolute_path.lstrip("/")) + # Get the relative path from source directory to target relative_path = os.path.relpath(target_path, source_path.parent) - + return relative_path + def process_file(file_path: Path) -> None: """Process a single markdown file and convert absolute links to relative.""" content = file_path.read_text() - + # Regular expression to find markdown links - pattern = r'\[([^\]]+)\]\((/[^)]+)\)' - + pattern = r"\[([^\]]+)\]\((/[^)]+)\)" + def replace_link(match): link_text = match.group(1) absolute_path = match.group(2) relative_path = convert_absolute_to_relative(file_path, absolute_path) - return f'[{link_text}]({relative_path})' - + return f"[{link_text}]({relative_path})" + new_content = re.sub(pattern, replace_link, content) - + # Only write if content has changed if new_content != content: print(f"Updating {file_path}") file_path.write_text(new_content) + def main(): # Find all markdown files in current directory and subdirectories - root_dir = Path('.') - markdown_files = list(root_dir.rglob('*.md')) + list(root_dir.rglob('*.mdx')) - + root_dir = Path(".") + markdown_files = list(root_dir.rglob("*.md")) + list(root_dir.rglob("*.mdx")) + for file_path in markdown_files: process_file(file_path) -if __name__ == '__main__': - main() +if __name__ == "__main__": + main()