docs: version release documentation with step-by-step instructions #393
Conversation
✅ Deploy Preview for stupendous-kringle-a86e81 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Version release guide.md
Outdated
| "code": "es", | ||
| "name_local": "Español", | ||
| "direction": "ltr" | ||
| // "hidden": true was removed to make Spanish visible | ||
| }, | ||
| { | ||
| "code": "hi", | ||
| "name_local": "हिन्दी", | ||
| "direction": "ltr" | ||
| // New language added |
There was a problem hiding this comment.
I find this a bit confusing because the comments are in reference to the current state of languages.json in 2.0. It might be better to update the sample languages.json above so the changes and comments here are in reference to that
Version release guide.md
Outdated
| git merge X.Y-translations | ||
|
|
||
| # Push the updated main branch | ||
| git push origin main |
There was a problem hiding this comment.
we definitely should not push to main, I think there are rules in place to prevent it but even if there weren't that should be a PR.
| ```bash | ||
| # Add your changes | ||
| git add . | ||
|
|
||
| # Commit with a clear message | ||
| git commit -m "Release X.Y: Update version references and language settings" | ||
|
|
||
| # Push to the translation branch | ||
| git push origin X.Y-translations | ||
| ``` |
There was a problem hiding this comment.
for visibility it might be better to have this done in a prepare-release branch (or whatever name we like) and then open a PR into main so main is updated from the get-go and we then create tag and release branch from main. That being said, I am not so familiar with the workflows in this repo so @aterrel should probably weigh in.
There was a problem hiding this comment.
Waiting for @aterrel’s comment before making changes.
|
I just realized it might be nice to use |
Yeah, I like it. Using pip-compile would lock dependencies for each translation branch, so we can reliably rebuild old versions of the site without worrying about newer package changes causing breakages. |
|
This pull request has been inactive for 30 days. It will be closed in 14 days if no further activity occurs. |
3 participants
Overview
This PR introduces a detailed step-by-step guide to help maintainers efficiently release new versions of the DISCOVER Cookbook with proper versioning and multi-language support.
Changes
Version release guide.mdwith a comprehensive release workflow.Key Features
Documentation Structure
X.Y-translationspattern).versions.json,languages.json).This documentation will streamline the release process and ensure consistent, error-free version deployments across the project.
Checklist