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

Add detailed changelog link to documentation page #38

Closed
bryanwweber opened this issue Aug 24, 2018 · 4 comments
Closed

Add detailed changelog link to documentation page #38

bryanwweber opened this issue Aug 24, 2018 · 4 comments
Labels
enhancement New feature or request

Comments

@bryanwweber
Copy link
Member

bryanwweber commented Aug 24, 2018

We would like to publish the detailed change logs that we generate for each release on the website. These detailed change logs contain comments for nearly all of the git commits and pull requests since the last release. The links to the change logs could be in the "Other documentation" section of the main Documentation page.

I think the best way to solve this issue is to write a plugin that automatically takes a markdown file with git hashes, GitHub usernames, and GitHub issue/PR numbers and writes the correct links. The markdown file with the change log should be stored in the repository for the website somewhere, perhaps in a posts/changelogs directory.

@bryanwweber
Copy link
Member Author

@HAKSOAT
Copy link

HAKSOAT commented Apr 5, 2019

@bryanwweber I'm interested in working on this project. Any extra information I may need to write a proposal?

@bryanwweber
Copy link
Member Author

@HAKSOAT Please see the GSoC ideas page for more information: https://github.com/Cantera/cantera/wiki/GSoC-2019-Ideas Note that addressing only this issue in your GSoC proposal will not be sufficient for it to be successful.

@bryanwweber
Copy link
Member Author

This was completed by #95

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants