Skip to content

Commit

Permalink
feat: add necessary files
Browse files Browse the repository at this point in the history
  • Loading branch information
ronaldtse committed Dec 8, 2024
1 parent 56e6387 commit 91298ed
Show file tree
Hide file tree
Showing 5 changed files with 149 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .github/workflows/generate.yml
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
9 changes: 9 additions & 0 deletions .gitignore
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/
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"
80 changes: 80 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
= CalConnect Standard: (TITLE)

This work item belongs to CalConnect (TCs).

image:https://github.com/CalConnect/cc-iTip-rewrite/workflows/generate/badge.svg["Build Status", link="https://github.com/CalConnect/cc-iTip-rewrite/actions?workflow=generate"]

This document is available in its rendered forms here:

* https://calconnect.github.io/cc-iTip-rewrite/[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-iTip-rewrite


== Fetching the document

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


== 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.
11 changes: 11 additions & 0 deletions metanorma.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 91298ed

Please sign in to comment.