From 1d117106bdf8f131c466ed1786c11e583142d608 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 18 Apr 2019 15:46:48 +0100 Subject: [PATCH 1/2] docs: Fix markdown Make examples headings unique so that both sets of examples can be accessed from the TOC. Partially fixes: #91. Signed-off-by: James O. D. Hunt --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 13d3d4c5e8..ff147649c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ * [Main patch](#main-patch) * [Supplementary patch](#supplementary-patch) * [Reviews](#reviews) - * [Examples](#examples) + * [Review Examples](#review-examples) * [Continuous Integration](#continuous-integration) * [Contact](#contact) * [Project maintainers](#project-maintainers) @@ -776,7 +776,7 @@ in the acknowledgement counting system. Documentation PRs can sometimes use a modified process explained in the [Documentation Review Process](Documentation-Review-Process.md) guide. -### Examples +### Review Examples The following is an example of a valid "ack", as long as the 'Approve' box is ticked in the Review changes dialog: From 66f888990b55ceb2c80b8c14a1495293030908ba Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 18 Apr 2019 15:48:07 +0100 Subject: [PATCH 2/2] docs: Fix markdown links Correct a few broken markdown links. Fixes #91. Signed-off-by: James O. D. Hunt --- VMT/VMT.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/VMT/VMT.md b/VMT/VMT.md index 7a5162ebff..191f695c3d 100644 --- a/VMT/VMT.md +++ b/VMT/VMT.md @@ -53,7 +53,7 @@ If no KCSA is warranted and there is no benefit to a KCSN then the KCSA Issue wi If a Kata Containers Security Note ([KCSN](templates/KCSN.md)) is warranted, one should be written and posted to the [Kata Containers Security Note](https://github.com/kata-containers/documentation/security/KCSN.md) document. -The specifics are indexed in the [report taxonomy](#incident-report-taxonomy) and [task status](#KCSA-task-status) tables. +The specifics are indexed in the [report taxonomy](#incident-report-taxonomy) and [task status](#kcsa-task-status) tables. ## Patch development @@ -127,12 +127,12 @@ On the disclosure hour, open bug, push patches to GitHub PR for review on master Embargo reminder can be removed at that point. -[MITRE's CVE Request form](https://cveform.mitre.org/) should be used again at this point, but instead select a *request type* of `Notify CVE about a publication` and fill in the coordinator's *e-mail address*, provide a *link to the advisory* (Use the links from the [Kata Containers Security Advisories page](https://github.com/kata-containers/documentation/security/KCSA.md) if this is a formal KCSA), the *CVE IDs* covered, and the *date published*. +[MITRE's CVE Request form](https://cveform.mitre.org/) should be used again at this point, but instead select a *request type* of `Notify CVE about a publication` and fill in the coordinator's *e-mail address*, provide a *link to the advisory* (Use the links from the [Kata Containers Security Advisories page](KCSA.md) if this is a formal KCSA), the *CVE IDs* covered, and the *date published*. Once more, fill in the *security code* at the bottom of the page and *submit request*. ## Publish KCSA -Shortly after pushing the patches (potentially waiting for the first test runs to complete), publish the advisory to the [Kata Containers Dev ML](mailto:kata-dev@lists.katacontainers.io) and slack channels, and add the issue to the [list of KCSA's](//github.com/kata-containers/documentation/security/KCSA.md). +Shortly after pushing the patches (potentially waiting for the first test runs to complete), publish the advisory to the [Kata Containers Dev ML](mailto:kata-dev@lists.katacontainers.io) and slack channels, and add the issue to the [list of KCSA's](KCSA.md). Wait until all patches are merged to supported branches before setting the KCSA Issue status to *Fix released*. ## All patches merged