-
Notifications
You must be signed in to change notification settings - Fork 27.4k
docs(changelog): export the changelog and contributing.md to the site #9444
Comments
We could easily generate pages using Dgeni from the Markdown in those files. |
I'm for it. @petebacondarwin, any idea where to start? |
OK, so we knock up a little markdown file reader to generate a doc for each md file we want and a processor to make sure they get the right id and path so they get written out in the right place. I can do it this week unless someone else wants to have a crack. |
Any progress on this? Also, is it possible to have the changelog separated by the minor version. It's pretty confusing to have 1.2.x, 1.3.x, 1.4.x, and 1.5.x changes all in the same file and not even grouped together by version. |
No progress yet. Perhaps a task for over Xmas... |
I think we should use the changelog from master as a single source of truth for all versions. That way, we can have one changelog on the website that is always up to date for all versions (given that we update the master changelog with stable release changes). |
@Narretz having 1 changelog is fine, but when all the versions are mixed together, it gets too confusing trying to see everything that has changed between 2 versions. It would be nice to have every version grouped under the minor version, and the versions ordered in latest at the top and oldest at the bottom. |
Absolutely. I was just suggesting to use the latest changelog as the source
|
This should probably just be a simple link on the docs site, with maybe a link to the specific section if the user is in a particular version of the site, unless it is desired for it to be in a more central location. |
Good idea @wesleycho - anyone want to do a PR? |
- remove outdated info - add info about writing docs from Wiki - add info about development setup from docs contribute.md - add info about running tests on Saucelabs / Browserstack TODO: - add link to contributing.md to Contribung page - add link to changelog.md to dropdown in docs -- link to current version changelog entry? Closes angular#7303 Closes angular#9444
- remove outdated info - add info about writing docs from Wiki - add info about development setup from docs contribute.md - add info about running tests on Saucelabs / Browserstack TODO: - add link to contributing.md to Contribung page - add link to changelog.md to dropdown in docs -- link to current version changelog entry? Closes angular#7303 Closes angular#9444
- remove outdated info - add info about writing docs from Wiki - add info about development setup from docs contribute.md - add info about running tests on Saucelabs / Browserstack TODO: - add link to contributing.md to Contribung page - add link to changelog.md to dropdown in docs -- link to current version changelog entry? Closes angular#7303 Closes angular#9444
- remove outdated info - add info about writing docs from Wiki - add info about development setup from docs contribute.md - add info about running tests on Saucelabs / Browserstack TODO: - add link to contributing.md to Contribung page - add link to changelog.md to dropdown in docs -- link to current version changelog entry? Closes angular#7303 Closes angular#9444
- remove outdated info - add info about writing docs from Wiki - add info about development setup from docs contribute.md - add info about running tests on Saucelabs / Browserstack TODO: - add link to contributing.md to Contribung page - add link to changelog.md to dropdown in docs -- link to current version changelog entry? Closes angular#7303 Closes angular#9444
CONTRIBUTING.md - focus on basic info about issues and pull requests for new contributors - move development heavy info to DEVELOPERS.md + add links - remove outdated info DEVELOPERS.md - contains info about project setup, coding rules, and commit message guidelines from CONTRIBUTING.md - add and update info about writing docs from Wiki - add info about development setup from docs contribute.md - add info about running tests on Saucelabs / Browserstack Closes #7303 Closes #9444 Closes #16297
CONTRIBUTING.md - focus on basic info about issues and pull requests for new contributors - move development heavy info to DEVELOPERS.md + add links - remove outdated info DEVELOPERS.md - contains info about project setup, coding rules, and commit message guidelines from CONTRIBUTING.md - add and update info about writing docs from Wiki - add info about development setup from docs contribute.md - add info about running tests on Saucelabs / Browserstack Closes #7303 Closes #9444 Closes #16297
It's inconsistent that the most part of the docs is on the site, and to see other (quite important) parts, we need to go to GitHub.
The text was updated successfully, but these errors were encountered: