Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
'Contribute in GitHub' links in non-generated doc topics #1046
In the IBM Cloud docs, readers can click links at the top of each doc topic to either raise an issue with the topic in GitHub or to directly create an update and submit a PR for the topic. I've used this feature (as a reader wanting to make some updates; even just fixing a typo) a few times and it's really useful - it makes contributing back really, really easy (obviously, it needs there to be someone responding to them but if there are updates needed, it's better that someone is spotting them).
See, for example, https://cloud.ibm.com/docs/java?topic=java-overview#overview
We can start working/investigating this now as it will take time to get it correctly working for all our pages (this can also be staged in if necessary). This does still need desgin (@cajaygle ), but since the extra content is minimal, it should be trivial to apply any styling changes afterwards.
We also need to consider how we'll track changes to generated documents to contribute back to the source (config, features, MP APIs, Java APIs)
referenced this issue
Mar 27, 2019
I've scoped this issue down to implementing the github links for non-generated doc content (Server Commands and General References docs, as well as the "Overview" pages for config, and in the future features overview, pages). I've opened #1085 to track the work for github links for generated content.