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

Provide a SARIF v2.2 Seed Prose by Transcribing the v2.1.0 Errata 01 Prose to Markdown #581

Open
sthagen opened this issue May 20, 2023 · 1 comment · Fixed by #599
Open
Assignees

Comments

@sthagen
Copy link
Contributor

sthagen commented May 20, 2023

Work in progress at https://github.com/sthagen/oasis-tcs-sarif-spec/blob/versioned-spec-folders/sarif-2.2/prose/sarif-v2.2-editor-draft.md (in fork)

Using some fresh markdown boilerplate to fill in a best effort transcription of the
SARIF v2.1.0-os-errata-01 candidate prose.

We may want to refactor or change some "things" of the 2.1 era to ease future work (and reading):

  • reduce the linkage (there are approx. 1400 §#.#.# links for a tad more than 200 pages which makes on the average 7 such opaque links per page) and make more links have a "speaking" link text
  • externalize the JSON examples as example files (inside the /sarif-2.2/example/ folder)
  • explicitly name all artifacts on file level
  • rewrite tables with two columns as definition lists
  • migrate to two slot versioning (2.2) for the spec
  • ...
@sthagen sthagen self-assigned this May 20, 2023
@sthagen sthagen changed the title Provide a SARIF v2.2.0 Seed Prose by Transcribing the v2.1.0 Errata 01 Prose to Markdown Provide a SARIF v2.2 Seed Prose by Transcribing the v2.1.0 Errata 01 Prose to Markdown May 20, 2023
@schlaman-ms
Copy link

Document location for issue:

Generic issue - no specific location.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants