Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revisit doc structure and headings #194

Open
nedmsmith opened this issue Jan 19, 2024 · 0 comments
Open

Revisit doc structure and headings #194

nedmsmith opened this issue Jan 19, 2024 · 0 comments
Labels
mustfix This is essential requirement for CoRIM Publish

Comments

@nedmsmith
Copy link
Collaborator

nedmsmith commented Jan 19, 2024

Taking a step back, the document structure may need some tweaking:

  • Section 5 heading should be "CoRIM-based Appraisal" or something similar since it isn't exclusive to Evidence.

    • Section 5.4.5 Adding CoMID Endorsed values to ACS : should be removed or integrated with Section 5.4.3 Processing Endorsed Value Triple since these appear to be synonymous.
    • There should be a section between Section 5.4.1 and 5.4.2 that describes "Adding Evidence to ACS".
    • There should be a section (5.4.5?) that describes processing of CoSWID tags and coswid-triples that also closes issue coswid appraisal conventions #165.
  • Section 5.5 should be "Transforming Evidence" or something similar since other sections in 5 (see previous bullets) describe initialization and population of ACS with Evidence and 5.5 focuses on schema mapping issues.

  • There should be a new Section 6 that focuses on processing updates e.g., "Update Processing". The resolution to PR Updates to Reference Value and Endorsed Values #170 should be documented here. Subsections might be:

    • Section 6.1 Updates Can Take Multiple Forms : This section describes the various possible ways the ecosystem might update RIMs (e.g.: x-triples, x-corims, refreshed corims, x-tags?...)
    • Section 6.2 Staging Updates : This section describes a staging area for applying updates and results in an internal representation of RVPs and Endorsements suitable for use by appraisal (section 5).
    • If there is a need to describe in more detail a particular update mechanism (e.g. x-triple) then subsections here can describe semantics and CDDL expressions.
@yogeshbdeshpande yogeshbdeshpande added the mustfix This is essential requirement for CoRIM Publish label May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
mustfix This is essential requirement for CoRIM Publish
Projects
None yet
Development

No branches or pull requests

2 participants