---
title: "Editing Workflow"
canonical: "https://documentation.chaos.com/space/DOCSGUIDE/681803805/Editing%20Workflow"
format: markdown
---
This page provides information on the editing process the PDIX team follows when updating the documentation.


## **Editing Workflow**

---

> ℹ️ Always work in the offline space. If you have doubts about which is the offline space, check the URL: (<u>[docs-chaos.atlassian.net](http://docs-chaos.atlassian.net/)</u> / display / VRAYxxx**4EDIT**/ ... ) – it contains the "4EDIT" part.



**Tech edit and validation** – Ensure the new content is correct and accurate. Focus on the content clarity and accuracy. Screenshots are checked, workflows validated.

**Layout **– Ensure the layout guidelines are followed. Focus on design choices being enforced here, image placement, proper line spacing, margins for page layout, etc.

**Page validation** – This quick pass makes sure links, anchors, embedded images, Confluence features are all working properly for non-logged-in users.

> Macro (anchor)



> ℹ️ Be careful not to publish a page that contains information intended for a release before the release date. Always check with colleagues!
> ℹ️ 
> ℹ️ If your change is small, but it concerns a page that is prepared for the next release, there is a workaround. You can make the change in the offline space, and then add the same change in the online space. This way, your small change is reflected for users, while other edits that should not be public remain only in the OFFLINE page.


## **Jira Automated Workflow**

---


![image](media://6a3ff9dc-9b3a-4853-a04f-eaa03c9c4daa)

Please, refer to the [Jira Workflows page](https://docs-chaos.atlassian.net/wiki/spaces/DOCSGUIDE/pages/113289260) for more details on the Jira workflows that the PDIX team follows and the Jira terminology.