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

Move collection-level documentation into the collection #337

Open
samccann opened this issue Nov 13, 2023 · 3 comments
Open

Move collection-level documentation into the collection #337

samccann opened this issue Nov 13, 2023 · 3 comments
Assignees

Comments

@samccann
Copy link
Contributor

SUMMARY

We are moving away from having collection-specific documentation outside of a collection as they end up unmaintained.
Move the following docs inside this collection:
https://docs.ansible.com/ansible/latest/network/user_guide/platform_vyos.html

ISSUE TYPE
  • Documentation Report
COMPONENT NAME
ANSIBLE VERSION

@andamasov
Copy link
Member

@NilashishC, how can this be handled on our side?

@samccann
Copy link
Contributor Author

The easiest way is to add it to the collection docs/docsite directory - https://docs.ansible.com/ansible/latest/dev_guide/developing_collections_structure.html#collections-doc-dir

This issue was opened for docs removed from the community version of Ansible. The above link goes into detail on how to do that.

NOTE: If you want these docs on Automation Hub, it's in markdown and last I checked, only supports a few files with no index to order them in. That said, I believe Automation Hub supports having a separate docsite if you want more complete docs available there. See https://docs.ansible.com/ansible/latest/dev_guide/developing_collections_documenting.html#build-a-docsite-with-antsibull-docs for some ideas on how to do that.

@andamasov
Copy link
Member

@samccann, thank you for your guidance! i will be looking into that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants