Skip to content

Commit 05a11d4

Browse files
committed
chore: update structure
1 parent 6846c5b commit 05a11d4

70 files changed

Lines changed: 423 additions & 11714 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/generate.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: generate
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: true
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
container:
22+
image: metanorma/metanorma:latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
27+
- name: Cache Metanorma assets
28+
uses: actions-mn/cache@v1
29+
30+
- name: Metanorma generate site
31+
uses: actions-mn/build-and-publish@main
32+
with:
33+
token: ${{ secrets.GITHUB_TOKEN }}
34+
agree-to-terms: true
35+
36+
deploy:
37+
if: ${{ github.ref == 'refs/heads/main' }}
38+
environment:
39+
name: github-pages
40+
url: ${{ steps.deployment.outputs.page_url }}
41+
runs-on: ubuntu-latest
42+
needs: build
43+
steps:
44+
- name: Deploy to GitHub Pages
45+
id: deployment
46+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.DS_Store
2+
*.abort
3+
*.err
4+
relaton/
5+
.vscode/
6+
.ruby-lsp/
7+
Gemfile.lock
8+
iev/
9+
_site/

Gemfile

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
source "https://rubygems.org"
22

3-
gem "asciidoctor-rfc", git: "https://github.com/riboseinc/asciidoctor-rfc"
4-
# gem "asciidoctor-rfc", path: "~/src/asciidoctor-rfc"
5-
gem "asciidoctor-bibliography", git: "https://github.com/riboseinc/asciidoctor-bibliography"
3+
gem "metanorma-cli"

Gemfile.lock

Lines changed: 0 additions & 60 deletions
This file was deleted.

Makefile

Lines changed: 0 additions & 34 deletions
This file was deleted.

README

Lines changed: 0 additions & 14 deletions
This file was deleted.

README.adoc

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
= CalConnect Standard: vObject -- Integrity protection for vObject, vCard and iCalendar
2+
3+
This work item belongs to TC CALENDAR.
4+
5+
image:https://github.com/CalConnect/cc-vobject-integrity/actions/workflows/generate.yml/badge.svg["Build Status", link="https://github.com/CalConnect/cc-vobject-integrity/actions/workflows/generate.yml"]
6+
7+
This document is available in its rendered forms here:
8+
9+
* https://calconnect.github.io/cc-vobject-integrity/[CalConnect+IETF: vObject -- Integrity protection for vObject, vCard and iCalendar]
10+
11+
12+
== General
13+
14+
This document specifies an integrity checking mechanism and related
15+
properties for:
16+
17+
* vObject (I-D.calconnect-vobject-vformat)
18+
* vCard version 4 (vCard v4) (RFC 6350); and
19+
* iCalendar (Internet Calendaring and Scheduling Core Object
20+
Specification) (RFC 5545)
21+
22+
This work is produced by the CalConnect TC-VCARD and TC-CALENDAR committees.
23+
24+
The document is published as the following:
25+
26+
* CalConnect CC 51002
27+
* IETF draft-calconnect-vobject-integrity
28+
29+
30+
== Structure
31+
32+
`script.rb`::
33+
34+
35+
`sources/`::
36+
source of documents and models
37+
38+
`sources/cc-51002.adoc`::
39+
CalConnect CC 51002 standard.
40+
41+
`sources/draft-calconnect-vobject-integrity.adoc`::
42+
IETF draft-calconnect-vobject-integrity, dual-published from CC 51002.
43+
44+
`_site/`::
45+
(automatically generated using `metanorma site generate`) published document.
46+
47+
48+
== Testing vObject integrity calculations
49+
50+
Testing code for vObject integrity calculations is included here to ensure the
51+
documented specification contains accurate values.
52+
53+
Prerequisites:
54+
55+
[source,sh]
56+
----
57+
$ brew install cryptopp
58+
----
59+
60+
Running:
61+
62+
[source,sh]
63+
----
64+
bundle exec script.rb
65+
----
66+
67+
68+
== Fetching the document
69+
70+
Click on "Code > Local" to clone this repository.
71+
72+
73+
== Installing build tools
74+
75+
See https://www.metanorma.org/install/
76+
77+
78+
== Running via Docker or locally
79+
80+
If you have installed the build tools locally, and wish to run the
81+
locally-installed compilation tools, there is nothing further to set.
82+
83+
If you don't want to deal with local dependencies, use the docker:
84+
85+
[source,sh]
86+
----
87+
docker run -v "$(pwd)":/metanorma -w /metanorma -it metanorma/mn metanorma site generate --agree-to-terms
88+
----
89+
90+
91+
== Building the document
92+
93+
[source,sh]
94+
----
95+
metanorma site generate --agree-to-terms
96+
----
97+
98+
The generated documents are accessible under `_site/`.
99+
100+
101+
== Iterating the document
102+
103+
[source,sh]
104+
----
105+
metanorma site generate --agree-to-terms
106+
open _site/index.html
107+
----
108+
109+
110+
== IETF: Checking against idnits
111+
112+
https://tools.ietf.org/tools/idnits/[idnits] is the RFC checking tool prior to
113+
submissions.
114+
115+
[source,sh]
116+
----
117+
idnits draft-ietf-calext-subscription-upgrade.nits
118+
----
119+
120+
121+
== License
122+
123+
Copyright its respective authors and CalConnect.
124+

lib/glob-include-processor.rb

Lines changed: 0 additions & 18 deletions
This file was deleted.

metanorma.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
metanorma:
3+
source:
4+
files:
5+
- sources/cc-51002.adoc
6+
- sources/draft-calconnect-vobject-integrity.adoc
7+
8+
collection:
9+
name: vObject -- Integrity protection for vObject, vCard and iCalendar
10+
organization: CalConnect

references/informative/ISO-IEC-10118-3.xml

Lines changed: 0 additions & 16 deletions
This file was deleted.

0 commit comments

Comments
 (0)