Skip to content

Commit d5f2c09

Browse files
committed
New document process.
1 parent d33b272 commit d5f2c09

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

700.en.adoc

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ NOTE: This section is technical information for GBIF software developers maintai
66

77
To make a new document:
88

9-
* Create a new repository using the https://github.com/gbif/doc-template[doc-template] template repository (”Use this template”), with a name beginning with `doc-`.
9+
* Create a new repository using the https://github.com/gbif/doc-template[doc-template] template repository (”Use this template”), with a name beginning with `doc-`, or `course-` for a training course.
1010
* Edit the `README.adoc` to update the links, license, DOI etc.
1111
* Set the branch name appropriately (`1.0`), if published versions of the document should be retained
1212
* Add a new job to Jenkins,
@@ -16,24 +16,33 @@ To make a new document:
1616

1717
* Create a new job, based on:
1818
** the existing `doc-template` job, for unversioned documents
19-
** the existing `doc-effective-nodes-guidance` job, for versioned documents
19+
** the existing `doc-test-document` job, for versioned documents
2020

2121
+
2222
You need to change the Git repository paths (“Source Code Management” section)
2323

2424
* Change the `Authentication Token` to something new (“Build Triggers” section)
25-
* Within GitHub, set up a new webhook with the path e.g. `pass:[http://builds.gbif.org/job/doc-XXXXXXXXXXXX/buildWithParameters?token=XXXXXXXXXX]` (with the token from the previous step)
26-
** The secret text seems not to matter
25+
* Within GitHub, set up a new webhook with the path:
26+
+
27+
----
28+
https://builds.gbif.org/job/doc-XXXXXXXXXXXX/buildWithParameters?token=XXXXXXXXXX
29+
----
30+
** The secret text does not matter
2731
** Select the individual events `Pushes` and `Releases`
2832

2933
.Full Jenkins configuration
3034
[%collapsible]
3135
====
3236
These things will have been copied across from the existing build:
3337
38+
* Discard old builds: 15
39+
* GitHub project
3440
* A `payload` parameter to receive information from GitHub.
3541
* *Source Code Management*: Under advanced Git settings, set the branches to build to `origin/*` and `Check out to specific local branch` to `+**+`. This supports versioned documents, and updating the translation index.
36-
* Set a build script, which varies depending whether the document is keeping old versions deployed.
42+
* A build script, either `VERSIONED=true /usr/local/bin/document-build-deploy` or just `/usr/local/bin/document-build-deploy`.
43+
* Git Publisher post-build action: to merge changes to the translation index.
44+
* Set GitHub commit status (so users can see if they have committed invalid syntax).
45+
3746
====
3847

3948
[[translation-setup]]

0 commit comments

Comments
 (0)