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

'Contribute in GitHub' links in non-generated doc topics #1046

Open
lauracowen opened this Issue Mar 8, 2019 · 5 comments

Comments

Projects
None yet
5 participants
@lauracowen
Copy link
Member

lauracowen commented Mar 8, 2019

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

image

@mbroz2

This comment has been minimized.

Copy link
Contributor

mbroz2 commented Mar 26, 2019

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)

@lauracowen

This comment has been minimized.

Copy link
Member Author

lauracowen commented Mar 26, 2019

Sounds good. Would it be feasible to just not add it to the generated docs for a first pass?

@NottyCode

This comment has been minimized.

Copy link
Member

NottyCode commented Mar 26, 2019

@mbroz2 can we not just use the design from the IBM Cloud docs? It seems pretty clean, unobtrusive and it seems to me is likely already had design input.

@cajaygle

This comment has been minimized.

Copy link
Member

cajaygle commented Mar 27, 2019

I'm good with the design.

@cajaygle cajaygle removed the design needed label Mar 27, 2019

@mbroz2 mbroz2 changed the title 'Contribute in GitHub' links in doc topics 'Contribute in GitHub' links in non-generated doc topics Mar 27, 2019

@mbroz2

This comment has been minimized.

Copy link
Contributor

mbroz2 commented 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.