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

Document best way for users to get notifications about new guideline versions #78

Open
gene1wood opened this issue Jan 28, 2020 · 2 comments · May be fixed by #255
Open

Document best way for users to get notifications about new guideline versions #78

gene1wood opened this issue Jan 28, 2020 · 2 comments · May be fixed by #255
Assignees
Labels
usability Affordance, experience & UI woes

Comments

@gene1wood
Copy link
Collaborator

Add to the docs and site a recommendation about how an administrator that uses the generator to, down the road, get a notification when a new version of the guidelines are released so they can come back and get an update to their generator config.

@april april changed the title Document best way for users to get notifications about new guidlines versions Document best way for users to get notifications about new guideline versions Jan 28, 2020
@nemchik
Copy link

nemchik commented Jun 17, 2020

#97 possible solution. If releases are tagged here any user can subscribe to release notifications.

@janbrasna
Copy link
Collaborator

janbrasna commented May 12, 2022

There is a changelog describing the actual recommendations version changes buried in src/*/guidelines alongside the JSONs — that I'm adding in #255 to the main readme for better visibility.

In #97 I've tagged all the JSON releases to point to the exact version in history, so they can be referenced now, and will also be publishing new versions via "Releases" as the official channel for folks to follow easily.

I'm contemplating a new versioning scheme, where the recommendations and the configs are versioned together (as the latter depend on the former) — in a way that actually any useful output and utilisation of the generator stems from the underlying guideline version, so maybe we can include releases for both (v5.x for the specs, v5.x.y for generator updates) in one timeline?

I will be moving this to a broader discussion, if that major+minor for specs and patch for generator changes works for us, and mainly for the consumers and community in the first place.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
usability Affordance, experience & UI woes
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants