Skip to content

Commit 13f5dd9

Browse files
committed
docs: add a security docs page and a 'security' menu
It was not obvious that the security related information would be on the releases page. I also think security is important enough to deserve to be on top-level.
1 parent 1eefa2a commit 13f5dd9

6 files changed

Lines changed: 74 additions & 18 deletions

File tree

_menu.html

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,15 @@
4848
<li class="sitenav-subgroup">
4949
<a href="/docs/reldocs.html">Releases</a>
5050
<ul class="sitenav-submenu-nested">
51-
<li><a href="/docs/security.html">Security</a></li>
52-
<li><a href="/docs/verify.html">Verify</a></li>
51+
<li><a href="/docs/releases.html">Release log</a></li>
5352
<li><a href="/docs/versions.html">Version numbers</a></li>
54-
<li><a href="/docs/vulnerabilities.html">Vulnerabilities</a></li>
53+
</ul>
54+
</li>
55+
<li class="sitenav-subgroup">
56+
<a href="/docs/secdocs.html">Security</a>
57+
<ul class="sitenav-submenu-nested">
58+
<li><a href="/docs/security.html">curl CVEs</a></li>
59+
<li><a href="/docs/vulnerabilities.html">Vulnerability table</a></li>
5560
</ul>
5661
</li>
5762
<li class="sitenav-subgroup">

docs/Makefile

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -271,10 +271,11 @@ PAGES = \
271271
reldocs.html \
272272
releases.csv \
273273
releases.html \
274-
security.html \
275-
security-m.html \
276-
security-h.html \
274+
secdocs.html \
277275
security-c.html \
276+
security-h.html \
277+
security-m.html \
278+
security.html \
278279
ssl-ciphers.html \
279280
ssl-compared.html \
280281
sslcerts.html \
@@ -315,6 +316,9 @@ projdocs.html: _projdocs.html $(MAINPARTS)
315316
reldocs.html: _reldocs.html $(MAINPARTS)
316317
$(ACTION)
317318

319+
secdocs.html: _secdocs.html $(MAINPARTS)
320+
$(ACTION)
321+
318322
protdocs.html: _protdocs.html $(MAINPARTS)
319323
$(ACTION)
320324

docs/_menu.html

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,18 @@
5858
SITENAV_GROUP_OPEN(Releases)
5959
SITENAV_OVERVIEW(/docs/reldocs.html, Releases overview)
6060
<li><a href="/ch/">Changelog</a></li>
61-
<li><a href="/docs/security.html">curl CVEs</a></li>
6261
<li><a href="/docs/releases.html">Release Table</a></li>
6362
<li><a href="/docs/versions.html">Version Numbering</a></li>
6463
<li><a href="/docs/verify.html">Verify</a></li>
65-
<li><a href="/docs/vulnerabilities.html">Vulnerabilities</a></li>
64+
SITENAV_GROUP_CLOSE
65+
66+
SITENAV_GROUP_OPEN(Security)
67+
SITENAV_OVERVIEW(/docs/secdocs.html, Security overview)
68+
<li><a href="/docs/audits.html">Security Audits</a></li>
69+
<li><a href="/docs/security.html">curl CVEs</a></li>
70+
<li><a href="/dev/advisory.html">Security advisory details</a></li>
71+
<li><a href="/docs/vulnerabilities.html">Vulnerability table</a></li>
72+
<li><a href="/dev/vuln-disclosure.html">Vulnerability Disclosure Policy</a></li>
6673
SITENAV_GROUP_CLOSE
6774

6875
SITENAV_GROUP_OPEN(Tool)

docs/_projdocs.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@
1717
<div class="relatedbox">
1818
<b>Related:</b>
1919
<br><a href="/docs/">Docs Overview</a>
20+
<br><a href="/dev/">Development docs</a>
2021
<br><a href="reldocs.html">Release docs</a>
22+
<br><a href="secdocs.html">Security docs</a>
2123
</div>
2224
<p>
2325
This section is for documentation associated to the project to some degree.

docs/_reldocs.html

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@
1818
<b>Related:</b>
1919
<br><a href="/docs/">Docs Overview</a>
2020
<br><a href="projdocs.html">Project docs</a>
21+
<br><a href="secdocs.html">Security docs</a>
2122
</div>
2223
<p>
23-
Information about and related to curl releases and security.
24+
Information about and related to curl releases.
2425

2526
<ul>
2627
<li>
@@ -32,19 +33,10 @@
3233
<li>
3334
<a href="releases.html">Release Table</a> - lists all releases, with release
3435
date, number of bug fixes and so on.
35-
<li>
36-
<a href="security.html">curl CVE page</a> - all publicized security problems
37-
listed and thoroughly described.
3836
<li>
3937
<a href="verify.html">verify</a> curl and how curl is verified
4038
<li>
4139
<a href="versions.html">version numbering</a> - described
42-
<li>
43-
<a href="vulnerabilities.html">vulnerabilities</a> - shows which
44-
versions that are vulnerable to each problem.
45-
<li>
46-
<a href="/dev/vuln-disclosure.html">Vulnerability Disclosure Policy</a>
47-
4840
</ul>
4941

5042
#include "_footer.html"

docs/_secdocs.html

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
#include "_doctype.html"
2+
<html>
3+
<head> <title>curl - Security Documentation</title>
4+
#include "css.t"
5+
</head>
6+
7+
#define CURL_DOCS
8+
#define CURL_URL docs/secdocs.html
9+
10+
#define SEC_DOCS
11+
#include "_menu.html"
12+
#include "setup.t"
13+
14+
WHERE2(Docs, "/docs/", Security)
15+
16+
TITLE(Security)
17+
<div class="relatedbox">
18+
<b>Related:</b>
19+
<br><a href="/docs/">Docs Overview</a>
20+
<br><a href="/dev/">Development docs</a>
21+
<br><a href="projdocs.html">Project docs</a>
22+
<br><a href="reldocs.html">Release docs</a>
23+
</div>
24+
<p>
25+
Information related to curl security.
26+
27+
<ul>
28+
<li>
29+
<a href="audits.html">Security Audits</a> - listed, including results and
30+
reports.
31+
<li>
32+
<a href="security.html">curl CVE page</a> - all publicized security problems
33+
listed and thoroughly described.
34+
<li><a href="/dev/advisory.html">Security advisory details</a> - how to write
35+
a curl security advisory.
36+
<li>
37+
<a href="vulnerabilities.html">vulnerability table</a> - shows which
38+
versions that are vulnerable to each problem.
39+
<li>
40+
<a href="/dev/vuln-disclosure.html">Vulnerability Disclosure Policy</a> -
41+
where to report them and how we deal with vulnerability reports
42+
</ul>
43+
44+
#include "_footer.html"
45+
</body>
46+
</html>

0 commit comments

Comments
 (0)