You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Type: `String`, one of the `overview`, `quick_start`, `tutorial`, `how_to`, `reference`.
219
+
- Optional.
220
+
221
+
### `topics`
222
+
- Purpose: Indicate the topics covered by the article.
223
+
- Type: `String`
224
+
- Optional.
225
+
226
+
189
227
### Escaping single quotes
190
228
191
229
If you see two single quotes in a row (`''`) in YML frontmatter where you might expect to see one (`'`), this is the YML-preferred way to escape a single quote. From [the YAML spec](https://yaml.org/spec/history/2001-12-10.html):
@@ -274,3 +312,15 @@ Sometimes you want to link to a Dotcom-only article in Enterprise content and yo
274
312
```
275
313
276
314
Sometimes the canonical home of content moves outside the docs site. None of the links included in [`lib/redirects/external-sites.json`](/lib/redirects/external-sites.json) get rewritten. See [`contributing/redirects.md`](/contributing/redirects.md) for more info about this type of redirect.
315
+
316
+
317
+
### Creating new sublanding pages
318
+
319
+
To create a sublanding page (e.g. [Actions' Guide page](https://docs.github.com/en/actions/guides)), create or modify an existing markdown file with these specific frontmatter values:
320
+
321
+
1. Use the sublanding page template by referencing it `layout: product-sublanding`
322
+
2. (optional) Include the learning tracks in [`learningTracks`](#learningTracks)
323
+
3. (optional) Define which articles to include with [`includeGuides`](#includeGuides).
324
+
325
+
If using learning tracks, they need to be defined in [`data/learning-tracks/*.yml`](../data/learning-tracks/README.md).
326
+
If using `includeGuides`, make sure each of the articles in this list has [`topics`](#topics) and [`type`](#type) in its frontmatter.
Copy file name to clipboardExpand all lines: content/github/managing-security-vulnerabilities/publishing-a-security-advisory.md
+12Lines changed: 12 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,6 +24,18 @@ When you publish a security advisory, you notify your community about the securi
24
24
25
25
Before you publish a security advisory, you can privately collaborate to fix the vulnerability in a temporary private fork. For more information, see "[Collaborating in a temporary private fork to resolve a security vulnerability](/articles/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability)."
26
26
27
+
{% warning %}
28
+
29
+
**Warning**: Whenever possible, you should always add a fix version to a security advisory prior to publishing the advisory. If you don't, the advisory will be published without a fixed version, and {% data variables.product.prodname_dependabot %} will alert your users about the issue, without offering any safe version to update to.
30
+
31
+
We recommend you take the following steps in these different situations:
32
+
33
+
- If a fix version is imminently available, and you are able to, wait to disclose the issue when the fix is ready.
34
+
- If a fix version is in development but not yet available, mention this in the advisory, and edit the advisory later, after publication.
35
+
- If you are not planning to fix the issue, be clear about it in the advisory so that your users don't contact you to ask when a fix will be made. In this case, it is helpful to include steps users can take to mitigate the issue.
36
+
37
+
{% endwarning %}
38
+
27
39
When you publish a draft advisory from a public repository, everyone is able to see:
0 commit comments