Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.
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

@thorn0

Description

@thorn0

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.

Activity

petebacondarwin

petebacondarwin commented on Oct 6, 2014

@petebacondarwin
Contributor

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

btford

btford commented on Oct 6, 2014

@btford
Contributor

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

added this to the Backlog milestone on Oct 6, 2014
petebacondarwin

petebacondarwin commented on Oct 7, 2014

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

ilanbiala commented on Dec 6, 2015

@ilanbiala

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

petebacondarwin commented on Dec 6, 2015

@petebacondarwin
Contributor

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

Narretz

Narretz commented on Dec 7, 2015

@Narretz
Contributor

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

ilanbiala commented on Dec 7, 2015

@ilanbiala

@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

Narretz commented on Dec 7, 2015

@Narretz
Contributor

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" notifications@github.com:

@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

wesleycho commented on Jun 12, 2016

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

petebacondarwin commented on Jun 12, 2016

@petebacondarwin
Contributor

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

self-assigned this
on Oct 4, 2017

9 remaining items

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

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions

    docs(changelog): export the changelog and contributing.md to the site · Issue #9444 · angular/angular.js