Skip to content
This repository has been archived by the owner on Apr 29, 2024. It is now read-only.

Respeccify & import readme #1

Merged
merged 5 commits into from
May 27, 2022
Merged

Respeccify & import readme #1

merged 5 commits into from
May 27, 2022

Conversation

clehner
Copy link
Contributor

@clehner clehner commented Apr 7, 2022 •
edited
Loading

Convert the web page to use Respec like other CG docs. Add some spec text.

Structure is adjusted, and references are improved.

Marking sections as normative vs. informative could still be improved. This currently defaults them all to normative.

Content changes are in 26486f9; indentation and spaces only are changed in cc1c84e.

License and readme content are imported in 720288b from the cacao-zcap-rs repo where they are being removed in spruceid/cacao-zcap-rs#15.

Added Respec validation GitHub Action based on https://github.com/w3c/spec-prod/blob/main/docs/examples.md#run-as-a-validator-on-pull-requests

Preview: https://demo.didkit.dev/2022/04/21/cacao-zcap-pr-1.html

@clehner clehner marked this pull request as ready for review April 8, 2022 13:12
@clehner clehner marked this pull request as draft April 8, 2022 13:21
@clehner clehner force-pushed the feat/respec branch 2 times, most recently from 700c549 to cc1c84e Compare April 8, 2022 14:01
@clehner clehner marked this pull request as ready for review April 8, 2022 14:10
@clehner clehner requested a review from awoie April 8, 2022 14:15
@clehner clehner changed the title Respeccify Respeccify & import readme Apr 8, 2022
awoie
awoie reviewed Apr 11, 2022
View reviewed changes
Copy link

@awoie awoie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

have we used CC BY 4.0 in other projects before?

@clehner
Copy link
Contributor Author

clehner commented Apr 11, 2022

@awoie
I'm not sure, except that it was added in spruceid/cacao-zcap-rs#1.

It's the default in Respec when using specStatus: "unofficial": https://respec.org/docs/#specStatus
e.g. as seen in https://or13.github.io/lds-blockchain2021/, https://or13.github.io/lds-pgp2021/ and https://w3c-ccg.github.io/vdl-vocab/.

When specStatus is changed to e.g. CG-DRAFT, that changes to a reference to W3C Community Contributor License Agreement (CLA) (https://www.w3.org/community/about/agreements/cla/, https://www.w3.org/community/about/agreements/cla-deed/).
e.g. as in https://w3c-ccg.github.io/lds-ed25519-2020/, https://w3c-ccg.github.io/data-integrity-spec/.

If/when it goes into a Working Group, it changes to a https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document.

@clehner clehner mentioned this pull request Apr 13, 2022
Merged
@clehner clehner requested a review from awoie May 10, 2022 13:42
awoie
awoie approved these changes May 16, 2022
View reviewed changes
Copy link

@awoie awoie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@clehner
Use Respec
d4eaeb8 
Check Respec on pull-request
@clehner
Re-indent
890ce16
@clehner
Add readme and license
6737180
@clehner
Add security consideration
1ecaff9
@clehner
Editorial changes
3c62c1b 
- Change Terms section title to CACAO-ZCAP Vocabulary
- More specific link for verificationMethod proof property
- Note JSON-LD context from Vocabulary section
@clehner
Copy link
Contributor Author

clehner commented May 27, 2022

Rebased and squashed some commits (26486f9..1426089 -> d4eaeb8..3c62c1b)

@clehner clehner merged commit 3c62c1b into main May 27, 2022
@clehner clehner deleted the feat/respec branch May 27, 2022 17:25
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@awoie awoie awoie approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@clehner @awoie