1.4. Obtaining and updating the documentation source

Currently the source of both the GDA Developer Guide (this document) and GDA User Guide are contained in DLS Gerrit at https://gerrit.diamond.ac.uk/admin/repos/gda/gda-documentation. It is from this repostitory that the publically available GDA Guide websites, made available on https://alfred.diamond.ac.uk/documentation, are created.

When pushing documentation changes to the gda-documentation repository you are to add (as a minimum) the following as reviewers:

  • Your team lead

  • Keith Ralphs

For information regarding use of Gerrit please see section Gerrit Setup in this document, specifically section Uploading a new change for review includes details of how to add reviewers.

Older versions of the documentation are contained in gda-core, that is, after materialising GDA, the old documentation is located in the directory: {workspace_git}/gda-core.git/documentation.gda.

The documentation was moved out of gda-core in 2019 at the start of a major update to its contents, in the future (following completion of the initial phase of re-development) the documentation source may be moved back into gda-core.