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.

Sign up for GitHub

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

Jump to bottom

docs(mkdocs): fix mkdocs #8188

Merged
merged 5 commits into from
Apr 1, 2024
Merged

docs(mkdocs): fix mkdocs #8188

merged 5 commits into from
Apr 1, 2024

Conversation

moabu
Copy link
Member

@moabu moabu commented Apr 1, 2024

Prepare

Description

Target issue

closes #8187

Test and Document the changes

  • Static code analysis has been run locally and issues have been fixed
  • Relevant unit and integration tests have been added/updated
  • Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

@moabu
fix: mkdocs
8f8efd3 
Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>
@mo-auto mo-auto added the area-documentation Documentation needs to change as part of issue or PR label Apr 1, 2024
ossdhaval
ossdhaval reviewed Apr 1, 2024
View reviewed changes
mkdocs.yml
@@ -457,7 +457,6 @@ nav:
- 'Adding authentication methods': 'casa/developer/add-authn-methods.md'
- User Guide: 'casa/user-guide.md'
plugins:
- include-markdown
Copy link
Contributor

@ossdhaval ossdhaval Apr 1, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@moabu

We may have to keep this plugin. That plugin is required for reuse of the text content. PR from @misba7 .

If we need to keep it, then I think it should be added to requirements as well so that plugin gets installed.

Copy link
Member Author

Choose a reason for hiding this comment

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

Correct but it should be added with the requirements and it should not break the docs while we fix it.

ossdhaval and others added 4 commits April 1, 2024 16:34
@ossdhaval
ci(docs): add plugin to the requirements.txt
6704572 
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
@ossdhaval
ci(docs): add include-markdown plugin in config
b9c782e 
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
@ossdhaval
ci(docs): revert the changes that installs the plugin
3c872b9 
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
@moabu
Merge branch 'main' into ci-fix-mkdocs
b02310a
@moabu moabu merged commit 016affb into main Apr 1, 2024
2 checks passed
@moabu moabu deleted the ci-fix-mkdocs branch April 1, 2024 13:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ossdhaval ossdhaval ossdhaval left review comments

Assignees
No one assigned
Labels
area-documentation Documentation needs to change as part of issue or PR
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs(mkdocs): fix mkdocs
3 participants
@moabu @ossdhaval @mo-auto