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

Docs FR: "edit this section" link #101

Closed
adidahiya opened this issue Nov 12, 2016 · 5 comments
Closed

Docs FR: "edit this section" link #101

adidahiya opened this issue Nov 12, 2016 · 5 comments

Comments

@adidahiya
Copy link
Contributor

Would be cool to have an "edit this section" link on every KSS section that takes you to the Github file on the master branch.

@giladgray
Copy link
Contributor

this would be cool!

but the thing is, KSS sections don't know which file they came from. KSS doesn't expose that data from its API, and it processes all the files at once so I can't easily figure it out myself. 😢

@llorca
Copy link
Contributor

llorca commented Jan 17, 2017

What is the goal of this FR? Is it about being able to quickly edit the docs on GitHub when a correction needs to be made?

@adidahiya
Copy link
Contributor Author

adidahiya commented Jan 18, 2017

@llorca yep, exactly, to make it easy for anyone to send corrections or enhancements. I've seen this on a number of other projects that have high-quality docs, including our internal RTFM

@llorca
Copy link
Contributor

llorca commented Jan 18, 2017

Hopefully will be doable once we have full Markdown docs

peterblazejewicz pushed a commit to peterblazejewicz/blueprint that referenced this issue Dec 20, 2017
@giladgray giladgray added this to the 3.0.0 milestone Apr 17, 2018
@giladgray
Copy link
Contributor

requires change in documentalist to link to source md file

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

No branches or pull requests

3 participants