Dindihub / docsy-tuf.io

Changing The Update Framework Website to Docsy theme
https://deploy-preview-23--tufio.netlify.app/
Apache License 2.0
1 stars 0 forks source link

Getting started section path and title rename #27

Closed chalin closed 1 month ago

chalin commented 2 months ago

_Originally posted by @chalin in https://github.com/Dindihub/docsy-tuf.io/pull/20#discussion_r1733589100_

This page shouldn't exist under /get-started/, but we'll address this separately. I'll file an issue.

Actually, there are a few issues to address:

Dindihub commented 2 months ago

_Originally posted by @chalin in #20 (comment)_

This page shouldn't exist under /get-started/, but we'll address this separately. I'll file an issue.

Actually, there are a few issues to address:

  • [ ] Rename the get-started section to getting-started so as to match the original TUF site
  • [ ] @Dindihub, you probably based the section on the corresponding section of the OTel site, but I don't think that it makes sense here to identify "Adopters" and "Contributors" as roles here. @lukpueh WDYT?

Hi @chalin. The Get-started section was supposed to contain information for new users to understand the project.

For context, one of the key issues that came out of the TUF analysis was that the website did not have new user content. So creating this section was my attempt to have a guide for new users. I discussed it with @lukpueh and we decided to group new users into Adopters and contributors.

  1. Adopters: Integrate TUF security properties into new and existing content delivery systems. Adopters can be classified into two categories:
  1. Contributors: want to contribute either to the spec or documentation.
    • Spec contributors
    • Docs contributors

But if the section doesn't bring any value to the site I'm okay getting rid of it.

lukpueh commented 2 months ago

IMO the classification makes sense.

chalin commented 2 months ago

IMO the classification makes sense.

If it works for @lukpueh, I'm ok keep it as is.

Though, let's fix the section path name and title to match the old site.

chalin commented 2 months ago

Will close this for now, and revisit later if necessary.

chalin commented 2 months ago

Oops, forgot that the path rename was being tracked via this issue. Reopening :)

chalin commented 1 month ago

I kept the page, renaming it to Getting started, but refactored the content a bit. For details, see:

which closes this issue.

Dindihub commented 1 month ago

I kept the page, renaming it to Getting started, but refactored the content a bit. For details, see:

which closes this issue.

Noted. Thanks