From 14f2c6ceaada8cd2c04ec501eb6ed0cface81931 Mon Sep 17 00:00:00 2001
From: Ronald Tse <ronald.tse@ribose.com>
Date: Sun, 8 Dec 2024 23:16:35 +0800
Subject: [PATCH] feat: add necessary files

---
 .github/workflows/generate.yml | 46 +++++++++++++++++++
 .gitignore                     |  9 ++++
 Gemfile                        |  3 ++
 README.adoc                    | 80 ++++++++++++++++++++++++++++++++++
 metanorma.yml                  | 11 +++++
 5 files changed, 149 insertions(+)
 create mode 100644 .github/workflows/generate.yml
 create mode 100644 .gitignore
 create mode 100644 Gemfile
 create mode 100644 README.adoc
 create mode 100644 metanorma.yml

diff --git a/.github/workflows/generate.yml b/.github/workflows/generate.yml
new file mode 100644
index 0000000..041bb15
--- /dev/null
+++ b/.github/workflows/generate.yml
@@ -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
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..5ed969f
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,9 @@
+.DS_Store
+*.abort
+*.err
+relaton/
+.vscode/
+.ruby-lsp/
+Gemfile.lock
+iev/
+_site/
diff --git a/Gemfile b/Gemfile
new file mode 100644
index 0000000..ae144ae
--- /dev/null
+++ b/Gemfile
@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "metanorma-cli"
diff --git a/README.adoc b/README.adoc
new file mode 100644
index 0000000..a9c13ad
--- /dev/null
+++ b/README.adoc
@@ -0,0 +1,80 @@
+= CalConnect Standard: (TITLE)
+
+This work item belongs to CalConnect (TCs).
+
+image:https://github.com/CalConnect/cc-valarm-extensions/workflows/generate/badge.svg["Build Status", link="https://github.com/CalConnect/cc-valarm-extensions/actions?workflow=generate"]
+
+This document is available in its rendered forms here:
+
+* https://calconnect.github.io/cc-valarm-extensions/[CalConnect: Calendaring and scheduling -- Vocabulary (HTML)]
+
+== General
+
+This document specifies the (TITLE).
+
+The document is published as the following:
+
+* CalConnect CC (DOCNUMBER)
+* ISO (DOCNUMBER)
+* IETF draft-cc-valarm-extensions
+
+
+== Fetching the document
+
+[source,sh]
+----
+git clone https://github.com/CalConnect/cc-valarm-extensions/
+----
+
+
+== Installing build tools
+
+See https://www.metanorma.com/author/topics/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-calconnect-vobject-vformat.nits
+// ----
+
+
+== License
+
+Copyright its respective authors and CalConnect.
diff --git a/metanorma.yml b/metanorma.yml
new file mode 100644
index 0000000..993e01e
--- /dev/null
+++ b/metanorma.yml
@@ -0,0 +1,11 @@
+---
+metanorma:
+  source:
+    files:
+      - sources/cc-51008/document.adoc
+      - sources/ietf/document.adoc
+      - sources/iso-51008/document.adoc
+
+  collection:
+    name: vObject and vFormat
+    organization: CalConnect