Skip to content

Commit 723e332

Browse files
authored
[docsy] Create Projects section under docs (#97)
1 parent 54cca6a commit 723e332

File tree

7 files changed

+43
-32
lines changed

7 files changed

+43
-32
lines changed

content/en/about.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ menu: { main: { weight: 10 } }
1010

1111
{{% blocks/section color="white" %}}
1212

13-
{{% param whatIsTUF %}} [Learn more](/docs/overview/).
13+
{{% param whatIsTUF %}}
14+
15+
To learn more, see [TUF overview](/docs/overview/) and
16+
[project details](/docs/project/).
1417

1518
## Governance
1619

@@ -19,24 +22,21 @@ Foundation][CNCF]. The consensus builder for TUF is [Prof. Justin Cappos] of the
1922
[Secure Systems Lab] at [New York University](https://engineering.nyu.edu/). Project
2023
maintainers <sup>[[1]][[2]]</sup> are comprised of collaborators from academia and
2124
the industry. Contributors and maintainers are governed by the [CNCF Community Code
22-
of Conduct][CoC].
25+
of Conduct][CoC]. For details, see [Governance].
2326

2427
## Funding
2528

26-
This material is based upon work supported by the [National Science
27-
Foundation][NSF] under Grant Nos. CNS-1345049 and CNS-0959138. Any opinions,
28-
findings, and conclusions or recommendations expressed in this material are
29-
those of the author(s) and do not necessarily reflect the views of the National
30-
Science Foundation.
29+
{{% param funding %}}
3130

3231
[1]:
3332
https://github.com/theupdateframework/specification/blob/master/MAINTAINERS.md
3433
[2]:
3534
https://github.com/theupdateframework/python-tuf/blob/develop/docs/MAINTAINERS.txt
3635
[CNCF]: https://cncf.io
3736
[CoC]: https://github.com/cncf/foundation/blob/master/code-of-conduct.md
37+
[Governance]:
38+
https://github.com/theupdateframework/specification/blob/master/GOVERNANCE.md
3839
[Linux Foundation]: https://www.linuxfoundation.org
39-
[NSF]: https://www.nsf.gov
4040
[Prof. Justin Cappos]: https://ssl.engineering.nyu.edu/personalpages/jcappos/
4141
[Secure Systems Lab]: https://ssl.engineering.nyu.edu
4242

content/en/docs/overview/project/_index.md renamed to content/en/docs/project/_index.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
---
22
title: Project
3-
LinkTitle: Project
4-
weight: 20
5-
description: Learn more about the TUF project
6-
liases: [/project]
3+
aliases: [/project]
4+
weight: 400
75
---
86

97
The TUF project consists of three components:
@@ -25,12 +23,12 @@ academics, professional developers, and contributors from the open-source
2523
community. We especially acknowledge the individuals from the open-source
2624
community who have [contributed] to the TUF project over the years.
2725

28-
Please visit the [governance page] to learn how project decisions are made, and for
29-
a more detailed explanation of the project roles used below.
26+
To learn how project decisions are made, and for a more detailed explanation of
27+
the project roles used below, see [Governance].
3028

3129
[contributed]:
3230
https://github.com/theupdateframework/python-tuf/blob/develop/docs/AUTHORS.txt
33-
[governance page]:
31+
[Governance]:
3432
https://github.com/theupdateframework/specification/blob/master/GOVERNANCE.md
3533
[Specification]: https://theupdateframework.github.io/specification/latest
3634
[Standardization process]:
@@ -41,11 +39,9 @@ a more detailed explanation of the project roles used below.
4139

4240
### Justin Cappos
4341

