Skip to content

README.md

Latest commit

 

History

History
60 lines (44 loc) · 2.48 KB

README.md

File metadata and controls

60 lines (44 loc) · 2.48 KB

Accountable Digital Identity Architecture Specification

Main specification repository

To view the latest editor draft, see https://adia-spec.dev.digitaltrust.net/ADIA-overview.html

The clone the repository locally:

  1. Click on "Code" and copy the HTTPS-URL -or- choose "Open with GitHub Desktop" (see note below)
  2. run "git" in a terminal window in a folder for git repositories (download git: https://git-scm.com/downloads)
  3. change to the newly created folder "ADIA-specification"

To compile the .bs files to .html, please:

  1. Install bikeshed (install from https://tabatkins.github.io/bikeshed/)
  2. Run "python.exe ../bikeshed/bikeshed.py spec did-sample.bs"

NOTES:

Please create "Issues" in github to report any errors or room for improvements in the existing draft. Then create a new branch fixing the "Issue" and create a "Pull Request" that will tie that proposed change to the Issue.

Important:

  • For any pull request, please assign two (2) reviewers.
  • Do not merge any pull request without review or discussion within TWG.
  • Never commit any changes directly to the 'master' branch. Always create an issue, a different branch and a pull request first!

GitHub Desktop: Github Desktop is a GUI interface for git operations. It can be used instead of command line git commands for people who prefer that. Link to download: https://desktop.github.com/ There is an installation wizard that will guide you to connect GitHub Desktop to GitHub online and you will be able to create a copy of the spec repository on your local machine.

Generating HTML version

There are three scripts:

Compile all bikeshed files to HTML

 > ./compile.sh
  1. This compiles all the *.bs files to html and moves them to the 'dist' folder.
  2. HTML files can be browsed locally.

Dockerize the generated HTML

 > .compile.sh;./dockerize.sh
 > ./run_html.sh
  1. This compiles all bikeshed files and creates a docker image.
  2. The HTML files can be viewed using NGINX for a true browser experience
  3. The commands are simple wrappers for docker commands and can be used as is if you are an advanced user with knowledge of Docker.
 > ./run_html.sh

Note: You will need a Docker Desktop (https://www.docker.com/products/docker-desktop) to run it on your Windows or Mac workstation.