|
1 | | -= CalConnect Conference and IOP Testing Reports |
| 1 | += CalConnect administrative documents |
2 | 2 |
|
3 | | -This repository contains CSD sources, and gets rendered into a Relaton collection mini-site. |
| 3 | +This repository contains CalConnect administrative document sources. |
4 | 4 |
|
5 | | -image:https://travis-ci.com/CalConnect/csd-admin-documents.svg?branch=master["Build Status", link="https://travis-ci.com/CalConnect/csd-admin-documents"] |
| 5 | +image:https://github.com/CalConnect/cc-admin-documents/workflows/docker/badge.svg["Docker Build Status", link="https://github.com/CalConnect/cc-admin-documents/actions/workflows/docker.yml"] |
6 | 6 |
|
7 | | -== Access |
| 7 | +Published documents are available here: |
8 | 8 |
|
9 | | -Documents in this repository are available through the deployed mini-site: |
| 9 | +* https://calconnect.github.io/cc-admin-documents/[CalConnect Conference and IOP Testing Reports] |
10 | 10 |
|
11 | | -* https://calconnect.github.io/csd-admin-documents/[CalConnect Conference and IOP Testing Reports] |
12 | 11 |
|
| 12 | +== Purpose |
13 | 13 |
|
14 | | -== Fetching the documents |
| 14 | +This repository holds the Metanorma source markup for CalConnect |
| 15 | +administrative documents. |
| 16 | + |
| 17 | +These documents include: |
| 18 | + |
| 19 | +* CalConnect Conference Reports (and associated documents) |
| 20 | +* CalConnect IOP Testing Reports |
| 21 | +* CalConnect Advisory Notices |
| 22 | + |
| 23 | +NOTE: These administrative documents, prior to 2024, were published in PDF |
| 24 | +format only. This repository contains the re-encoded documents in the Metanorma |
| 25 | +format in order to facilitate future updates and publication in multiple |
| 26 | +formats. |
15 | 27 |
|
16 | | -[source,sh] |
17 | | ----- |
18 | | -git clone https://github.com/CalConnect/csd-admin-documents |
19 | | ----- |
20 | 28 |
|
21 | | -== Install Build Tools |
| 29 | +== Structure |
22 | 30 |
|
23 | | -See https://www.metanorma.com/[Metanorma setup]. |
| 31 | +The repository is structured as follows: |
24 | 32 |
|
| 33 | +`metanorma.yml`:: Metanorma site manifest that lists the documents to be |
| 34 | +included in the site. |
25 | 35 |
|
26 | | -== Build |
| 36 | +`sources/`:: Source documents in Metanorma format. |
| 37 | + |
| 38 | +`sources/cc-{docnumber}-{title}`:: Directory for each document, named by |
| 39 | +document number and a shorthand title. |
| 40 | + |
| 41 | +`sources/cc-{docnumber}-{title}/document.adoc`:: Metanorma root document for |
| 42 | +the document. |
| 43 | + |
| 44 | + |
| 45 | +== Fetching the document |
27 | 46 |
|
28 | 47 | [source,sh] |
29 | 48 | ---- |
30 | | -make clean all |
| 49 | +git clone https://github.com/CalConnect/cc-admin-documents/ |
31 | 50 | ---- |
32 | 51 |
|
33 | | -== Open the generated HTML index |
| 52 | + |
| 53 | +== Installing build tools |
| 54 | + |
| 55 | +See https://www.metanorma.org/install/ |
| 56 | + |
| 57 | + |
| 58 | +== Building the documents |
| 59 | + |
| 60 | +=== Full set |
| 61 | + |
| 62 | +Run the following command to build the full collection of the documents. |
34 | 63 |
|
35 | 64 | [source,sh] |
36 | 65 | ---- |
37 | | -open documents.html |
| 66 | +$ bundle exec metanorma site generate --agree-to-terms |
38 | 67 | ---- |
39 | 68 |
|
40 | | -== Publish |
| 69 | +=== Single document |
| 70 | + |
| 71 | +Run the following command to build a single document. |
41 | 72 |
|
| 73 | +.Compile a single document |
42 | 74 | [source,sh] |
43 | 75 | ---- |
44 | | -make publish |
| 76 | +$ bundle exec metanorma sources/cc-1903-report-conference-46/document.adoc |
45 | 77 | ---- |
46 | 78 |
|
47 | | -The generated HTML site will be prepared in `published/`. |
| 79 | +=== Outputs |
| 80 | + |
| 81 | +The following outputs will be built: |
| 82 | + |
| 83 | +Index of all documents:: `_site/index.html` |
| 84 | + |
| 85 | +Individual document outputs:: `_site/documents/` (HTML, PDF, MN XML) |
| 86 | + |
| 87 | + |
| 88 | +== License |
48 | 89 |
|
| 90 | +Copyright CalConnect. |
0 commit comments