Skip to content

Commit

Permalink
rendering for toip
Browse files Browse the repository at this point in the history
Signed-off-by: Kevin Griffin <[email protected]>
  • Loading branch information
m00sey committed Jan 4, 2024
1 parent 13fa065 commit 54fa7dc
Show file tree
Hide file tree
Showing 96 changed files with 2,842 additions and 321 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ report.xml
/versioned/
/.vscode/
!requirements.txt
.DS_Store
44 changes: 44 additions & 0 deletions COPYRIGHT_POLICY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
OWF Contributor License Agreement 1.0 - Copyright
Open Web Foundation

Contributor License Agreement (CLA 1.0)
(Copyright Only)


1. The Purpose of this Contributor License Agreement. This CLA sets forth the terms under which I will participate in and contribute to the development of the Specification. Capitalized terms are defined in the CLA’s last section.

2. Copyrights.

2.1. Copyright Grant. I grant to you a perpetual (for the duration of the applicable copyright), worldwide, non-exclusive, no-charge, royalty-free, copyright license, without any obligation for accounting to me, to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, distribute, and implement any Contribution to the full extent of my copyright interest in the Contribution.

2.2. Attribution. As a condition of the copyright grant, you must include an attribution to the Specification in any derivative work you make based on the Specification. That attribution must include, at minimum, the Specification name and version number.

3. No Other Rights. Except as specifically set forth in this CLA, no other express or implied patent, trademark, copyright, or other property rights are granted under this CLA, including by implication, waiver, or estoppel.

4. Open Web Foundation Agreement ("OWFa") version 1.0 Execution. I acknowledge that the goal of this CLA is to develop a specification that will be subject to the OWFa version 1.0. While I have no legal obligation to execute the OWFa version 1.0 for any version of the specification being developed under this CLA, I agree that the selection and terms of the OWFa version 1.0 will not be subject to negotiation.

5. Antitrust Compliance. I acknowledge that I may compete with other participants, that I am under no obligation to implement the Specification, that each participant is free to develop competing technologies and standards, and that each party is free to license its patent rights to third parties, including for the purpose of enabling competing technologies and standards.

6. Non-Circumvention. I agree that I will not intentionally take or willfully assist any third party to take any action for the purpose of circumventing my obligations under this CLA.

7. Representations, Warranties and Disclaimers. I represent and warrant that 1) I am legally entitled to grant the rights and promises set forth in this CLA and 2) I will not intentionally include any third party materials in any Contribution unless those materials are available under terms that do not conflict with this CLA. IN ALL OTHER RESPECTS MY CONTRIBUTIONS ARE PROVIDED "AS IS." The entire risk as to implementing or otherwise using the Contribution or the Specification is assumed by the implementer and user. Except as stated herein, I expressly disclaim any warranties (express, implied, or otherwise), including implied warranties of merchantability, non-infringement, fitness for a particular purpose, or title, related to the Contribution or the Specification. IN NO EVENT WILL ANY PARTY BE LIABLE TO ANY OTHER PARTY FOR LOST PROFITS OR ANY FORM OF INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER FROM ANY CAUSES OF ACTION OF ANY KIND WITH RESPECT TO THIS CLA, WHETHER BASED ON BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE, AND WHETHER OR NOT THE OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Nothing in this CLA requires me to undertake a patent search.

8. Definitions.

8.1. Bound Entities. “Bound Entities” means the entity listed below and any entities that the Bound Entity Controls.

8.2. CLA. “CLA” means this document, which sets forth the rights, grants, promises, limitations, conditions, obligations, and disclaimers made available for my Contributions to the particular Specification.

8.3. Contribution. “Contribution” means any original work of authorship, including any modifications or additions to an existing work, that I intentionally submit for inclusion in the Specification, which is included in the Specification. For the purposes of this definition, “submit” means any form of electronic, oral, or written communication for the purpose of discussing and improving the Specification, but excluding communication that I conspicuously designate in writing as not a contribution.

8.4. Control. “Control” means direct or indirect control of more than 50% of the voting power to elect directors of that corporation, or for any other entity, the power to direct management of such entity.

8.5. I, Me, or My. “I,” “me,” or “my” refers to the signatory below and its Bound Entities, if applicable.

8.6. Specification. “Specification” means the Specification identified below as of the date of my last Contribution.

