Git Product home page Git Product logo

mn-templates-cc's Introduction

CalConnect Metanorma Templates

Test Status Pages Status Build Status

This GitHub repository contains templates for CalConnect Metanorma documents.

Note that the Apache license applies only to the templates. Once a document has been created, the license must reflect the CalConnect document license.

This repository is used by the metanorma new command to create new documents.

mn-templates-cc's People

Contributors

abunashir avatar camobap avatar manuelfuenmayor avatar opoudjis avatar ronaldtse avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

mn-templates-cc's Issues

Re-enable/Implement GitHub pages deploy flow

We're missing some documentation on how to deploy on GitHub pages (maybe add to an INSTRUCTIONS.adoc file in the templates?) (https://github.com/metanorma/metanorma-document-gh-pages/)

Right now the user has to do the following after cloning the document template:

  1. Push the document template to a GitHub repo
  2. use ssh-keygen to generate a key-pair which will be used as the "deploy key" (filename: deploy_key)
  3. At GitHub, upload the public key of the deploy key and authorize "write access".
  4. Enable Travis for this repository.
  5. Use Travis command tools to encrypt this deploy key into deploy_key.enc
  6. Add deploy_key.enc to the repo and push.

During deployment:

  1. The make deploy_key task is used to decrypt the deploy_key.enc into deploy_key. (This step is not integrated into Travis deploy!! (TODO))
  2. .travis.yml file includes a directive to push compiled documents to GitHub pages.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.