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.

Sign up for GitHub

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

Add: Documentation for CoMID templates #20

Open
wants to merge 25 commits into
base: main
Choose a base branch
from
+460 −0
Open

Add: Documentation for CoMID templates #20

Changes from 15 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
b7bbcae
Add: Docs for CoMID Template Format
ravjot07 Dec 24, 2024
b995937
minor changes
ravjot07 Dec 24, 2024
d5f6ccc
Update data/comid/README.md
ravjot07 Dec 25, 2024
9a70845
Update Readme: add examples and diagrams
ravjot07 Dec 27, 2024
d2e7ffd
Merge branch 'docs' of https://github.com/ravjot07/cocli into docs
ravjot07 Dec 27, 2024
41453a0
minor changes
ravjot07 Dec 27, 2024
b4038e1
Docs: CoRIM template Format
ravjot07 Dec 30, 2024
b60c154
Update: diagrams to mermaid format and some minor changes
ravjot07 Jan 4, 2025
1a28a31
fix(docs): Update README for Windows Bash auto-completion and correct…
Priyanshuthapliyal2005 Dec 22, 2024
a05f8fb
update window bash to git bash
Priyanshuthapliyal2005 Dec 23, 2024
f44bd62
Update: corim display Command to Support Unsigned CoRIMs
ravjot07 Dec 20, 2024
9cfeed7
Refractor code into more modeluar function
ravjot07 Dec 22, 2024
d4963e7
minor changes
ravjot07 Dec 22, 2024
7427ebf
Fixes: ci issue
ravjot07 Dec 23, 2024
5a9919d
Add: Docs for CoMID Template Format
ravjot07 Dec 24, 2024
9e820d9
minor changes
ravjot07 Dec 24, 2024
1447a59
Update Readme: add examples and diagrams
ravjot07 Dec 27, 2024
c470890
Update data/comid/README.md
ravjot07 Dec 25, 2024
d554494
minor changes
ravjot07 Dec 27, 2024
eac2206
Docs: CoRIM template Format
ravjot07 Dec 30, 2024
a32b99e
Update: diagrams to mermaid format and some minor changes
ravjot07 Jan 4, 2025
19fcbf4
Removed pngs and updated links
ravjot07 Jan 7, 2025
7cecd10
Removed pngs and updated links
ravjot07 Jan 7, 2025
e312487
minor changes
ravjot07 Jan 7, 2025
d77c838
testing prelinks
ravjot07 Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 1 addition & 95 deletions data/comid/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,102 +101,8 @@ graph TD
Below are the **seven** template files, each highlighting different aspects of CoMID usage.

### comid-cca-mult-refval.json
Copy link
Contributor

@thomas-fossati thomas-fossati Jan 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

(I thought I had made this comment in the previous review cycle, but I cannot find it here, so...)

Rather than making verbatim copies of the files (which will eventually go out of sync), it's better to reference the originals here.

GitHub has a "code snippet" functionality that comes in handy: by copying the permalink to the JSON file (and adding the wanted lines range), the file is embedded in the rendered markdown -- which is pretty cool.

Copy link
Contributor

Choose a reason for hiding this comment

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

To be a bit more concrete: using the permalink to comid-cca-mult-refval.json (including explicit line range) https://github.com/veraison/cocli/blob/0d8fae8210ae527589792de2fba54442302380f7/data/comid/templates/comid-cca-mult-refval.json#L1-L93 will render as:

cocli/data/comid/templates/comid-cca-mult-refval.json

Lines 1 to 93 in 0d8fae8

