-
Task
-
Resolution: Done
-
Normal
-
None
-
None
-
None
-
rhel-sst-system-roles
-
CCS 2024-12
-
None
https://docs.google.com/document/d/18TBETADIo22g6fy784F64iFSsZM7FWvF5rMSQ-R1ktc/edit#
AI Pavel: Investigate conversion of downstream documentation into upstream format - text format (e.g. conversion to markdown) - prepare an example using storage role docs - where to put (under each role? but then how to publish under linux-system-roles.github.io?)
Katarina will investigate licensing issues e.g. downstream images can be used upstream
[RHELDOCS-18448] docs - investigate if and how to convert downstream docs to upstream
Brian Smith
added a comment - rmeggins@redhat.com I'd suggest we make a few small improvements on the upstream site ( https://linux-system-roles.github.io/documentation/intro-to-ansible-for-system-roles.html ):
- It looks like the Ansible Galaxy icon in the upper right has an outdated link
- Perhaps under the Documentation menu drop down, we could change the "External Resources" link to expand to the side, and include links to: the downstream RHEL system roles documentation, the RHEL system roles blog page, etc.
- Perhaps under the Documentation menu, the top item could be "Role README.md files", which would take you to a page that explains that each Linux System Role has a README.md file that covers role usage, has examples, etc. We could mention that these README.md files are available on Github, Ansible Galaxy, and for linux-system-roles RPM installs at /usr/share/doc/linux-system-roles/
Brian Smith
added a comment - rmeggins@redhat.com I'd suggest we make a few small improvements on the upstream site ( https://linux-system-roles.github.io/documentation/intro-to-ansible-for-system-roles.html ):
It looks like the Ansible Galaxy icon in the upper right has an outdated link
Perhaps under the Documentation menu drop down, we could change the "External Resources" link to expand to the side, and include links to: the downstream RHEL system roles documentation , the RHEL system roles blog page , etc.
Perhaps under the Documentation menu, the top item could be "Role README.md files", which would take you to a page that explains that each Linux System Role has a README.md file that covers role usage, has examples, etc. We could mention that these README.md files are available on Github, Ansible Galaxy, and for linux-system-roles RPM installs at /usr/share/doc/linux-system-roles/
> Richard Megginson, is there still a need to duplicate the RH system role docs to upstream, or can we close this ticket?
rhn-support-briasmit This initiative was something that Terry wanted to do. I'm not sure if the goal was to make a copy of the downstream docs available at https://linux-system-roles.github.io/, or just generally improve the docs. If the latter - we have better README now, and many roles have example playbooks.
Marc Muehlfeld
added a comment - This ticket is over 4 years old, and the upstream readme files for each roles are very good and detailed (and we even reference the readme files in the RPM in each procedure).
rmeggins@redhat.com, is there still a need to duplicate the RH system role docs to upstream, or can we close this ticket?
Marc Muehlfeld
added a comment - This ticket is over 4 years old, and the upstream readme files for each roles are very good and detailed (and we even reference the readme files in the RPM in each procedure).
rmeggins@redhat.com , is there still a need to duplicate the RH system role docs to upstream, or can we close this ticket? knemcova so, if the stories are moved to upstream, then the downstream docs (at customer portal) will have to include a reference to the original upstream location (GitHub), right? Is there some prior art for this in the currently existing guides at the customer portal?
Hi,
regarding the licensing, this is the answer from Jaromir Hradilek:
It should not be a problem, our documentation is published under open CC license (The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at[ http://creativecommons.org/licenses/by-sa/3.0/|http://creativecommons.org/licenses/by-sa/3.0/]. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.)
rhn-support-briasmit done - https://linux-system-roles.github.io/