diff --git a/Version release guide.md b/Version release guide.md new file mode 100644 index 000000000..99192855b --- /dev/null +++ b/Version release guide.md @@ -0,0 +1,229 @@ +# DISCOVER Cookbook Version Release Guide + +This guide walks you through the process of releasing a new version of the DISCOVER Cookbook. Follow these steps to ensure a smooth update when a new version is ready. + +## Step 1: Create a X.Y Version Tag and X.Y-translations Branch + +First, create a X.Y version tag and a X.Y-translations branch specifically for the new version. This naming pattern is important - the system automatically detects branches ending with `-translations` and uses the prefix as the version number. + +```bash +# Create and checkout a new branch +git checkout -b X.Y-translations + +# Push the branch to GitHub +git push origin X.Y-translations +``` + +## Step 2: Update Version Configuration Files + +### Update the Versions List + +Edit `DISCOVER/_static/versions.json` to include your new version. + +```json +[ + { + "version": "dev", + "url": "https://discover-cookbook.numfocus.org/dev/" + }, + { + "version": "X.Y", + "url": "https://discover-cookbook.numfocus.org/X.Y/", + "preferred": true + }, + { + "version": "2.0", + "url": "https://discover-cookbook.numfocus.org/2.0/" + }, + { + "version": "1.0", + "url": "https://discover-cookbook.numfocus.org/1.0/" + } +] +``` + +Make sure to: + + * Add your new version entry. + * Move the `"preferred": true` flag to the new version. + * Keep the order from newest to oldest. + +### Update Language Settings + +Edit `DISCOVER/_static/languages.json` to manage available languages. + +```json +[ + { + "code": "en", + "name_local": "English", + "direction": "ltr" + }, + { + "code": "es", + "name_local": "Español", + "direction": "ltr", + "hidden": true // Removed this to make Spanish visible + }, + { + "code": "hi", + "name_local": "हिन्दी", + "direction": "ltr" + } + // Add New language +] +``` + +To manage language visibility and preferences: + + * **Add a new language**: Add a new entry with the language code, local name, and text direction. + * **Make a language visible**: Remove the `"hidden": true` property from any language you want to show. + * **Hide a language**: Add `"hidden": true` to languages that aren't ready for public use. + * **Set default language**: The first non-hidden language is typically used as the default. + +For example, to unhide Spanish and add Hindi: + +```json +[ + { + "code": "en", + "name_local": "English", + "direction": "ltr" + }, + { + "code": "es", + "name_local": "Español", + "direction": "ltr" + }, + { + "code": "hi", + "name_local": "हिन्दी", + "direction": "ltr" + } +] +``` + +> **Note**: When you add a new language, ensure all documentation files have been translated and placed in the appropriate directory in the `locales/` folder (e.g., `locales/hi/LC_MESSAGES/`). See the [`Translation.md`](Translation.md) file for how to update translatable sources. + +## Step 3: Update the Landing Page + +Edit `index.html` to reflect the new version in these sections: + +### Update the Read the Cookbook Button (around line 60) + +```html + + Read the Cookbook +``` + +### Update the Latest Version Section (around line 98) + +Replace the existing "Latest" version card with your new version: + +```html + +
Your comprehensive guide to creating diverse, inclusive, and accessible conferences and events in the tech sector