Wiki source code of Save the Changes
Last modified by Eleni Cojocariu on 2026/03/19 07:54
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | == Minor Changes == | ||
| 6 | |||
| 7 | Sometimes you will encounter small issues in the documentation. Examples of minor changes include: | ||
| 8 | |||
| 9 | * Grammar or spelling errors | ||
| 10 | * Typing errors | ||
| 11 | * Broken links | ||
| 12 | * Revising or slightly rephrasing texts for clarity | ||
| 13 | * Other small, low-impact fixes that don't affect the overall structure or meaning of the page | ||
| 14 | |||
| 15 | Such bugs should be fixed directly on the page, without creating a [[Change Request>>||anchor="HSaveNewChangeRequests"]]. You don't need approval, just fix them :) | ||
| 16 | |||
| 17 | When making minor edits, please remember to: | ||
| 18 | |||
| 19 | * Mark the changes as "minor". This way you don't send notifications to people following that page (by IRC, mail or RSS) each time you make a minor addition. | ||
| 20 | * Write a short summary describing the fix (e.g., "fixed typo", "fix broken link" etc.). | ||
| 21 | * It's preferable to click "Preview" when [[editing a page with the Wiki editor>>xwiki:documentation.xs.user.base.page.edit-page.edit-wiki-editor.WebHome]] to view your changes before you save the document. This prevents saving incorrect content and sending "spam" notifications to people who explicitly configured their settings to receive minor ones. | ||
| 22 | |||
| 23 | == Major Changes == | ||
| 24 | |||
| 25 | Major changes are edits that impact the structure, organization or content of the documentation. Examples include: | ||
| 26 | |||
| 27 | * Creating new documentation (documenting a new feature or adding content to an existing feature). | ||
| 28 | * Refactoring a documentation page to follow the new [[migration steps>>dev:Community.DocGuide.MigrateDocumentation.WebHome]] of the Documentation Guide. | ||
| 29 | * Restructuring navigation, moving content between locations, reorganizing sections. | ||
| 30 | * Updating many pages at once. | ||
| 31 | |||
| 32 | == Automatic Documentation Checks on Save == | ||
| 33 | |||
| 34 | Once you save a page that has the documentation object class attached, certain [[checks>>xwiki:documentation.extensions.user.documentation.documentation-xwiki-org.xwiki-org-checks.WebHome]] are automatically performed. These checks will help identify whether the page you saved contains any [[violations of the doc guide>>xwiki:documentation.extensions.user.documentation.create-documentation-page.documentation-checks.WebHome]]. If any issues are found, you will be able to see them directly, allowing you to address them before proceeding further. | ||
| 35 | |||
| 36 | == Save with Change Request == | ||
| 37 | |||
| 38 | Major edits you are unsure of may be saved with [[Change Request>>extensions:Extension.Application Change Request - UI.WebHome]], so that they can be properly reviewed and validated by the Documentation Team before being published. You may also ask for feedback on the [[XWiki forum>>dev:Community.Discuss]] or [[Chat>>dev:Community.Chat]], or re-check the documentation guide before starting. | ||
| 39 | |||
| 40 | You can: | ||
| 41 | |||
| 42 | * [[request creation of a new Page>>xwiki:documentation.extensions.user.change-request.request-page-creation.WebHome]] if you don't have [[edit rights>>xwiki:Documentation.UserGuide.Features.RightsManagement]], or | ||
| 43 | * [[create change requests>>xwiki:documentation.extensions.user.change-request.create.WebHome]]. | ||
| 44 | |||
| 45 | == Existing Change Requests == | ||
| 46 | |||
| 47 | When [[saving with a change request>>xwiki:documentation.extensions.user.change-request.create.save.WebHome]], you can choose whether to group your changes with an [[existing change request or create a new one>>xwiki:documentation.extensions.user.change-request.create.new-existing-change-requests.WebHome]]. Currently, to do check if there are existing Change Request on a Page, you need to view the "Change Request" tab at the bottom of the page. For example: | ||
| 48 | |||
| 49 | ((( | ||
| 50 | {{image reference="ChangeRequestTab.png" size="extra"/}} | ||
| 51 | ))) | ||
| 52 | |||
| 53 | Soon there will be also a [[banner/warning on the page>>https://jira.xwiki.org/browse/CRAPP-54]] to make this option more visible. | ||
| 54 | |||
| 55 | === Save New Change Request === | ||
| 56 | |||
| 57 | If the Page you are editing has in the "Change Request" tab only "Published" change requests or doesn't have any change request, create a [[new change request>>xwiki:documentation.extensions.user.change-request.create.new-existing-change-requests.WebHome]]. | ||
| 58 | |||
| 59 | === Adding Changes to Existing Change Request === | ||
| 60 | |||
| 61 | If the changes are related to an existing change request, or are concerning a page that already has an opened change request (e.g., you are moving content from a page to another, or convert an old doc page to the new doc guide) put the changes in the same change request so it's easier to review and publish the changes in the pages altogether. For this, select an [[existing change request>>xwiki:documentation.extensions.user.change-request.create.new-existing-change-requests.WebHome]]. | ||
| 62 | |||
| 63 | === Edit Change Requests === | ||
| 64 | |||
| 65 | After saving an edit with change request, you can [[edit change requests>>extensions:Extension.Application Change Request - UI.WebHome||anchor="HEditchangerequests"]] and [[inspect changes in the rendered diff>>extensions:Extension.Application Change Request - UI.WebHome||anchor="HDiff"]] before saving other edits. |