44-
45-
46-
GitHub username: [JustinCappos](https://github.com/justincappos)
47-
48-
PGP fingerprint: E9C0 59EC 0D32 64FA B35F 94AD 465B F9F6 F8EB 475A
42+
Email: [[email protected]](mailto:[email protected])<br> GitHub username:
43+
[JustinCappos](https://github.com/justincappos)<br> PGP fingerprint:
44+
`E9C0 59EC 0D32 64FA B35F 94AD 465B F9F6 F8EB 475A`
4945

5046
## Maintainers
5147

content/en/docs/project/funding.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Funding
3+
aliases: [/funding]
4+
---
5+
6+
{{% param funding %}}

content/en/docs/history.md renamed to content/en/docs/project/history.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
22
title: History
3-
weight: 418
4-
description: Learn TUF history and core principles
3+
description: TUF history and core principles
54
aliases: [/history]
5+
cSpell:ignore: Dingledine Tandon Trishank Karthik Kuppusamy Diaz Sebastien Awwad
66
---
77

88
The basic technology behind TUF was developed at the University of Washington in
9-
2009 by Justin Samuel and Justin Cappos, and presented in a
10-
[paper](https://theupdateframework.github.io/papers/survivable-key-compromise-ccs2010.pdf?raw=true)
11-
Samuel and Cappos coauthored with Nick Mathewson and Roger Dingledine,
12-
researchers from [The Tor Project, Inc](https://www.torproject.org/). Since
13-
2011, TUF has been based at
9+
2009 by Justin Samuel and Justin Cappos, and presented in a [paper] Samuel and
10+
Cappos coauthored with Nick Mathewson and Roger Dingledine, researchers from
11+
[The Tor Project, Inc](https://www.torproject.org/). Since 2011, TUF has been
12+
based at
1413
[New York University Tandon School of Engineering](https://engineering.nyu.edu/),
1514
where Cappos is a tenured associate professor of computer science and
1615
engineering. There he works with a team of Ph.D. students, including Trishank
@@ -35,3 +34,6 @@ four core principles continue to be central to its design.
3534
- Lastly, TUF keeps the most vulnerable signing keys offline, which greatly
3635
reduces the risk that they can be stolen or compromised. In 2016, the TUF
3736
research group set up a process whereby the community could
37+
38+
[paper]:
39+
https://theupdateframework.github.io/papers/survivable-key-compromise-ccs2010.pdf?raw=true

content/en/docs/timeline.md renamed to content/en/docs/project/timeline.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
---
22
title: Timeline
3-
weight: 419
4-
Description: See the project timeline
53
aliases: [/timeline]
64
---
75

content/en/docs/security/reporting.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ aliases: [/reporting]
44
---
55

66
Security issues can be reported by emailing
7+
[Justin Cappos](/docs/project/#justin-cappos) at
78
89

910
If at all possible, please include the following information in the report:

hugo.yaml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,14 @@ languages:
4444
repository or signing keys. TUF provides a flexible framework and
4545
[specification](/specification/latest)
4646
that developers can adopt into any software update system.
47+
funding: |
48+
This material is based upon work supported by the [National Science
49+
Foundation][NSF] under Grant Nos. CNS-1345049 and CNS-0959138. Any opinions,
50+
findings, and conclusions or recommendations expressed in this material are
51+
those of the author(s) and do not necessarily reflect the views of the National
52+
Science Foundation.
53+
54+
[NSF]: https://www.nsf.gov
4755
4856
#
4957
# Markup and imaging
@@ -72,7 +80,7 @@ params:
7280
copyright:
7381
authors: >-
7482
TUF Authors | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0) |
75-
[Funding](/about/#funding) |
83+
[Funding](/docs/project/funding/) |
7684
# from_year: 2024
7785
github_repo: https://github.com/theupdateframework
7886
gcs_engine_id: 011217106833237091527:la2vtv2emlw # CUSTOMIZE # FIXME get an ID for the starter?
@@ -85,11 +93,11 @@ params:
8593
enable: false # FIXME: setting to false until the feedback can be better configured
8694
'yes': >-
8795
Glad to hear it! Please <a
88-
href="https://github.com/google/docsy/issues/new">tell us how we can
96+
href="https://github.com/ORG/PROJECT/issues/new">tell us how we can
8997
improve</a>.
9098
'no': >-
9199
Sorry to hear that. Please <a
92-
href="https://github.com/google/docsy/issues/new">tell us how we can
100+
href="https://github.com/ORG/PROJECT/issues/new">tell us how we can
93101
improve</a>.
94102
links:
95103
user:

0 commit comments

Comments
 (0)