Skip to content

Commit

Permalink
feat: add calconnect version
Browse files Browse the repository at this point in the history
  • Loading branch information
ronaldtse committed Jan 27, 2025
1 parent 5c3d699 commit de4c32d
Show file tree
Hide file tree
Showing 7 changed files with 241 additions and 1 deletion.
49 changes: 49 additions & 0 deletions .github/workflows/docker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: docker

on:
push:
branches: [ main ]
pull_request:
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }}
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
container:
image: metanorma/metanorma:latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
submodules: true

- name: Bundler install
uses: metanorma/ci/docker-gem-install@main

- name: Metanorma generate site
uses: actions-mn/build-and-publish@v2
with:
destination: gh-pages
agree-to-terms: true
use-bundler: true

deploy:
if: ${{ github.ref_name == github.event.repository.default_branch }}
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
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.DS_Store
.swp
.tmp.xml
relaton/
iev/
Gemfile.lock
*.abort
*.err
*.err.html

3 changes: 3 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
source "https://rubygems.org"

gem "metanorma-cli"
97 changes: 97 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
= CalConnect Standard: v-event URI: An URI scheme for events

This work item belongs to TC EVENTPUB.

image:https://github.com/CalConnect/cc-event-uri/actions/workflows/generate.yml/badge.svg["Build Status", link="https://github.com/CalConnect/cc-event-uri/actions/workflows/generate.yml"]

This document is available in its rendered forms here:

* https://calconnect.github.io/cc-event-uri/[CalConnect+IETF: Calendaring and scheduling -- v-event URI: An URI scheme for events]
== General

This document specifies an URI scheme for events, which can be used to
reference events in a standard way across different platforms and
applications. The scheme is designed to be easy to use and to be
compatible with existing calendaring standards.

The document is published as the following:

* CalConnect CC 51015
* IETF draft-menderico-v-event-uri


== Structure

`sources/`::
source of documents.

`sources/cc-51015.adoc`::
CalConnect CC 51015 standard.

`sources/draft-menderico-v-event-uri.adoc`::
IETF draft-menderico-v-event-uri, dual-published from CC 51015.

`_site/`::
(automatically generated using `metanorma site generate`) published document.


== Fetching the document

[source,sh]
----
git clone https://github.com/CalConnect/cc-event-uri/
----


== 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-menderico-v-event-uri.nits
----


== License

Copyright its respective authors and CalConnect.
10 changes: 10 additions & 0 deletions metanorma.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
metanorma:
source:
files:
- sources/cc-51015.adoc
- sources/draft-menderico-v-event-uri.adoc

collection:
organization: CalConnect
name: "v-event URI: An URI scheme for events"
71 changes: 71 additions & 0 deletions sources/cc-51015.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
= CalConnect Standard: v-event URI: An URI scheme for events
:title: Calendaring and scheduling -- v-event URI: An URI scheme for events
:fullname: Raphael Menderico
:firstname: Raphael
:lastname: Menderico
:forename_initials: R.
:organization: Google Inc.
:role: editor
:street: Brandschenkestrasse 110
:city: Zurich
:code: 8002
:country: Switzerland
:uri: http://www.google.com/
:email: [email protected]
:fullname_2: Paulo Schlup
:firstname_2: Paulo
:lastname_2: Schlup
:forename_initials_2: P.
:organization_2: Google Inc.
:role_2: author
:street_2: Brandschenkestrasse 110
:city_2: Zurich
:code_2: 8002
:country_2: Switzerland
:uri_2: http://www.google.com/
:email_2: [email protected]
:fullname_3: Lucia Kristiansen
:firstname_3: Lucia
:lastname_3: Kristiansen
:forename_initials_3: L.
:organization_3: Google Inc.
:role_3: author
:street_3: Brandschenkestrasse 110
:city_3: Zurich
:code_3: 8002
:country_3: Switzerland
:uri_3: http://www.google.com/
:email_3: [email protected]
:docnumber: 51015
:copyright-year: 2015
:language: en
:doctype: standard
:edition: 1
:status: committee-draft
:revdate: 2015-11-02
:published-date: 2015-11-02
:script: Latn
:technical-committee: EVENTPUB
:imagesdir: images
:mn-document-class: cc
:mn-output-extensions: xml,html,pdf,rxl
:local-cache-only:
:data-uri-image:

include::sections/00-abstract.adoc[]

include::sections/00-status.adoc[]

include::sections/01-intro.adoc[]

include::sections/02-motivation.adoc[]

include::sections/03-vevent-uri-scheme.adoc[]

include::sections/04-security.adoc[]

include::sections/05-future-work.adoc[]

include::sections/06-acknowledgments.adoc[]

include::sections/99-references.adoc[]
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= v-event URI: An URI scheme for events
:doctype: internet-draft
:docnumber: draft-menderico-v-event-uri
:docnumber: draft-menderico-v-event-uri-00
:status: informational
:ipr: trust200902
:consensus: true
Expand Down

0 comments on commit de4c32d

Please sign in to comment.