{
"lang": "en-GB",
"tag-identity": {
"id": "43BBE37F-2E61-4B33-AED3-53CFF1428B16",
"version": 0
},
"entities": [
{
"name": "ACME Ltd.",
"regid": "https://acme.example",
"roles": [
"tagCreator",
"creator",
"maintainer"
]
}
],
"triples": {
"reference-values": [
{
"environment": {
"class": {
"id": {
"type": "psa.impl-id",
"value": "YWNtZS1pbXBsZW1lbnRhdGlvbi1pZC0wMDAwMDAwMDE="
},
"vendor": "ACME",
"model": "RoadRunner"
}
},
"measurements": [
{
"key": {
"type": "psa.refval-id",
"value": {
"label": "BL",
"version": "2.1.0",
"signer-id": "rLsRx+TaIXIFUjzkzhokWuGiOa48a/2eeHH35di66Gs="
}
},
"value": {
"digests": [
"sha-256:h0KPxSKAPTEGXnvOPPA/5HUJZjHl4Hu9eg/eYMTPJcc="
]
}
},
{
"key": {
"type": "psa.refval-id",
"value": {
"label": "PRoT",
"version": "1.3.5",
"signer-id": "rLsRx+TaIXIFUjzkzhokWuGiOa48a/2eeHH35di66Gs="
}
},
"value": {
"digests": [
"sha-256:AmOCmYm2/ZVPcrqvL8ZLwuLwHWktTecphuqAj26ZgT8="
]
}
},
{
"key": {
"type": "psa.refval-id",
"value": {
"label": "ARoT",
"version": "0.1.4",
"signer-id": "rLsRx+TaIXIFUjzkzhokWuGiOa48a/2eeHH35di66Gs="
}
},
"value": {
"digests": [
"sha-256:o6XnFfDMV0pzw/m+u2vCTzL/1bZ7OHJEwskJ2neaFHg="
]
}
},
{
"key": {
"type": "cca.platform-config-id",
"value": "cfg v1.0.0"
},
"value": {
"raw-value": {
"type": "bytes",
"value": "cmF3dmFsdWUKcmF3dmFsdWUK"
}
}
}
]
}
]
}
}

```
{
"lang": "en-GB",
"tag-identity": {
"id": "43BBE37F-2E61-4B33-AED3-53CFF1428B16",
"version": 0
},
"entities": [
{
"name": "ACME Ltd.",
"regid": "https://acme.example",
"roles": [
"tagCreator",
"creator",
"maintainer"
]
}
],
"triples": {
"reference-values": [
{
"environment": {
"class": {
"id": {
"type": "psa.impl-id",
"value": "YWNtZS1pbXBsZW1lbnRhdGlvbi1pZC0wMDAwMDAwMDE="
},
"vendor": "ACME",
"model": "RoadRunner"
}
},
"measurements": [
{
"key": {
"type": "psa.refval-id",
"value": {
"label": "BL",
"version": "2.1.0",
"signer-id": "rLsRx+TaIXIFUjzkzhokWuGiOa48a/2eeHH35di66Gs="
}
},
"value": {
"digests": [
"sha-256:h0KPxSKAPTEGXnvOPPA/5HUJZjHl4Hu9eg/eYMTPJcc="
]
}
},
{
"key": {
"type": "psa.refval-id",
"value": {
"label": "PRoT",
"version": "1.3.5",
"signer-id": "rLsRx+TaIXIFUjzkzhokWuGiOa48a/2eeHH35di66Gs="
}
},
"value": {
"digests": [
"sha-256:AmOCmYm2/ZVPcrqvL8ZLwuLwHWktTecphuqAj26ZgT8="
]
}
},
{
"key": {
"type": "psa.refval-id",
"value": {
"label": "ARoT",
"version": "0.1.4",
"signer-id": "rLsRx+TaIXIFUjzkzhokWuGiOa48a/2eeHH35di66Gs="
}
},
"value": {
"digests": [
"sha-256:o6XnFfDMV0pzw/m+u2vCTzL/1bZ7OHJEwskJ2neaFHg="
]
}
},
{
"key": {
"type": "cca.platform-config-id",
"value": "cfg v1.0.0"
},
"value": {
"raw-value": {
"type": "bytes",
"value": "cmF3dmFsdWUKcmF3dmFsdWUK"
}
}
}
]
}
]
}
}
```

[comid-cca-mult-refval.json](https://github.com/veraison/cocli/blob/0d8fae8210ae527589792de2fba54442302380f7/data/comid/templates/comid-cca-mult-refval.json#L1-L93)
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this work as intended? I understand from the GitHub docs you just need to slap the bare permalink URI on a separate line, without any wrapping.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yaa this does not works as intended, i will add bare permalink

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@thomas-fossati sir a also tried bare link but it does not work as intended

Copy link
Contributor

Choose a reason for hiding this comment

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

It's because you are working on a fork (I think). To work, the permalink must refer to the local repo. Try and test it with a permalink to the same files but in the ravjot07/cocli repo. If that works (it should), just replace them with the permalinks to the veraison/cocli copies. Leap of faith! :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure @thomas-fossati i will give it a try


**Key Points**

Expand Down
Loading