Skip to content

Commit a32201d

Browse files
committed
chore: update README
1 parent 648f7aa commit a32201d

File tree

1 file changed

+62
-20
lines changed

1 file changed

+62
-20
lines changed

README.adoc

Lines changed: 62 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,90 @@
1-
= CalConnect Conference and IOP Testing Reports
1+
= CalConnect administrative documents
22

3-
This repository contains CSD sources, and gets rendered into a Relaton collection mini-site.
3+
This repository contains CalConnect administrative document sources.
44

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"]
66

7-
== Access
7+
Published documents are available here:
88

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]
1010
11-
* https://calconnect.github.io/csd-admin-documents/[CalConnect Conference and IOP Testing Reports]
1211
12+
== Purpose
1313

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.
1527

16-
[source,sh]
17-
----
18-
git clone https://github.com/CalConnect/csd-admin-documents
19-
----
2028

21-
== Install Build Tools
29+
== Structure
2230

23-
See https://www.metanorma.com/[Metanorma setup].
31+
The repository is structured as follows:
2432

33+
`metanorma.yml`:: Metanorma site manifest that lists the documents to be
34+
included in the site.
2535

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
2746

2847
[source,sh]
2948
----
30-
make clean all
49+
git clone https://github.com/CalConnect/cc-admin-documents/
3150
----
3251

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.
3463

3564
[source,sh]
3665
----
37-
open documents.html
66+
$ bundle exec metanorma site generate --agree-to-terms
3867
----
3968

40-
== Publish
69+
=== Single document
70+
71+
Run the following command to build a single document.
4172

73+
.Compile a single document
4274
[source,sh]
4375
----
44-
make publish
76+
$ bundle exec metanorma sources/cc-1903-report-conference-46/document.adoc
4577
----
4678

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
4889

90+
Copyright CalConnect.

0 commit comments

Comments
 (0)