Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align Integrations Documentation Structure #265

Merged
merged 6 commits into from
Feb 5, 2024
Merged

Conversation

snaselj
Copy link
Contributor

@snaselj snaselj commented Sep 25, 2023

Closes: NaN

What's Changed

  • Aligned integrations documentation structure with SSoT.

@snaselj
Copy link
Contributor Author

snaselj commented Sep 25, 2023

@cmsirbu Could you pls. check this?

@snaselj snaselj changed the base branch from next-2.0 to develop January 30, 2024 09:45
Copy link
Contributor

@cmsirbu cmsirbu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a bunch of minor fixes, great work otherwise! Once the build errors are fixed, we should be good to go.

Path has an extra .. which causes build errors in all 3 includes in this file:

ERROR   -  Error reading page 'admin/install.md':
ERROR   -  No files found including '../../glossary.md' at admin/install.md:16

docs/admin/integrations/aci.md Outdated Show resolved Hide resolved
docs/admin/integrations/aci.md Outdated Show resolved Hide resolved
docs/admin/integrations/aci.md Outdated Show resolved Hide resolved
docs/admin/integrations/ansible.md Outdated Show resolved Hide resolved
docs/admin/integrations/ansible.md Outdated Show resolved Hide resolved
docs/admin/integrations/meraki.md Outdated Show resolved Hide resolved
docs/admin/integrations/meraki.md Outdated Show resolved Hide resolved
docs/admin/integrations/panorama.md Outdated Show resolved Hide resolved
docs/admin/integrations/panorama.md Outdated Show resolved Hide resolved
docs/admin/integrations/panorama.md Outdated Show resolved Hide resolved
@cmsirbu
Copy link
Contributor

cmsirbu commented Jan 31, 2024

--- a/docs/admin/install.md
+++ b/docs/admin/install.md
@@ -13,7 +13,7 @@ This guide outlines the process of enabling Nautobot ChatOps, which includes:
   - [Test Your Chatbot](#test-your-chatbot)
   - [Integrations Configuration](#integrations-configuration)

-{% include-markdown '../../glossary.md' heading-offset=1 %}
+{% include-markdown '../glossary.md' heading-offset=1 %}

 ## Prerequisites

@@ -126,7 +126,7 @@ Adjust the App's behavior with the following settings:
 ## Granting Access to the Chat Platform

 {%
-    include-markdown '../../models/accessgrant.md'
+    include-markdown '../models/accessgrant.md'
     start='<!--access-grant-->'
     heading-offset=1
 %}
@@ -134,7 +134,7 @@ Adjust the App's behavior with the following settings:
 ## Link Nautobot Account

 {%
-    include-markdown '../../models/chatopsaccountlink.md'
+    include-markdown '../models/chatopsaccountlink.md'
     start='<!--account-link-->'
     heading-offset=1
 %}

snaselj and others added 2 commits February 1, 2024 08:27
Co-authored-by: Cristian <cmsirbu@users.noreply.github.com>
@snaselj
Copy link
Contributor Author

snaselj commented Feb 1, 2024

--- a/docs/admin/install.md
+++ b/docs/admin/install.md
@@ -13,7 +13,7 @@ This guide outlines the process of enabling Nautobot ChatOps, which includes:
   - [Test Your Chatbot](#test-your-chatbot)
   - [Integrations Configuration](#integrations-configuration)

-{% include-markdown '../../glossary.md' heading-offset=1 %}
+{% include-markdown '../glossary.md' heading-offset=1 %}

 ## Prerequisites

@@ -126,7 +126,7 @@ Adjust the App's behavior with the following settings:
 ## Granting Access to the Chat Platform

 {%
-    include-markdown '../../models/accessgrant.md'
+    include-markdown '../models/accessgrant.md'
     start='<!--access-grant-->'
     heading-offset=1
 %}
@@ -134,7 +134,7 @@ Adjust the App's behavior with the following settings:
 ## Link Nautobot Account

 {%
-    include-markdown '../../models/chatopsaccountlink.md'
+    include-markdown '../models/chatopsaccountlink.md'
     start='<!--account-link-->'
     heading-offset=1
 %}

Fixed

@snaselj snaselj marked this pull request as ready for review February 1, 2024 07:41
@snaselj snaselj requested a review from cmsirbu February 1, 2024 07:41
@snaselj
Copy link
Contributor Author

snaselj commented Feb 1, 2024

This pull request has been refreshed and is ready for review.

@smk4664
Copy link
Contributor

smk4664 commented Feb 5, 2024

I hope you don't mind, I fixed another mkdocs issue, unrelated to your pull request.

@smk4664 smk4664 merged commit 9df92dc into develop Feb 5, 2024
15 checks passed
@cmsirbu cmsirbu deleted the u/snaselj-align-docs branch February 6, 2024 12:55
@cmsirbu cmsirbu mentioned this pull request Feb 12, 2024
3 tasks
@smk4664 smk4664 mentioned this pull request Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants