--- title: "Release Steps" canonical: "https://documentation.chaos.com/space/DOCSGUIDE/113290287/Release%20Steps" format: markdown --- For every major release, i.e., update or new major version, there are several checkpoints that the Docs team needs to oversee.  > Macro (toc) ### **Release chat** If you are the owner of the release documentation, ensure you are in the corresponding release chat. Important information is shared there, including the release plan and the steps to follow on the release day. If you are not in the chat, please contact the Dev Collaboration team. ### **Dev Collaboration team** Make sure you know who is the owner of the release. They are your best buddy until the day of the release! This is the source of truth and more often, first point of contact for every question.  ### **JIRA** In the Documentation project, make sure that the correct Fix Version is present. All JIRA issues related to the release must be tagged with the corresponding Fix Version. You can locate all relevant JIRA issues by filtering for this version. It is recommended to review the progress of all JIRA issues and aim to have each one at least in QA status before the release. (Of course, this may not always be possible due to external circumstances.) After the documentation is published, all corresponding *publishable* issues have to be closed. Separately, the Dev Collaboration team creates an Epic issue for the release, which includes three (sometimes two) documentation issues: one for the Green Light, one for updating the documentation, and one for publishing it. ### **Marketing Content** What’s New page: Once the What's New page is ready on the main website, copy its visual content to a new What's New page in the documentation. Use the same renders, but DO NOT copy the text descriptions. We shouldn't copy text content from the website as google rates us badly. Link the titles (or the keywords) of the new features to the corresponding documentation pages. For reference, see [What's New in V-Ray 5](https://documentation.chaos.com/space/VMAX/113587845/What's+New+in+V-Ray+5+Release) Replace the banner – the Marketing team usually provides a new one for the documentation. 1. Rename the new banner image using the same filename as the old one. 2. You can find the old banner in the attachments of the landing page for the space. 3. Attach the new banner image to the same landing page. > ⚠️ If there are major changes in the names of pages OR generally links, please notify the Marketing team if these changes concern: > ⚠️ > ⚠️ - Release notes > ⚠️ - What's new > ⚠️ - System requirements > ⚠️ - Tutorials > ⚠️ > ⚠️ They need to know in order to change them on the website/youtube. ### **Others** You might not have a JIRA issue for these, but always bear in mind: - Release notes - EULA - the link should coincide 1:1 with the one on the chaos.com - Permissions - see if something needs to be allowed to be seen - Proofread release notes when requested by PM/QA - Request the features list from the product manager early on in the Release Syncs. This way you can follow what the major topics you have to work on are. - QAs will not always have the capacity to check all of your issues. Make sure the major features are checked for their technical quality and bug fixes, small additions and UI updates can be left to be checked for after the release. - Remember to archive the current ONLINE space as an HTML file and upload it to the Archived Versions page for the current product. ### **Release Day** Provide Green Light when everything is set up and checked by QA. More often than not, there will be plenty of things that are not proofread. For the time being, provide Green Light and publish only the Release notes and the What's New Page. --- Once QAs are ready with the issues and have approved them, you can [sync ](https://docs-chaos.atlassian.net/wiki/spaces/DOCSGUIDE/pages/113290248)the whole space. > ℹ️ Archive the current online version in a .zip file BEFORE you publish the newest information. Each major version should be archived and set for download. > ⚠️ **TROUBLESHOOTING**: > ⚠️ > ⚠️ After syncing, if the page tree has missing pages or is broken beyond just a couple of pages being in the wrong place, this might be due to the remaining items in the trash. Delete the trash from the ONLINE version of the space and start a new sync. This could fix the page tree. ### **After the sync: ** > ✅ Always open the online space in an incognito browser and go through it! You'll see if there are any missing pages, locked content, missing content, etc. on the spot. - If you have embedded pages into other pages in the page tree, or have just moved already present pages in the page tree, check if they are in the same positions in the online space, as they are in the offline space. If the whole space is not synced when publishing, these changes are not reflected and you need to go in the online space and move the pages manually to match the offline space. ### **After the Release Day** Once all Jira tickets for a given release are closed with the resolution **Done**, you can proceed to release and archive the corresponding Fix Version in Jira. Avoid releasing or archiving a version that still contains tickets with a status other than **Done**, as this can lead to issues when searching for tickets and may affect their resolution tracking afterward. If you need to release and archive a Fix Version that still contains unresolved tickets, make sure those tickets are reassigned to another Fix Version when setting the current version’s status to **Released**. ![TechGuide_ArchiveJira.gif](media://2eb7f70f-5555-4ebb-896c-c2c122e9bcc7)