Clean up documentation Change-Id: I496131edd3e05860c515149bcc2cf2337219fe4b
diff --git a/src/main/resources/Documentation/about.md b/src/main/resources/Documentation/about.md index 96f17ea..2060215 100644 --- a/src/main/resources/Documentation/about.md +++ b/src/main/resources/Documentation/about.md
@@ -81,3 +81,5 @@ * TODO: include an external manifest DTD or XML schema/XSD * TODO add test verify manifest that can cause circular conditions * TODO sub dir include manifest have same level include working + +
diff --git a/src/main/resources/Documentation/build.md b/src/main/resources/Documentation/build.md new file mode 100644 index 0000000..d781992 --- /dev/null +++ b/src/main/resources/Documentation/build.md
@@ -0,0 +1,13 @@ +Build +===== + +Maven +----- + +``` +mvn clean package +``` + +[Back to @PLUGIN@ documentation index][index] + +[index]: index.html \ No newline at end of file
diff --git a/src/main/resources/Documentation/cmd-branch.md b/src/main/resources/Documentation/cmd-branch.md index d5c7899..e0beebb 100644 --- a/src/main/resources/Documentation/cmd-branch.md +++ b/src/main/resources/Documentation/cmd-branch.md
@@ -49,26 +49,26 @@ EXAMPLES -------- -Branch all projects on the server described in the `default.xml` manifest in +Branch all projects on the server described in the `default.xml` manifest in commit 5f51acb585b6a of repo `demo/build_manifest` to branch `releases/1.0.0` + ``` ssh -p @SSH_PORT@ @SSH_HOST@ @PLUGIN@ branch -r demo/build_manifest -c 5f51acb585b6a -p default.xml -b releases/1.0.0 - ``` -Branch all projects on the server described in the `default.xml` manifest in +Branch all projects on the server described in the `default.xml` manifest in commit v0.9-15-g5f51acb of repo `demo/build_manifest` to branch `releases/1.0.0` -and create a new manifest with path `releases/1.0.0.xml` in repository +and create a new manifest with path `releases/1.0.0.xml` in repository `project/manifest` branch `master`. ``` ssh -p @SSH_PORT@ @SSH_HOST@ @PLUGIN@ branch -r demo/build_manifest -c v0.9-15-g5f51acb -p default.xml -b releases/1.0.0 -nr project/manifest -nb master -np releases/1.0.0.xml -cs - ``` -In the following charts, commit 'c' is v0.9-15-g5f51acb. +In the following charts, commit 'c' is v0.9-15-g5f51acb. With -cs: + ``` a---b---c---d---e master \ @@ -76,6 +76,7 @@ ``` Without -cs: + ``` a---b---c---d---e master \ @@ -85,3 +86,8 @@ SEE ALSO -------- * [@PLUGIN@ tag SSH command](cmd-tag.md) + +[Back to @PLUGIN@ documentation index][index] + +[index]: index.html +
diff --git a/src/main/resources/Documentation/cmd-show.md b/src/main/resources/Documentation/cmd-show.md index 0ef5ad0..b9f0df7 100644 --- a/src/main/resources/Documentation/cmd-show.md +++ b/src/main/resources/Documentation/cmd-show.md
@@ -14,3 +14,7 @@ ACCESS ------ Caller must be a member of the privileged 'Administrators' group + +[Back to @PLUGIN@ documentation index][index] + +[index]: index.html \ No newline at end of file
diff --git a/src/main/resources/Documentation/cmd-tag.md b/src/main/resources/Documentation/cmd-tag.md index c32fdcd..e1a70da 100644 --- a/src/main/resources/Documentation/cmd-tag.md +++ b/src/main/resources/Documentation/cmd-tag.md
@@ -35,17 +35,21 @@ EXAMPLES -------- Tag all projects on the server described in the `default.xml` manifest in commit 5f51acb585b6a of repo `demo/build_manifest` to tag `releases/1.0.0` + ``` ssh -p @SSH_PORT@ @SSH_HOST@ @PLUGIN@ tag -r demo/build_manifest -c 5f51acb585b6a -p default.xml -t releases/1.0.0 - ``` Tag all projects on the server described in the `default.xml` manifest in commit v0.9-15-g5f51acb of repo `demo/build_manifest` to tag `releases/1.0.0` + ``` ssh -p @SSH_PORT@ @SSH_HOST@ @PLUGIN@ tag -r demo/build_manifest -c v0.9-15-g5f51acb -p default.xml -t releases/1.0.0 - ``` SEE ALSO -------- * [@PLUGIN@ branch SSH command](cmd-branch.md) + +[Back to @PLUGIN@ documentation index][index] + +[index]: index.html
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md index 78c3ce4..b49f65f 100644 --- a/src/main/resources/Documentation/config.md +++ b/src/main/resources/Documentation/config.md
@@ -8,4 +8,8 @@ branch = "master" ``` -There should be only one value for store. More than one value for branch. \ No newline at end of file +There should be only one value for store. More than one value for branch. + +[Back to @PLUGIN@ documentation index][index] + +[index]: index.html \ No newline at end of file
diff --git a/src/main/resources/Documentation/rest-api-branch.md b/src/main/resources/Documentation/rest-api-branch.md index 5a9f2ae..ec4ea4b 100644 --- a/src/main/resources/Documentation/rest-api-branch.md +++ b/src/main/resources/Documentation/rest-api-branch.md
@@ -79,3 +79,7 @@ SEE ALSO -------- * [/tag REST endpoint](rest-api-tag.md) + +[Back to @PLUGIN@ documentation index][index] + +[index]: index.html
diff --git a/src/main/resources/Documentation/rest-api-tag.md b/src/main/resources/Documentation/rest-api-tag.md index 4b0a7a5..70e1b93 100644 --- a/src/main/resources/Documentation/rest-api-tag.md +++ b/src/main/resources/Documentation/rest-api-tag.md
@@ -75,3 +75,7 @@ SEE ALSO -------- * [/branch REST endpoint](rest-api-branch.md) + +[Back to @PLUGIN@ documentation index][index] + +[index]: index.html \ No newline at end of file
diff --git a/src/main/resources/Documentation/test.md b/src/main/resources/Documentation/test.md index ef3f94a..74c8b39 100644 --- a/src/main/resources/Documentation/test.md +++ b/src/main/resources/Documentation/test.md
@@ -67,3 +67,7 @@ These snapshot manifests should be updated: * m/master/default.xml * m/master/subdir/default.xml + +[Back to @PLUGIN@ documentation index][index] + +[index]: index.html \ No newline at end of file