Starting a new release

To be able to start on a new documentation release there are a number of things to be done.

1. create a new branch for the documentation
2. copy all docs from the previous branch to the new one
3. create a new 'site' for the new branch
4. add a link to it from the 'document releases overview'

possibly at a later time:

5. change the link for the 'current release docs' to this new one

For some of the above steps you will need to be 'administrator' and even have system level access to the machine running this.

Some more detail on these steps

create a new branch for the documentation

• Take up the 'Administration role' from the 'Role' menu-option.
• Then via the menu go to  Adminstration , and there to  Branch | New
• Add a new branch name, take the pattern docs-{M}_{m} where {M} and {m} should be replaced with major resp. minor version number of the restlet docs you want to create.
  (e.g. docs-1.1)

copy all docs from the previous branch to the new one

We assume that all docs for this new release should start off from their current release.
After this step each of the current docs will have a new variant that lives seperately from the current one. In other words: changes to any content or structuring in this new 'branch' of the docs will be independent from the one you start from now.

The steps to follow:

1. select all documents from the documentation branch you want to start from by using the Query-Search page (menu: Tools | Querysearch)
   The query to select the docs should look like:
   

   select link, branch, language where InCollection('docs') and branch = '{currentbranch}' and language = 'en'

2. Use the button below the resultset to [Add the documents to your document basket]
3. From the basket-page take "Start a document task on the documents in the basket"
1. On step one you can just "next>" or add more documents with more queries
2. On step two you should:
1. Add a description "creating docs branch 1.1"
2. Switch the task-type to "simple actions"
3. [Add] a task and configure it to be "Create Variant" with the options set to:
1. new branch: the new branch that was created e.g. docs-1_1
2. new language: 'en'
3. start version: 'last'
4. Start the task.

These kind of tasks are executed in a background thread so you don't need to stay online for it to happen completely.  Just go to the document-tasks page regularly to check if things have completed succesfully or not.

create a new 'site' for the new branch

This step requires system level access to the system running this documentation service.

1. Move into the correct directory:
   

   $ cd data/restlet.org/dsy-wiki/sites/

2. Copy the sites directory:
   

   $ cp -R docs_${PREVIOUS}/ docs_${NEXT}/

3. Edit the new site-config
   

   $ vi docs_1.1/siteconf.xml

• look for the <branch> entry and change it to the new one!
• and change the <title> and <description> accordingly

add a link to it from the 'document releases overview'

Go to the page 'document releases overview' and add a link to the new release.
Note the links on that page need to point to the specific variant, they typically look like this:

daisy:2-restlet@docs-1_1:en

change the link for the 'current release docs' to this new one

Only do the following steps when this at the time this new 'release' becomes the 'current' release. 
In other words: if you're starting all of the above in preparation of the next release, you might want to wait some more before actually promoting it to be the 'current' one.

Edit the Main navigation document, and change URL for the link-node labeled 'Current Documentation Release' to point to the new site.