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

Replace "View source" with "Improve this page" #676

Merged
merged 1 commit into from Dec 11, 2017
Merged

Replace "View source" with "Improve this page" #676

merged 1 commit into from Dec 11, 2017

Conversation

leouieda
Copy link
Contributor

@leouieda leouieda commented Dec 8, 2017

Modify the ReadTheDocs 'breadcrumbs.html' template to include this link. The link in the docs will point to the Github source in "edit" mode (on the master branch). If the page is autogenerated, it will point to a new issue instead with the page name included in the title and some instructions in the body.

Fixes #673

Modify the ReadTheDocs 'breadcrumbs.html' template to include this link.
The link in the docs will point to the Github source in "edit" mode (on
the master branch). If the page is autogenerated, it will point to a new
issue instead with the page name included in the title and some
instructions in the body.
@CLAassistant
Copy link

CLAassistant commented Dec 8, 2017

CLA assistant check
All committers have signed the CLA.

@leouieda
Copy link
Contributor Author

leouieda commented Dec 8, 2017

So, it turns out that Github doesn't allow editing a file based on a tag. So there is no way to point the editing to the version corresponding to the docs build, only to master. I don't think this is a big problem and is probably best. The only issue that might happen is if a file changes names on master. This would result in a 404.

@dopplershift dopplershift added this to the 0.7 milestone Dec 8, 2017
@dopplershift dopplershift added Area: Docs Affects documentation Type: Enhancement Enhancement to existing functionality labels Dec 8, 2017
Copy link
Member

@dopplershift dopplershift left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having everything open against master seems fine to me.

Thanks for helping out MetPy!

@leouieda
Copy link
Contributor Author

leouieda commented Dec 9, 2017

@dopplershift it's my pleasure! I borrow a lot from the metpy design so it's the least I can do.

@dopplershift
Copy link
Member

It's terrifying to know that my design...sensibilities could be infecting other unsuspecting projects. 😱 😁

(Honestly, I'm flattered...)

@leouieda
Copy link
Contributor Author

leouieda commented Dec 9, 2017

Infections aren't always bad :)

@jrleeman
Copy link
Contributor

Thanks @leouieda!

@jrleeman jrleeman merged commit 0d07883 into Unidata:master Dec 11, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Docs Affects documentation Type: Enhancement Enhancement to existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants