Standards are contained within the
standards
file system directory with each standard encoded into a markdown file with a
YAML preface. The YAML preface is
structured to encode the various elements describing a metadata standard or its
associated implementations.
Implementations come in three different categories
extensions,
tools,
and use_cases. Each grouping of
implementations are contained in their own file system directories.
Relationships between implementations and standards are created based on recording related standards within each of the implementation metadata records.
Adding a new standard is as simple as forking the repository creating a new standards file marked up with a simple YAML schema. Commiting your new standard, and then submitting a pull request to the origin repository.
An extension needs to reference an existing standard. Extensions are typically enhancements to a standard that provide additional functionality or meet some other requirements.
Tools are software tools or systems that support the use of the standard. Tools implement the standard.
Use cases are systems, organizations or projects which use the standard.
Editing can take place within the GitHub editing tools. Or alternatively a fork of the repository can be cloned and editing can be done locally and pull requests can be generated using the existing GitHub and git workflows.
Experimenting with different workflows for editing is encouraged!
Creating and editing files in your repository
The website is generated with Jekyll. The website uses Jekyll to process HTML, YAML, and Markdown files to generate a static website.
If you choose to clone the repository running a local version of Jekyll is helpful for troubleshooting: https://help.github.com/articles/using-jekyll-with-pages