Skip to content

Commit 594a6ab

Browse files
authored
[docsy] Streamline and refactor Getting started section (#100)
1 parent 3dd5526 commit 594a6ab

File tree

6 files changed

+53
-70
lines changed

6 files changed

+53
-70
lines changed

content/en/_index.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ developer_note: |
1717
{.display-6}
1818

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

2323
{{% /blocks/cover%}}
@@ -41,9 +41,8 @@ Used in production by various tech companies and open source organizations.
4141

4242
{{% /blocks/feature %}}
4343

44-
{{% blocks/feature icon="fa-brands fa-github" title="Contribute" url="https://github.com/theupdateframework" %}}
45-
Start contributing to TUF open source by creating a Pull request on
46-
[GitHub](https://github.com/theupdateframework)
44+
{{% blocks/feature icon="fa-brands fa-github" title="Contribute" url="/docs/contributing" %}}
45+
Get involved! Start contributing to TUF.
4746

4847
{{% /blocks/feature %}}
4948

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
2-
title: Contributor
3-
weight: 17
4-
description: Learn how to contribute to TUF
2+
title: Contributing
3+
weight: 700
54
---
65

76
There are many opportunities to contribute to TUF project. You can contribute to
@@ -12,4 +11,4 @@ For guidance on how to contribute, see the
1211

1312
For more information on how to contribute, reach out to the
1413
[TUF community site](/community/) or check out areas of contribution on GitHub
15-
[The Update Framework](https://github.com/theupdateframework).
14+
[The Update Framework]({{% param github_repo %}}).

content/en/docs/get-started/_index.md

-21
This file was deleted.

content/en/docs/get-started/adopter.md

-38
This file was deleted.

content/en/docs/getting-started.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Getting started
3+
aliases: [/implementations]
4+
cSpell:ignore: RSTUF
5+
weight: 200
6+
---
7+
8+
TUF provides a framework for integration of the [security](../security/)
9+
properties into new and existing content delivery systems. This page will help
10+
you get started if you want to use TUF either as a maintainer or client.
11+
12+
While some [adoptions](/community/adoptions/) integrate TUF by implementing the
13+
framework from scratch, others start from either a TUF
14+
[implementation](#implementations) or from a TUF [system](#systems). This page
15+
lists open source implementations of TUF which can be used as building blocks
16+
for any TUF adoption.
17+
18+
## Implementations
19+
20+
TUF implementations provide libraries implementing the primitives and
21+
algorithms, such as the detailed client workflow, in the specification.
22+
23+
- [python-tuf](https://github.com/theupdateframework/python-tuf), the reference
24+
implementation
25+
- [go-tuf](https://github.com/theupdateframework/go-tuf/)
26+
- [tuf-js](https://github.com/theupdateframework/tuf-js)
27+
28+
## Systems
29+
30+
TUF systems build on top of library implementations and provide opinionated
31+
signing systems designed for particular use-cases.
32+
33+
- [Repository Service for TUF](https://repository-service-tuf.readthedocs.io/en/stable/)
34+
(RSTUF) is a designed to integrate into an existing artifact repository with
35+
an established storage and delivery system.
36+
- [tuf-on-ci](https://github.com/theupdateframework/tuf-on-ci/) is a TUF
37+
repository and signing tool designed to operate on a CI system and guide
38+
signing events through Git forge workflows.
39+
40+
## Learn more
41+
42+
- Some of our [Videos](/resources/videos/) explain how to implement TUF
43+
practically.
44+
- To learn about how to contribute to TUF, see [Contributing](../contributing).

hugo.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ params:
8282
TUF Authors | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0) |
8383
[Funding](/docs/project/funding/) |
8484
# from_year: 2024
85-
github_repo: https://github.com/theupdateframework
85+
github_repo: &repo https://github.com/theupdateframework/theupdateframework.io
8686
gcs_engine_id: 011217106833237091527:la2vtv2emlw # CUSTOMIZE # FIXME get an ID for the starter?
8787
privacy_policy: https://www.linuxfoundation.org/legal/privacy-policy
8888
ui:
@@ -120,9 +120,9 @@ params:
120120
desc: Join our community meetings.
121121
developer:
122122
- name: GitHub repository
123-
url: https://github.com/theupdateframework/theupdateframework.io
123+
url: *repo
124124
icon: fa-brands fa-github
125-
desc: Website repository.
125+
desc: Website and documentation repository.
126126

127127
module:
128128
mounts:

0 commit comments

Comments
 (0)