Skip to content

[docsy] Streamline and refactor Getting started section #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ developer_note: |
{.display-6}

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

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

{{% /blocks/feature %}}

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

{{% /blocks/feature %}}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Contributor
weight: 17
description: Learn how to contribute to TUF
title: Contributing
weight: 700
---

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

For more information on how to contribute, reach out to the
[TUF community site](/community/) or check out areas of contribution on GitHub
[The Update Framework](https://github.com/theupdateframework).
[The Update Framework]({{% param github_repo %}}).
21 changes: 0 additions & 21 deletions content/en/docs/get-started/_index.md

This file was deleted.

38 changes: 0 additions & 38 deletions content/en/docs/get-started/adopter.md

This file was deleted.

44 changes: 44 additions & 0 deletions content/en/docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Getting started
aliases: [/implementations]
cSpell:ignore: RSTUF
weight: 200
---

TUF provides a framework for integration of the [security](../security/)
properties into new and existing content delivery systems. This page will help
you get started if you want to use TUF either as a maintainer or client.

While some [adoptions](/community/adoptions/) integrate TUF by implementing the
framework from scratch, others start from either a TUF
[implementation](#implementations) or from a TUF [system](#systems). This page
lists open source implementations of TUF which can be used as building blocks
for any TUF adoption.

## Implementations

TUF implementations provide libraries implementing the primitives and
algorithms, such as the detailed client workflow, in the specification.

- [python-tuf](https://github.com/theupdateframework/python-tuf), the reference
implementation
- [go-tuf](https://github.com/theupdateframework/go-tuf/)
- [tuf-js](https://github.com/theupdateframework/tuf-js)

## Systems

TUF systems build on top of library implementations and provide opinionated
signing systems designed for particular use-cases.

- [Repository Service for TUF](https://repository-service-tuf.readthedocs.io/en/stable/)
(RSTUF) is a designed to integrate into an existing artifact repository with
an established storage and delivery system.
- [tuf-on-ci](https://github.com/theupdateframework/tuf-on-ci/) is a TUF
repository and signing tool designed to operate on a CI system and guide
signing events through Git forge workflows.

## Learn more

- Some of our [Videos](/resources/videos/) explain how to implement TUF
practically.
- To learn about how to contribute to TUF, see [Contributing](../contributing).
6 changes: 3 additions & 3 deletions hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ params:
TUF Authors | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0) |
[Funding](/docs/project/funding/) |
# from_year: 2024
github_repo: https://github.com/theupdateframework
github_repo: &repo https://github.com/theupdateframework/theupdateframework.io
gcs_engine_id: 011217106833237091527:la2vtv2emlw # CUSTOMIZE # FIXME get an ID for the starter?
privacy_policy: https://www.linuxfoundation.org/legal/privacy-policy
ui:
Expand Down Expand Up @@ -120,9 +120,9 @@ params:
desc: Join our community meetings.
developer:
- name: GitHub repository
url: https://github.com/theupdateframework/theupdateframework.io
url: *repo
icon: fa-brands fa-github
desc: Website repository.
desc: Website and documentation repository.

module:
mounts:
Expand Down