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

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
Contributor

What is the actual way of releasing a new version to start with?

  • I can see the last wiki revision is v5.5, nonetheless the most recent linked json from the wiki is v5.6
  • While the uptodate release tagging is being done on @mozilla/server-side-tls(tags) its actual json content stopped in the v5.0 days: @mozilla/server-side-tls(gh-pages): /json/should be maybe retired or cross-referenced to where they live now for posterity?
  • The current versions are in this repo @mozilla/ssl-config-generator(master): /src/static/guidelines/ being served via /docs deploy so this is probably where they're stored. Is this also the place where they get authored? (And accept PRs for them etc.? Can't find this exact info anywhere, as I'm under the impression that "this is just the configuration tool, for the guidelines go somewhere else" and vice versa… at which point I'm not sure I'm in the right place for the actual json specs).
  • However this repo doesn't tag or do releases, and primarily focuses on the tool itself (via its repo readme etc., from my perception of things; think developer experience, coming to the project as an outsider like myself) so maybe to tag & release the guideline revisions here: make it a more focal point (more official/visible maybe?) part of this tool? In a way that actually any useful output and utilisation of the generator stems from the underlying guideline version, so maybe they can be versioned together? (v5.x for the specs, v5.x.y for the generator updates?)

This can all be improved with a handful of readme updates I guess, let me know if I should propose a few developer-experience-related microcopy additions to maybe address the doubts I had when trying to orientate myself.

PS: None of the places I've mentioned (and visited) has a changelog what's actually the guideline revision difference, addition, feature etc. — there's something in the wiki history, something in the commit logs, something in the wiki repo tags… but having a Releases page here with the amalgamated release notes would be the 💣 ;)

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

No branches or pull requests

3 participants