Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

docs(changelog): export the changelog and contributing.md to the site #9444

Closed
thorn0 opened this issue Oct 6, 2014 · 10 comments · Fixed by #16297
Closed

docs(changelog): export the changelog and contributing.md to the site #9444

thorn0 opened this issue Oct 6, 2014 · 10 comments · Fixed by #16297

Comments

@thorn0
Copy link
Contributor

thorn0 commented Oct 6, 2014

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.

@petebacondarwin
Copy link
Contributor

We could easily generate pages using Dgeni from the Markdown in those files.

@btford
Copy link
Contributor

btford commented Oct 6, 2014

I'm for it. @petebacondarwin, any idea where to start?

@btford btford added this to the Backlog milestone Oct 6, 2014
@petebacondarwin
Copy link
Contributor

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.

@ilanbiala
Copy link

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.

@petebacondarwin
Copy link
Contributor

No progress yet. Perhaps a task for over Xmas...

@Narretz
Copy link
Contributor

Narretz commented Dec 7, 2015

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).

@ilanbiala
Copy link

@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.

@Narretz
Copy link
Contributor

Narretz commented Dec 7, 2015

Absolutely. I was just suggesting to use the latest changelog as the source
for all versions. Because the angular docs are usually generated from the
files of each version individually.
Basically, whatever version you have selected in the docs, the cl should
always be generated from the latest version.
Am 07.12.2015 14:44 schrieb "Ilan Biala" [email protected]:

@Narretz https://github.com/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.


Reply to this email directly or view it on GitHub
#9444 (comment)
.

@wesleycho
Copy link
Contributor

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.

@petebacondarwin
Copy link
Contributor

Good idea @wesleycho - anyone want to do a PR?

@Narretz Narretz self-assigned this Oct 4, 2017
Narretz added a commit to Narretz/angular.js that referenced this issue Oct 24, 2017
- 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
Narretz added a commit to Narretz/angular.js that referenced this issue Oct 24, 2017
- 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
Narretz added a commit to Narretz/angular.js that referenced this issue Oct 24, 2017
- 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
Narretz added a commit to Narretz/angular.js that referenced this issue Oct 24, 2017
- 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
Narretz added a commit to Narretz/angular.js that referenced this issue Oct 25, 2017
- 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
Narretz added a commit that referenced this issue Nov 3, 2017
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
Narretz added a commit that referenced this issue Nov 17, 2017
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
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants