cogAllow to request changes in pages that needs approval to be published.
TypeXAR
CategoryApplication
Developed by

Simon Urli

Active Installs1
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Compatibility

XWiki 13.6+

Installable with the Extension Manager

Description

This extension is under heavy development, it's advised to wait a version 1.0 before using it in production: it should only be used for testing the features right now. Also note that on the first versions it's possible to break the way data are stored from one version to another.

This extension allows to request changes on a page without publishing them right away: people have to approve the changes to publish them.

Usage

 

Create change request

Users who don't have edit rights, can now edit pages by using the button available instead of the edit menu for them. The editor then do not display the usual save buttons, but provide a "Save as change request" button, which opens a window where to fill the title and description of the change request for saving it. 

Users who have edit rights, can also save their editions as a change request by using the same "Save as change request" button available in the editor, along with the other save buttons. When saving as change request, it's possible to either create a new change request, or add the changes to an existing change request. Note that when creating a new change request it's possible to mark it as "Draft": setting this status will prevent the change request to be reviewed until you mark it as ready.

Find change requests

It's possible to get a list of all change requests by accessing the change request application.
It's also possible to see the change requests containing modification for a specific page, by looking on the dedicated tab on the bottom of the page

Edit change requests

It's possible to edit a change requests for performing three different actions: changing the status of the change request, editing the documents to perform other changes, or fixing conflicts. 

Change the status

There is currently 4 different status for a change request:
  - draft: this is used when a change request is still a work in progress. In that state it cannot be merged or reviewed.
  - ready for review: as it indicates, this is used when the change request can be reviewed or merged. It's still possible to also edit the files.
  - merged: this status indicates that the change request has already been merged, so no more action are possible on it.

The status is set to merged automatically when merging the change request. Now an author can set a change request to Draft or Ready for review manually depending on the need. The button for changing the status is under the "Checks" tab of the change request.

Edit documents

Fix conflicts

Review change requests

Merge change requests

In this first version, it's possible to merge a change request by following the link provided on the change request pages. Note that this link is shown only if the change request can be merged, which is true if the following conditions are met:
  - the current user has edit rights on the page targeted by the change request
  - the current user has Approve Change Request right on the same page
  - there is no conflict for merging the changes

Notifications

Create change request

It's possible to receive notifications when a new change request is created on a watched page, the notification has to be enabled first from the notification settings.

Edit change request

0.3+ It's possible to receive notifications when a watched page is edited and  the modifications added in an existing change request, the notification has to be enabled first from the notification settings.

Administration

Rights

Two rights are provided by this extension:

  • Change Request right: this right is allowed by default, and it enables the capability to create a change request
  • Approve Change Request right: this right is denied by default, it allows people to merge a change request, to publish the changes. 

Approval strategies

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Release Notes

v0.4

v0.3

v0.2

v0.1

Dependencies

Dependencies for this extension (org.xwiki.contrib.changerequest:application-changerequest-ui 0.4):

  • org.xwiki.contrib.changerequest:application-changerequest-default 0.4
  • org.xwiki.contrib.changerequest:application-changerequest-notifications 0.4
Tags:
Created by Simon Urli on 2021/06/29 16:27
    

Get Connected