-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
70 changed files
with
423 additions
and
11,714 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
name: generate | ||
|
||
on: | ||
push: | ||
branches: [ main ] | ||
pull_request: | ||
workflow_dispatch: | ||
|
||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
container: | ||
image: metanorma/metanorma:latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Cache Metanorma assets | ||
uses: actions-mn/cache@v1 | ||
|
||
- name: Metanorma generate site | ||
uses: actions-mn/build-and-publish@main | ||
with: | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
agree-to-terms: true | ||
|
||
deploy: | ||
if: ${{ github.ref == 'refs/heads/main' }} | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
needs: build | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
.DS_Store | ||
*.abort | ||
*.err | ||
relaton/ | ||
.vscode/ | ||
.ruby-lsp/ | ||
Gemfile.lock | ||
iev/ | ||
_site/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,3 @@ | ||
source "https://rubygems.org" | ||
|
||
gem "asciidoctor-rfc", git: "https://github.com/riboseinc/asciidoctor-rfc" | ||
# gem "asciidoctor-rfc", path: "~/src/asciidoctor-rfc" | ||
gem "asciidoctor-bibliography", git: "https://github.com/riboseinc/asciidoctor-bibliography" | ||
gem "metanorma-cli" |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
= CalConnect Standard: vObject -- Integrity protection for vObject, vCard and iCalendar | ||
|
||
This work item belongs to TC CALENDAR. | ||
|
||
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"] | ||
|
||
This document is available in its rendered forms here: | ||
|
||
* https://calconnect.github.io/cc-vobject-integrity/[CalConnect+IETF: vObject -- Integrity protection for vObject, vCard and iCalendar] | ||
== General | ||
|
||
This document specifies an integrity checking mechanism and related | ||
properties for: | ||
|
||
* vObject (I-D.calconnect-vobject-vformat) | ||
* vCard version 4 (vCard v4) (RFC 6350); and | ||
* iCalendar (Internet Calendaring and Scheduling Core Object | ||
Specification) (RFC 5545) | ||
|
||
This work is produced by the CalConnect TC-VCARD and TC-CALENDAR committees. | ||
|
||
The document is published as the following: | ||
|
||
* CalConnect CC 51002 | ||
* IETF draft-calconnect-vobject-integrity | ||
|
||
|
||
== Structure | ||
|
||
`script.rb`:: | ||
|
||
|
||
`sources/`:: | ||
source of documents and models | ||
|
||
`sources/cc-51002.adoc`:: | ||
CalConnect CC 51002 standard. | ||
|
||
`sources/draft-calconnect-vobject-integrity.adoc`:: | ||
IETF draft-calconnect-vobject-integrity, dual-published from CC 51002. | ||
|
||
`_site/`:: | ||
(automatically generated using `metanorma site generate`) published document. | ||
|
||
|
||
== Testing vObject integrity calculations | ||
|
||
Testing code for vObject integrity calculations is included here to ensure the | ||
documented specification contains accurate values. | ||
|
||
Prerequisites: | ||
|
||
[source,sh] | ||
---- | ||
$ brew install cryptopp | ||
---- | ||
|
||
Running: | ||
|
||
[source,sh] | ||
---- | ||
bundle exec script.rb | ||
---- | ||
|
||
|
||
== Fetching the document | ||
|
||
Click on "Code > Local" to clone this repository. | ||
|
||
|
||
== Installing build tools | ||
|
||
See https://www.metanorma.org/install/ | ||
|
||
|
||
== Running via Docker or locally | ||
|
||
If you have installed the build tools locally, and wish to run the | ||
locally-installed compilation tools, there is nothing further to set. | ||
|
||
If you don't want to deal with local dependencies, use the docker: | ||
|
||
[source,sh] | ||
---- | ||
docker run -v "$(pwd)":/metanorma -w /metanorma -it metanorma/mn metanorma site generate --agree-to-terms | ||
---- | ||
|
||
|
||
== Building the document | ||
|
||
[source,sh] | ||
---- | ||
metanorma site generate --agree-to-terms | ||
---- | ||
|
||
The generated documents are accessible under `_site/`. | ||
|
||
|
||
== Iterating the document | ||
|
||
[source,sh] | ||
---- | ||
metanorma site generate --agree-to-terms | ||
open _site/index.html | ||
---- | ||
|
||
|
||
== IETF: Checking against idnits | ||
|
||
https://tools.ietf.org/tools/idnits/[idnits] is the RFC checking tool prior to | ||
submissions. | ||
|
||
[source,sh] | ||
---- | ||
idnits draft-ietf-calext-subscription-upgrade.nits | ||
---- | ||
|
||
|
||
== License | ||
|
||
Copyright its respective authors and CalConnect. | ||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
metanorma: | ||
source: | ||
files: | ||
- sources/cc-51002.adoc | ||
- sources/draft-calconnect-vobject-integrity.adoc | ||
|
||
collection: | ||
name: vObject -- Integrity protection for vObject, vCard and iCalendar | ||
organization: CalConnect |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.