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

Incorporate 'shared snippets' for the collection docs into the main rst files #1382

Open
3 tasks
samccann opened this issue Apr 30, 2024 · 1 comment
Open
3 tasks
Labels
good first issue Good for newcomers

Comments

@samccann
Copy link
Contributor

Back in the dim dawn of time, we had repeated content in the Galaxy guides and the collection guides, so I added a bunch of collection snippets in the shared snippets folder:
https://github.com/ansible/ansible-documentation/tree/devel/docs/docsite/rst/shared_snippets

This issue is to review them and replace them with direct content in the main rst files where they are linked to now if they are only used in one location.

So basically:

  • grep to see where they are used. Ignore any .po files (translation files)
  • If a snippet is only used in one location, copy the content there and remove the snippet.
  • If a snippet is used in more than one location, add a comment here and we can as a group decide what to do.
@ansible-documentation-bot ansible-documentation-bot bot added the needs_triage Needs a first human triage before being processed. label Apr 30, 2024
@samccann
Copy link
Contributor Author

See #1315 for an example that did this for one of the snippets.

@samccann samccann removed the needs_triage Needs a first human triage before being processed. label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Status: 🆕 Triage
Development

No branches or pull requests

2 participants