8.7. You or Your. “You,” “you,” or “your” means any person or entity who exercises copyright rights granted under this CLA, and any person or entity you Control.

Identify the Specification here:

Your specification (All Versions)
1 change: 1 addition & 0 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Need content
46 changes: 46 additions & 0 deletions EditingTheSpec.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Editing the Specification

To contribute changes to the specification, please

- Review the [Contributions policy](Contributing.md) for this specification and ensure that you and your organization are willing to abide by the policy.
- **Pull requests submitted to this repository imply acceptance of the [Contributions policy](Contributing.md).**
- Submit a pull request by:
- forking this repo
- editing the appropriate markdown files in the [`/spec`](/spec) folder

The specification source consists of the markdown files listed in
[specs.json](/specs.json) and found in the [`/spec`](/spec) folder. The
specification is automatically rendered (using
[Spec-Up](https://github.com/decentralized-identity/spec-up)) to the `/docs`
folder of the `gh-pages` branch of this repository on each pull request merge
(using a GitHub Action), and then published (using GitHub Pages).

## Testing your Edits Locally

Full guidance for using Spec-Up is in its
[repository](https://github.com/decentralized-identity/spec-up). The short
version of the instructions to render this specification locally while you are
editing is:

- Install the prerequisites: `node` and `npm`
- Run `npm install` from the root of the repository
- Run `npm run edit` from the root of the repository to render the document with
live updates to the `docs/index.html` as
you edit the source files.
- You can also run `npm run render` to just generate the specification file once.
- Open the rendered file in a browser and refresh to see your updates as you work.
- When you are done, hit `Ctrl-c` to exit the live rendering.

Please check your edits locally before you submit a pull request!

### Handling the Rendered Specification File

When you create a pull request to update the specification, the `docs/index.html` will be
.gitignore'd and **not** included in your pull request. A GitHub Action triggered on merging pull requests automagically renders the full
specification (`docs/index.html`) to the `gh-pages` branch in the repository and the
specification is published (via GitHub Pages) from there.

## Adding a New Source Markdown File

If you add a source markdown file to the specification, you must also add a reference
to it in the [specs.json](/specs.json) in the root of the repository.
26 changes: 5 additions & 21 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,7 @@
# Licensing
This repository and its content inherit a licensing model from the Technical Stack Working Group ([TSWG](https://wiki.trustoverip.org/display/HOME/Technology+Stack+Working+Group)) at the Trust over IP Foundation ([ToIP](https://trustoverip.org))

All software and documentation in this repository are *Copyright 2023 ACDC Contributors* and
all contributions to this repository are *Licensed under the OWFa 1.0 (the "License")* [here](https://github.com/trustoverip/tswg-acdc-specification/blob/main/LICENSE).
The license model comprises of three parts and as such three documents:

As as defined in the License, contributions include but are not limited to patents, source code, specification text,
documentation, comments and issues. You may not use the software or documentation in this repository except in compliance with the License.
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS.
You may obtain a copy of the License at [OWFa 1.0](https://www.openwebfoundation.org/the-agreements/the-owf-1-0-agreements-granted-claims/owfa-1-0).

To remove any doubt as the origin on any contributions, all contributers are also bound by the
Developer Ceritificate of Origin v1.1 (DCO 1.1) which may be found [here](https://developercertificate.org)

As a GitHub repository, all contributions to this repository are also bound by
the GitHub *inbound=outbound* policy. This may be found under Section D.6
[here](https://docs.github.com/en/github/site-policy/github-terms-of-service#6-contributions-under-repository-license) to the extent not superceeded by the ToIP CLA [link].

The legal structure of this repository with respect to the licensing of its
associated contributions also follows GitHub's Open Source Guide reccomendations for
open source standards and code. These may be found [here](https://opensource.guide/legal/)

In addition to the copyright and licensing restrictions described above, all contributions to this repository may be contributions to a terminal standards body such as [IETF](https://www.ietf.org), [ISO](https://www.iso.org/home.html) or equivelant.
* [Copyright Policy](COPYRIGHT_POLICY.md)
* [Approved Deliverable Patent Licensing](PATENT_LICENSING.md)
* [Source Code](SOURCE_CODE.md)
Loading

0 comments on commit 54fa7dc

Please sign in to comment.