Skip to content

Commit 2d329a2

Browse files
committed
[docsy] Add About page to hold project and grant info
1 parent 5248f63 commit 2d329a2

File tree

5 files changed

+55
-12
lines changed

5 files changed

+55
-12
lines changed

.cspell.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,6 @@ languageSettings:
2323
ignoreRegExpList:
2424
- CodeBlock
2525
words:
26+
- Cappos
2627
- CNCF
2728
- Docsy

.htmltest.yml

+1
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ IgnoreInternalEmptyHash: true # FIXME
88
IgnoreInternalURLs: # list of paths
99
IgnoreURLs: # list of regexs of paths or URLs to be ignored
1010
- ^https://twitter.com/docsydocs$
11+
- ^/specs

content/en/_index.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,15 @@ developer_note: |
1616
{{% param description %}}
1717
{.display-6}
1818

19-
<a class="btn btn-lg btn-primary me-3" href="docs/">Learn More</a>
19+
<a class="btn btn-lg btn-primary me-3" href="docs/overview/">Learn More</a>
2020
<a class="btn btn-lg btn-secondary" href="docs/get-started/">Get started</a>
2121
{.p-initial .my-5}
2222

2323
{{% /blocks/cover%}}
2424

2525
{{% blocks/lead color="tertiary" %}}
2626

27-
The Update Framework (TUF) maintains the security of software update systems,
28-
providing protection even against attackers that compromise the repository or
29-
signing keys. TUF provides a flexible framework and
30-
[specification](https://theupdateframework.github.io/specification/latest/) that
31-
developers can adopt into any software update system.
27+
{{% param whatIsTUF %}}
3228

3329
{{% /blocks/lead %}}
3430

content/en/about.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: About The Update Framework
3+
linkTitle: About
4+
menu: { main: { weight: 10 } }
5+
---
6+
7+
{{% blocks/cover title="About The Update Framework" height="auto" %}}
8+
9+
{{% /blocks/cover %}}
10+
11+
{{% blocks/section color="white" %}}
12+
13+
{{% param whatIsTUF %}} [Learn more](/docs/overview/).
14+
15+
{{% param projectAndGrants %}}
16+
17+
{{% /blocks/section %}}

hugo.yaml

+34-6
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,34 @@ languages:
3838
languageCode: en-US
3939
params:
4040
description: A Framework for securing software update systems
41+
whatIsTUF: |
42+
The Update Framework (TUF) maintains the security of software update
43+
systems, providing protection even against attackers that compromise the
44+
repository or signing keys. TUF provides a flexible framework and
45+
[specification](/specs/)
46+
that developers can adopt into any software update system.
47+
projectAndGrants: |
48+
The TUF project is managed by the [Linux Foundation] under the [Cloud
49+
Native Computing Foundation][CNCF]. The consensus builder for TUF is [Prof.
50+
Justin Cappos](https://ssl.engineering.nyu.edu/personalpages/jcappos/)
51+
of the [Secure Systems Lab](https://ssl.engineering.nyu.edu) at [New
52+
York University](https://engineering.nyu.edu/). Project
53+
maintainers [[1]][[2]]
54+
are comprised of collaborators from academia and the industry.
55+
Contributors and maintainers are governed by the [CNCF Community Code of
56+
Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
57+
58+
This material is based upon work supported by the [National Science
59+
Foundation][NSF] under Grant Nos. CNS-1345049 and CNS-0959138. Any opinions,
60+
findings, and conclusions or recommendations expressed in this material
61+
are those of the author(s) and do not necessarily reflect the views of
62+
the National Science Foundation.
63+
64+
[1]: https://github.com/theupdateframework/specification/blob/master/MAINTAINERS.md
65+
[2]: https://github.com/theupdateframework/python-tuf/blob/develop/docs/MAINTAINERS.txt
66+
[CNCF]: https://cncf.io
67+
[Linux Foundation]: https://www.linuxfoundation.org
68+
[NSF]: https://www.nsf.gov
4169
4270
#
4371
# Markup and imaging
@@ -65,7 +93,7 @@ imaging:
6593
params:
6694
copyright:
6795
authors: >-
68-
The Update Framework Authors| [CC BY
96+
The Update Framework Authors | Docs [CC BY
6997
4.0](https://creativecommons.org/licenses/by/4.0) |
7098
# from_year: 2024
7199
github_repo: https://github.com/theupdateframework
@@ -85,25 +113,25 @@ params:
85113
Sorry to hear that. Please <a
86114
href="https://github.com/google/docsy/issues/new">tell us how we can
87115
improve</a>.
88-
links: # CUSTOMIZE
116+
links:
89117
user:
90118
- name: TUF Google group
91119
url: https://groups.google.com/g/theupdateframework
92120
icon: fa-solid fa-envelope
93-
desc: Sign up for TUF announcements
121+
desc: Sign up for TUF announcements.
94122
- name: Slack channel
95123
url: https://communityinviter.com/apps/cloud-native/cncf
96124
icon: fa-brands fa-slack
97-
desc: Connect with us on CNCF Slack channel for TUF
125+
desc: Connect with us on CNCF Slack channel for TUF.
98126
- name: Community meetings
99127
url: https://github.com/theupdateframework/community?tab=readme-ov-file
100128
icon: fa-regular fa-calendar-days
101-
desc: Join our community meetings
129+
desc: Join our community meetings.
102130
developer:
103131
- name: GitHub repository
104132
url: https://github.com/theupdateframework/theupdateframework.io
105133
icon: fa-brands fa-github
106-
desc: Development takes place here!
134+
desc: Website repository.
107135

108136
module:
109137
mounts:

0 commit comments

Comments
 (0)