Skip to content

Commit

Permalink
Install v1.0 CS01 files & upgraded README.md (#63)
Browse files Browse the repository at this point in the history
* Install v1.0 CS01 version to Published

* Upgraded README.md w/associated graphics
  • Loading branch information
dlemire60 authored Feb 18, 2022
1 parent 18b63fd commit d62c5b7
Show file tree
Hide file tree
Showing 11 changed files with 5,067 additions and 22 deletions.
93 changes: 71 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,93 @@
<div>
<h2>README</h2>
## README

<p>Members of the <a href="https://www.oasis-open.org/committees/openc2/">OASIS Open Command and Control (OpenC2) TC</a> create and manage technical content in this TC GitHub repository ( <a href="https://github.com/oasis-tcs/openc2-jadn">https://github.com/oasis-tcs/openc2-jadn</a>) as part of the TC's chartered work (<i>i.e.</i>, the program of work and deliverables described in its <a href="https://www.oasis-open.org/committees/openc2/charter.php">charter</a>).</p>
![HTTPS ReadMe Logo](images/jadn-logo-header.png)

<p>OASIS TC GitHub repositories, as described in <a href="https://www.oasis-open.org/resources/tcadmin/github-repositories-for-oasis-tc-members-chartered-work">GitHub Repositories for OASIS TC Members' Chartered Work</a>, are governed by the OASIS <a href="https://www.oasis-open.org/policies-guidelines/tc-process">TC Process</a>, <a href="https://www.oasis-open.org/policies-guidelines/ipr">IPR Policy</a>, and other policies, similar to TC Wikis, TC JIRA issues tracking instances, TC SVN/Subversion repositories, etc. While they make use of public GitHub repositories, these TC GitHub repositories are distinct from <a href="https://www.oasis-open.org/resources/open-repositories">OASIS Open Repositories</a>, which are used for development of open source <a href="https://www.oasis-open.org/resources/open-repositories/licenses">licensed</a> content.</p>
</div>
## ![oasis-avatar](https://avatars.githubusercontent.com/u/47402065?s=24&v=4) An OASIS [Work Product](https://www.oasis-open.org/policies-guidelines/oasis-defined-terms-2018-05-22/#dWorkProduct) Repository ![oasis-avatar](https://avatars.githubusercontent.com/u/47402065?s=24&v=4)

<div>
<h3>Description</h3>
Members of the OASIS [Open Command and Control (OpenC2) Technical
Committee](https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=openc2)
use this GitHub repository as part of the [TC's chartered
work](https://www.oasis-open.org/committees/openc2/charter.php).
Contributors must be Members of the TC. Work is governed by the
OASIS policies and is not done under typical open source
licensing. For more details, see the
[Contributions](#contributions) and [Licensing](#licensing)
sections below.

<p>JSON Abstract Data Notation (JADN) has several purposes, including definition of data structures and validation of data instances. This document specifies a vocabulary to describe the meaning of structured data, to provide hints for user interfaces working with structured data, and to make assertions about what a valid instance must look like. JADN structure definitions are format-neutral. Serialization rules define how JADN instances are represented in specific data formats such as JSON, XML, and CBOR.
## :blue_book: _JSON Abstract Data Notation (JADN)_ :blue_book:

This repository is designed to support TC members' work on a formal
specification that describes JADN, a tool for defining data structures and
validating data instances. The provisional Work Product title is "Specification for JSON Abstract Data Notation,
Version 1.0", edited by David Kemp (NSA). This GitHub repository supports development of the content and change tracking
for the JSON Abstract Data Notation (JADN) specification as new working draft level revisions are created
and the associated CSDs mature.
The JSON Abstract Data Notation (JADN) specification defines an
information modeling (IM) language by specifying a vocabulary to
describe the meaning of structured data, to provide hints for
user interfaces working with structured data, and to make
assertions about what a valid instance must look like.

</div>
### :twisted_rightwards_arrows: Repository Organization :twisted_rightwards_arrows:

![branches](images/repo-branches.png)

OpenC2 work product repositories are organized a bit differently
than typical open source software project repositories:

* The **Published** (default) branch represents the current,
stable, approved version of the work product. If the product
hasn't progressed past an [OASIS Committee Specification Draft
(CSD)](https://www.oasis-open.org/policies-guidelines/tc-process-2017-05-26/#committeeDraft),
this branch is essentially empty
* The **Working** branch is where all work-in-progress content is
captured, and is the place to go for the [current working
version](https://github.com/oasis-tcs/openc2-jadn/blob/working/jadn-v1.0-wd02.md)
of this work product

More information about the TC's repository organizing conventions
and branching strategy can be found in our [Documentation
Norms](https://github.com/oasis-tcs/openc2-tc-ops/blob/main/Documentation-Norms.md#433-configure-repository).


### :left_speech_bubble: Description :left_speech_bubble:

JSON Abstract Data Notation (JADN) has several purposes,
including definition of data structures and validation of data
instances. This document specifies a vocabulary to describe the
meaning of structured data, to provide hints for user interfaces
working with structured data, and to make assertions about what a
valid instance must look like. JADN structure definitions are
format-neutral. Serialization rules define how JADN instances are
represented in specific data formats such as JSON, XML, and CBOR.

### :writing_hand: Contributions :writing_hand:
<div>
<h3>Contributions</h3>
<p>As stated in this repository's <a href="https://github.com/oasis-tcs/openc2-jadn/blob/master/CONTRIBUTING.md">CONTRIBUTING file</a>, contributors to this repository are expected to be Members of the OASIS OpenC2 TC, for any substantive change requests. Anyone wishing to contribute to this GitHub project and <a href="https://www.oasis-open.org/join/participation-instructions">participate</a> in the TC's technical activity is invited to join as an OASIS TC Member. Public feedback is also accepted, subject to the terms of the <a href="https://www.oasis-open.org/policies-guidelines/ipr#appendixa">OASIS Feedback License</a>.</p>
</div>


### :scroll: Licensing :scroll:

<div>
<h3>Licensing</h3>
<p>Please see the <a href="https://github.com/oasis-tcs/openc2-jadn/blob/master/LICENSE.md">LICENSE</a> file for description of the license terms and OASIS policies applicable to the TC's work in this GitHub project. Content in this repository is intended to be part of the OpenC2 TC's permanent record of activity, visible and freely available for all to use, subject to applicable OASIS policies, as presented in the repository <a href="https://github.com/oasis-tcs/openc2-jadn/blob/master/LICENSE.md">LICENSE</a> file.</p>
</div>

### :left_speech_bubble: Further Description of this Repository :left_speech_bubble:



This repository is designed to support TC members' work on a
formal specification that describes JADN. This GitHub repository
supports development of the content and change tracking for the
JADN specification as new working draft level revisions are
created and the associated CSDs mature.

<div>
<h3>Further Description of this Repository</h3>

<p>[Any narrative content may be provided here by the TC, for example, if the Members wish to provide an extended statement of purpose.]</p>
<p>Members of the <a href="https://www.oasis-open.org/committees/openc2/">OASIS Open Command and Control (OpenC2) TC</a> create and manage technical content in this TC GitHub repository ( <a href="https://github.com/oasis-tcs/openc2-jadn">https://github.com/oasis-tcs/openc2-jadn</a> ) as part of the TC's chartered work (<i>i.e.</i>, the program of work and deliverables described in its <a href="https://www.oasis-open.org/committees/openc2/charter.php">charter</a>).</p>

<p>OASIS TC GitHub repositories, as described in <a href="https://www.oasis-open.org/resources/tcadmin/github-repositories-for-oasis-tc-members-chartered-work">GitHub Repositories for OASIS TC Members' Chartered Work</a>, are governed by the OASIS <a href="https://www.oasis-open.org/policies-guidelines/tc-process">TC Process</a>, <a href="https://www.oasis-open.org/policies-guidelines/ipr">IPR Policy</a>, and other policies, similar to TC Wikis, TC JIRA issues tracking instances, TC SVN/Subversion repositories, etc. While they make use of public GitHub repositories, these TC GitHub repositories are distinct from <a href="https://www.oasis-open.org/resources/open-repositories">OASIS Open Repositories</a>, which are used for development of open source <a href="https://www.oasis-open.org/resources/open-repositories/licenses">licensed</a> content.</p>
</div>

<div>

<h3>Contact</h3>
<p>Please send questions or comments about <a href="https://www.oasis-open.org/resources/tcadmin/github-repositories-for-oasis-tc-members-chartered-work">OASIS TC GitHub repositories</a> to the <a href="mailto:tc-admin@oasis-open.org">OASIS TC Administrator</a>. For questions about content in this repository, please contact the TC Chair or Co-Chairs as listed on the the <tc short name> TC's <a href="https://www.oasis-open.org/committees/openc2/">home page</a>.</p>
### :envelope_with_arrow: Contact :envelope_with_arrow:
<div>
<p>Please send questions or comments about <a href="https://www.oasis-open.org/resources/tcadmin/github-repositories-for-oasis-tc-members-chartered-work">OASIS TC GitHub repositories</a> to the <a href="mailto:tc-admin@oasis-open.org">OASIS TC Administrator</a>. For questions about content in this repository, please contact the TC Chair or Co-Chairs as listed on the the <tc short name> TC's <a href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=openc2">home page</a>.</p>
</div>


Binary file added images/info-engineering.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/jadn-defs.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/jadn-logo-header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/logical-info-erd.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/repo-branches.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit d62c5b7

Please sign in to comment.