Skip to content

Commit b7d9e71

Browse files
callumrollocallumrollo
authored
Add vocabularies webpage built from asciidoc (#199)
* multipage site build and with links from readme * add nav to headers and fix page links * fix links to preliminary vocab tables
1 parent a045662 commit b7d9e71

File tree

4 files changed

+40
-46
lines changed

4 files changed

+40
-46
lines changed

‎.github/workflows/adoc_build.yml

Lines changed: 3 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,15 @@
1-
name: Export and publish document
1+
name: Make pages
22

33
on:
44
workflow_dispatch:
55
push:
66
branches: [ main ]
7-
8-
permissions:
9-
contents: read
10-
pages: write
11-
id-token: write
12-
137
jobs:
148
build:
159
runs-on: ubuntu-latest
16-
environment:
17-
name: github-pages
18-
url: ${{ steps.deployment.outputs.page_url }}
1910
steps:
2011
- uses: actions/checkout@v3
2112
with:
2213
fetch-depth: 0
23-
24-
- name: Generate HTML document
25-
uses: Analog-inc/asciidoctor-action@v1.2.2
26-
with:
27-
shellcommand: "asciidoctor --verbose -D build -o index.html OG_Format.adoc; cp -r figures build/"
28-
- name: Generate PDF document
29-
uses: Analog-inc/asciidoctor-action@v1.2.2
30-
with:
31-
shellcommand: "asciidoctor-pdf --verbose -d book OG_Format.adoc -D build"
32-
33-
- name: Upload artifact
34-
uses: actions/upload-pages-artifact@v3.0.1
35-
with:
36-
path: 'build'
37-
38-
- name: Deploy to GitHub Pages
39-
id: deployment
40-
uses: actions/deploy-pages@main
14+
- name: asciidoctor-ghpages
15+
uses: manoelcampos/asciidoctor-ghpages-action@v2.3.0

‎OG_Format.adoc

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
[cols=",",options="header",]
22
|===========================================================================================
33
|image:figures/image1.png[image,width=164,height=144] a|
4-
OceanGliders 1.0 format - Terms of References
4+
OceanGliders 1.0 format - Terms of References +
5+
6+
Navigation: +
7+
8+
https://github.com/OceanGlidersCommunity/OG-format-user-manual[Github repository] +
9+
https://oceangliderscommunity.github.io/OG-format-user-manual/OG_Format.html[Terms of reference] +
10+
https://oceangliderscommunity.github.io/OG-format-user-manual/vocabularyCollection/tableOfControlledVocab.html[Vocabulary collections] +
511

612
|===========================================================================================
713

@@ -756,7 +762,7 @@ Note 1: PARAMETER information is highly desirable to avoid ERDDAP configuration
756762
* [[geophysical-variables]]
757763
= Geophysical variables
758764
////
759-
= Geophysical variables
765+
== Geophysical variables
760766
"The fill value should have the same data type as the variable and be outside of the range of possible data values."
761767
[cols=",,",options="header",]
762768
|==========================================================================================================================
@@ -852,24 +858,24 @@ It is expected that the vocabulary collections will not always been synchronized
852858

853859
| platform | https://vocab.nerc.ac.uk/collection/L06/current/25/[collection] | https://vocab.nerc.ac.uk/collection/L06/current/25/ | OceanGliders |
854860
| oceangliders_site | *tbd* | *tbd* | OceanOPS |
855-
| contributors_role | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/contributors_role.md[collection] | *tbd* | OceanGliders |
856-
| agencies_role | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/agencies_role[collection] | *tbd* | OceanGliders |
861+
| contributors_role | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/contributors_role.md[collection] | *tbd* | OceanGliders |
862+
| agencies_role | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/agencies_role[collection] | *tbd* | OceanGliders |
857863
| agencies_id | https://edmo.seadatanet.org/[collection] | https://edmo.seadatanet.org/ | SeaDataNet |
858864
| naming_authority | https://edmo.seadatanet.org/[collection] | https://edmo.seadatanet.org/ | SeaDataNet |
859865
| institution | https://edmo.seadatanet.org/[collection] | https://edmo.seadatanet.org/ | SeaDataNet |
860-
| rtqc_method | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/rtqc_method.md[collection] | https://vocab.nerc.ac.uk/collection/L06/current/25/ | OceanGliders |
866+
| rtqc_method | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/rtqc_method.md[collection] | https://vocab.nerc.ac.uk/collection/L06/current/25/ | OceanGliders |
861867
| phase_calculation_methodology | *tbd* | *tbd* | OceanGliders |
862-
| platform_type | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/platform_type.md[collection] | http://vocab.nerc.ac.uk/collection/L06/current/27/ | OceanGliders |
863-
| platform_model | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/platform_model.md[collection] | *tbd* | OceanGliders |
868+
| platform_type | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/platform_type.md[collection] | http://vocab.nerc.ac.uk/collection/L06/current/27/ | OceanGliders |
869+
| platform_model | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/platform_model.md[collection] | *tbd* | OceanGliders |
864870
| ICES_code | https://vocab.ices.dk/?codetypeguid=7f9a91e1-fb57-464a-8eb0-697e4b0235b5[collection] | https://vocab.ices.dk/?codetypeguid=7f9a91e1-fb57-464a-8eb0-697e4b0235b5 | ICES |
865-
| platform_maker | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/platform_maker.md[collection] | *tbd* | OceanGliders |
866-
| battery_type | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/battery_type.md[collection] | *tbd* | OceanGliders |
867-
| telecom_type | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/telecom_type.md[collection] | *tbd* | OceanGliders |
868-
| tracking_system | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/tracking_system.md[collection] | *tbd* | OceanGliders |
871+
| platform_maker | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/platform_maker.md[collection] | *tbd* | OceanGliders |
872+
| battery_type | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/battery_type.md[collection] | *tbd* | OceanGliders |
873+
| telecom_type | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/telecom_type.md[collection] | *tbd* | OceanGliders |
874+
| tracking_system | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/tracking_system.md[collection] | *tbd* | OceanGliders |
869875
| sensor | *tbd* | *tbd* | OceanGliders |
870876
| sensor_model | *tbd* | *tbd* | OceanGliders |
871-
| data_mode | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/data_mode.md[collection] | *tbd* | OceanGliders |
872-
| phase | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/vturpin-patch-3-VocabularyCollectionSection/vocabularyCollection/phase.md[collection] | *tbd* | OceanGliders |
877+
| data_mode | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/data_mode.md[collection] | *tbd* | OceanGliders |
878+
| phase | https://github.com/OceanGlidersCommunity/OG-format-user-manual/blob/main/vocabularyCollection/phase.md[collection] | *tbd* | OceanGliders |
873879
| parameter | *tbd* | http://vocab.nerc.ac.uk/collection/OG1/current/ | OceanGliders |
874880
|===
875881

@@ -953,4 +959,4 @@ Example 7:
953959
* platform: stella_20180207
954960
* Program: MARS Glider program
955961
* Site: no site
956-
* Network: Alter_ECO
962+
* Network: Alter_ECO

‎README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,14 @@
55
Here we review issues related to OceanGliders (OG) format and vocabularies.
66
A discussion section is also available for any question or comment related to OG format and vocabulary.
77

8-
[Here](https://oceangliderscommunity.github.io/OG-format-user-manual/) is the most recent version of the user manual.
8+
The homepage of OG format is at [https://github.com/OceanGlidersCommunity/OG-format-user-manual](https://github.com/OceanGlidersCommunity/OG-format-user-manual)
9+
10+
[Here](https://oceangliderscommunity.github.io/OG-format-user-manual/) is the most recent version of the user manual.
11+
12+
13+
Vocabulary guidance for the OG format is [here](https://oceangliderscommunity.github.io/OG-format-user-manual/vocabularyCollection/tableOfControlledVocab.html)
14+
15+
The history of the format is documented on the [history page](https://oceangliderscommunity.github.io/OG-format-user-manual/history.html)
916

1017
### Example files
1118

@@ -34,3 +41,4 @@ The release is planned for January each year. Issues accepted in September shoul
3441
## Code of Conduct
3542

3643
Please read and follow our [Code of Conduct](https://github.com/OceanGlidersCommunity/OceanGliders/blob/main/CODE_OF_CONDUCT.md).
44+

‎vocabularyCollection/tableOfControlledVocab.adoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
[cols=",",options="header",]
22
|===========================================================================================
3-
|image:figures/image1.png[image,width=164,height=144] a|
4-
OceanGliders 1.0 format - Vocabulary Collections
3+
|image:../figures/image1.png[image,width=164,height=144] a|
4+
OceanGliders 1.0 format - Vocabulary Collections +
55

6-
|===========================================================================================
6+
Navigation: +
7+
8+
https://github.com/OceanGlidersCommunity/OG-format-user-manual[Github repository] +
9+
https://oceangliderscommunity.github.io/OG-format-user-manual/OG_Format.html[Terms of reference] +
10+
https://oceangliderscommunity.github.io/OG-format-user-manual/vocabularyCollection/tableOfControlledVocab.html[Vocabulary collections] +
711

12+
|===========================================================================================
813
////
914
* [[Vocabulary Collections]]
1015
////

0 commit comments

Comments
 (0)