Skip to content
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

Website Contains Broken Links #131

Closed
hexsecs opened this issue Nov 6, 2023 · 14 comments · Fixed by #134
Closed

Website Contains Broken Links #131

hexsecs opened this issue Nov 6, 2023 · 14 comments · Fixed by #134

Comments

@hexsecs
Copy link
Member

hexsecs commented Nov 6, 2023

Website Contains Broken Links

Broken Link Checker found ⚰️ links on https://uptane.github.io

View Results

@hexsecs
Copy link
Member Author

hexsecs commented Nov 6, 2023

This new run superscedes and closes #127

@Mikerniker
Copy link
Contributor

can I try this @hexsecs ?

@Abhijay007
Copy link
Collaborator

sure @Mikerniker go ahead

@hexsecs
Copy link
Member Author

hexsecs commented Nov 6, 2023

Thanks @Mikerniker for helping squash these! One day we will get them down to 0. A good task is also figuring out how to ignore the false positives on this test.

@Abhijay007, are you aware of a way to whitelist certain links? I would imagine there is a way to add them to the preconfig.
https://github.com/uptane/uptane.github.io/blob/main/.github/broken-link-gha-config.json

@Abhijay007
Copy link
Collaborator

Thanks @Mikerniker for helping squash these! One day we will get them down to 0. A good task is also figuring out how to ignore the false positives on this test.

@Abhijay007, are you aware of a way to whitelist certain links? I would imagine there is a way to add them to the preconfig. https://github.com/uptane/uptane.github.io/blob/main/.github/broken-link-gha-config.json

I will look into that, will open a PR for the same soon

@Mikerniker
Copy link
Contributor

ok, thanks @Abhijay007 , can you or @hexsecs help identify the new links to use:

  1. URL: https://uptane.github.io/uptane-standard/uptane-standard.html
    Parent: https://uptane.github.io/docs/learn-more/participate
    Location: Security audits
    Phrase: Uptane Standards document
    Change to: https://uptane.github.io/docs/standard/uptane-standard ?

  2. URL: https://uptane.github.io/deployment-considerations/index.html
    Parent: https://uptane.github.io/docs/1.1.0/learn-more/participate
    Change to: https://uptane.github.io/docs/deployment/best-practices

  3. URL: https://uptane.github.io/deployment-considerations/glossary.html
    Parent: https://uptane.github.io/docs/standard/uptane-standard
    Location 2 Terminology
    Phrase: glossary
    Question: What link to use?

  4. URL: https://uptane.github.io/participate.html
    Parent: https://uptane.github.io/docs/1.1.0/learn-more/audits
    Location Security Audits
    Phrase: "reach out to us"
    Question: Should I change link to: https://uptane.github.io/docs/learn-more/participate ? This is for version 1.1.0

  5. URL: https://uptane.github.io/uptane-standard/uptane-standard.html#build-time-prerequisite-requirements-for-ecus
    Parent: https://uptane.github.io/docs/deployment/best-practices
    Location: Preparing an ECU for Uptane
    Phrase: See the Uptane Standard
    Change link to: https://uptane.github.io/docs/standard/uptane-standard

BROKEN LINKS: POUF

  1. URL: https://uptane.github.io/uptane-standard/uptane-standard.html#director_repository
    Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
    Location: Message Handler Table (Table, 1st Row under Specification Reference)
    Question: Change link to: ?

  2. URL: https://uptane.github.io/uptane-standard/uptane-standard.html#send_metadata_primary
    Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
    Location: Message Handler Table (Table, last Row get_metadata)
    Question: Change link to: ?

  3. URL: https://uptane.github.io/uptane-standard/uptane-standard.html#create_version_report
    Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
    Location: Message Handler Table (Table, 4th Row submit_ecu_manifest)
    Question: Change link to: ?

  4. URL: https://uptane.github.io/uptane-standard/uptane-standard.html#send_images_primary
    Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
    Location: Message Handler Table (Table, 2nd to last Row get_image)
    Question: Change link to: ?

  5. URL: https://uptane.github.io/uptane-standard/uptane-standard.html#send_time_primary
    Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
    Location: Message Handler Table (Table, 3rd from bottom: get_time_attestation_for_ecu)
    Question: Change link to: ?

  6. URL: https://uptane.github.io/uptane-standard/uptane-standard.html#targets_images_meta
    Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
    Location: Message Handler Table (last paragraph: phrase: "Uptane Standard")
    Change link to: https://uptane.github.io/docs/standard/uptane-standard

  7. URL: https://uptane.github.io/uptane-standard/uptane-standard.html#in-vehicle-implementation-requirements
    Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
    Location: Operations section
    Phrase: "in Vehicle Implementation Requirements"
    Question: Change link to: ?

  8. URL: https://uptane.github.io/uptane-standard/uptane-standard.html#delegations_meta
    Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
    Location: Operations section, para. 4
    Phrase: "wildcards"
    Question: Change link to: ?

  9. URL: https://uptane.github.io/uptane-standard/uptane-standard.html#construct_manifest_primary
    Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
    Location: Operations section, last paragraph
    Phrase/Word: diffs
    Question: Change link to: ?

  10. URL: https://uptane.github.io/uptane-standard/uptane-standard.html#targets_role_delegations
    Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
    Location: Operations section, 4th paragraph
    Phrase/Word: "optional in the Standard"
    Change link to: https://uptane.github.io/docs/standard/uptane-standard ?

  11. URL: https://uptane.github.io/uptane-standard/uptane-standard.html#custom-metadata-about-images
    Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
    Location: Metadata section, 4th bullet point
    Phrase/Word: "Targets metadata as described in the Standard"
    Change link to: https://uptane.github.io/docs/standard/uptane-standard ?

  12. URL: https://uptane.github.io/uptane-standard/uptane-standard.html#root_meta
    Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
    Location: Metadata section, 2nd bullet point
    Phrase/Word: "mappings of roles to lists of URLs as described in TAP 5"
    Question: Change link to: ?

BROKEN LINKS: VERSION

  1. URL: https://www.d2pmagazine.com/2020/04/02/6099/
    Parent: https://uptane.github.io/docs/1.1.0/learn-more/press
    Location: Press section, 5th bullet
    Phrase/Word: Open Source Framework Helps Automakers...
    Comment: Will change to the archive.org version of the article?:
    https://web.archive.org/web/20230703104528/https://www.d2pmagazine.com/2020/04/02/6099/

BROKEN LINKS: BEST PRACTICES PAGE

  1. URL: https://uptane.github.io/deployment-considerations/normal_operation.html
    Parent: https://uptane.github.io/docs/deployment/best-practices

a. Location: Section 6.3 Adding or removing a supplier, 2nd para
Phrase: Normal Operating Procedures
Change to: ?

b. Location: 3.2 What suppliers should do, 1st para
Phrase: Normal Operating Guidelines
Change to: ?

  1. URL: https://uptane.github.io/deployment-considerations/key_management.html
    Parent: https://uptane.github.io/docs/deployment/best-practices

a.
Location: Section 3.1.1.6 Time source key compromise
Phrase: "Managing singing keys and metadata expiration"
Change to: ?

b.
Location: Section 3.3.1 Director repository
Phrase: "Managing singing keys and metadata expiration"
Change to: ?

c. Location: Section 3.3.2 Image repository
Phrase: "Managing singing keys and metadata expiration"
Change to: ?

d. Location: Section 6.4 Key compromise
Phrase: See "Key Management"
Change to: ?

  1. URL: https://uptane.github.io/deployment-considerations/security_considerations.html
    Parent: https://uptane.github.io/docs/deployment/best-practices

a. Location: Section 5.1.1 Receiving updates from tier-1 suppliers, para 3
Phrase: See "Enhanced Security Practices"
Change to: ?

b. Location: Section 6.1 Rolling back software, para 4
Phrase: See "Enhanced Security Practices"
Change to: ?

c. Location: Section 6.1 Rolling back software, para 7
Phrase: See "Enhanced Security Practices"
Change to: ?

  1. URL: https://uptane.github.io/deployment-considerations/ecus.html
    Parent: https://uptane.github.io/docs/deployment/best-practices
    Location: Section 5.1.2 Testing metadata and images, para 3
    Phrase: See the "Preparing an ECU for Uptane"
    Change to: ?

  2. URL: https://uptane.github.io/deployment-considerations/customizations.html#delta-update-strategies
    Parent: https://uptane.github.io/docs/deployment/best-practices
    Location: Section 5.2 Backup and garbage collection for the Image... para 3
    Phrase: subsection of the "Customizing Uptane" section
    Change to: ?

  3. URL: https://uptane.github.io/deployment-considerations/exceptional_operations.html#rolling-back-software
    Parent: https://uptane.github.io/docs/deployment/best-practices
    Location: Section 8.0.4 Preventing rollback attacks in case of Director...1st para
    Phrase: In the Exceptional Operations...
    Change to: ?

  4. URL: https://uptane.github.io/uptane-standard/uptane-standard.html#check_root
    Parent: https://uptane.github.io/docs/deployment/best-practices
    Location: Section 9.0.4 Must all signatures be valid...1st para
    Phrase: "mentioned in Section 5.4.4.3"
    Change to: ?

  5. URL: https://uptane.github.io/deployment-considerations/repositories.html
    Parent: https://uptane.github.io/docs/deployment/best-practices

a.
Location: Section 9.0.3 What are the cost implications...
Phrase: "found in the Setting up Uptane repositories"
Change to: https://uptane.github.io/docs/deployment/best-practices#3-setting-up-uptane-repositories ?

b.
Location: Section 10.3.3 Removed
Phrase: are discussed in the "Setting up Uptane repositories"
Change to: https://uptane.github.io/docs/deployment/best-practices#3-setting-up-uptane-repositories ?

  1. URL: https://uptane.github.io/deployment-considerations/customizations.html
    Parent: https://uptane.github.io/docs/deployment/best-practices

a. Location: 5.2 Backup and garbage collection para 3
Phrase: subsection of the "Customizing Uptane"
Change to: https://uptane.github.io/docs/deployment/best-practices#7-customizing-uptane ?

b. Location: 9.0.2 How does Uptane work with other...
Phrase: see the "Customizing Uptane" section
Change to: https://uptane.github.io/docs/deployment/best-practices#7-customizing-uptane ?

BROKEN LINKS: PURES

  1. URL: https://uptane.github.io/uptane-standard/1.2.0/uptane-standard.html
    Parent: https://uptane.github.io/docs/enhancements/pures/pure2
    Location: Metadata Verification procedures, 2nd para
    Change to: https://uptane.github.io/docs/1.2.0/standard/uptane-standard ?

BROKEN LINKS: CHANGELOG

Notes: This is unreleased, should I still change them or ignore?

  1. URL: https://uptane.github.io/reference_pouf.html
    Parent: https://uptane.github.io/docs/2.0.0/deployment/best-practices#10-changelog

  2. URL: https://uptane.github.io/pouf.html
    Parent: https://uptane.github.io/docs/2.0.0/deployment/best-practices#10-changelog

  3. URL: https://github.com/uptane/uptane.github.io/blob/master/reference_pouf.md#file-formats
    Parent: https://uptane.github.io/docs/2.0.0/deployment/best-practices#10-changelog

  4. URL: https://uptane.github.io/deployment-considerations/repositories.html#time-server
    Parent: https://uptane.github.io/docs/1.2.0/deployment/best-practices#changelog

BROKEN LINKS: OTHER

  1. URL: https://uptane.github.io/deployment/introduction.html
    Parent: https://uptane.github.io/papers/ieee-isto-6100.1.0.0.uptane-standard.html#director_repository
    HTML to fix: Uptane Deployment Guidelines
    Phrase/Section to fix: Section 6.2. [DEPLOY] Members of the Uptane Alliance Community, "Uptane Deployment Guidelines"
    Comment: Which link to put?

IGNORE LIST

  1. URL: https://www.scitechnow.org/videos/scitech-now-episode-420/
    Parent: https://uptane.github.io/docs/learn-more/press
    Notes: URL is working

  2. URL: https://rin.org.uk/blogpost/1706945/332376/What-is-spoofing-and-how-to-ensure-GPS-security
    Parent: https://uptane.github.io/docs/deployment/best-practices
    Notes: URL is working

  3. URL: https://knowhow.napaonline.com/how-many-parts-are-in-a-car/
    Parent: https://uptane.github.io/docs/2.0.0/deployment/best-practices#10-changelog
    Notes: URL is working

  4. URL: https://www.googletagmanager.com
    Parent: https://uptane.github.io
    Notes: Same issue as #123
    Error is within HEAD section of HTML

  5. URL: https://uptane.github.io/blog/blog Index 0
    Parent: https://uptane.github.io/blog
    Notes: Same issue as #123
    URL has an extra “Index 0” attached to it

URL: https://WZ6MBDOHOT-dsn.algolia.net
parent: https://uptane.github.io
Notes: Same issue as #123
Error is within HEAD section of HTML

@Mikerniker
Copy link
Contributor

ah sorry, I may have misunderstood the task, is this similar to the previous broken links task I did before?

@hexsecs
Copy link
Member Author

hexsecs commented Nov 6, 2023

@Mikerniker : yes exactly. Just squashing more broken links. I'll provide a response to the items you proposed.

@Mikerniker
Copy link
Contributor

ok, Thanks @hexsecs !

@hexsecs
Copy link
Member Author

hexsecs commented Nov 6, 2023

URL: https://uptane.github.io/uptane-standard/uptane-standard.html
Parent: https://uptane.github.io/docs/learn-more/participate
Location: Security audits
Phrase: Uptane Standards document
Change to: https://uptane.github.io/docs/standard/uptane-standard ?

👍

URL: https://uptane.github.io/deployment-considerations/index.html
Parent: https://uptane.github.io/docs/1.1.0/learn-more/participate
Change to: https://uptane.github.io/docs/deployment/best-practices

👍

URL: https://uptane.github.io/deployment-considerations/glossary.html
Parent: https://uptane.github.io/docs/standard/uptane-standard
Location 2 Terminology
Phrase: glossary
Question: What link to use?

This is missing. I made an issue: #133

URL: https://uptane.github.io/participate.html
Parent: https://uptane.github.io/docs/1.1.0/learn-more/audits
Location Security Audits
Phrase: "reach out to us"
Question: Should I change link to: https://uptane.github.io/docs/learn-more/participate ? This is for version 1.1.0

👍 - Eventually we won't have duplicate versioned pages for these. See #124

URL: https://uptane.github.io/uptane-standard/uptane-standard.html#build-time-prerequisite-requirements-for-ecus
Parent: https://uptane.github.io/docs/deployment/best-practices
Location: Preparing an ECU for Uptane
Phrase: See the Uptane Standard
Change link to: https://uptane.github.io/docs/standard/uptane-standard

Use https://uptane.github.io/docs/standard/uptane-standard#541-build-time-prerequisite-requirements-for-ecus

@hexsecs
Copy link
Member Author

hexsecs commented Nov 6, 2023

BROKEN LINKS: POUF
URL: https://uptane.github.io/uptane-standard/uptane-standard.html#director_repository
Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
Location: Message Handler Table (Table, 1st Row under Specification Reference)
Question: Change link to: ?

https://uptane.github.io/docs/standard/uptane-standard#532-director-repository

URL: https://uptane.github.io/uptane-standard/uptane-standard.html#send_metadata_primary
Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
Location: Message Handler Table (Table, last Row get_metadata)
Question: Change link to: ?

https://uptane.github.io/docs/standard/uptane-standard#5426-send-metadata-to-secondaries

URL: https://uptane.github.io/uptane-standard/uptane-standard.html#create_version_report
Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
Location: Message Handler Table (Table, 4th Row submit_ecu_manifest)
Question: Change link to: ?

https://uptane.github.io/docs/standard/uptane-standard#5436-create-and-send-version-report

URL: https://uptane.github.io/uptane-standard/uptane-standard.html#send_images_primary
Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
Location: Message Handler Table (Table, 2nd to last Row get_image)
Question: Change link to: ?

https://uptane.github.io/docs/standard/uptane-standard#5427-send-images-to-secondaries

URL: https://uptane.github.io/uptane-standard/uptane-standard.html#send_time_primary
Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
Location: Message Handler Table (Table, 3rd from bottom: get_time_attestation_for_ecu)
Question: Change link to: ?

https://uptane.github.io/docs/standard/uptane-standard#5425-send-latest-time-to-secondaries

URL: https://uptane.github.io/uptane-standard/uptane-standard.html#targets_images_meta
Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
Location: Message Handler Table (last paragraph: phrase: "Uptane Standard")
Change link to: https://uptane.github.io/docs/standard/uptane-standard

https://uptane.github.io/docs/standard/uptane-standard#5231-metadata-about-images

URL: https://uptane.github.io/uptane-standard/uptane-standard.html#in-vehicle-implementation-requirements
Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
Location: Operations section
Phrase: "in Vehicle Implementation Requirements"
Question: Change link to: ?

https://uptane.github.io/docs/standard/uptane-standard#54-in-vehicle-implementation-requirements

URL: https://uptane.github.io/uptane-standard/uptane-standard.html#delegations_meta
Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
Location: Operations section, para. 4
Phrase: "wildcards"
Question: Change link to: ?

https://uptane.github.io/docs/standard/uptane-standard#5232-metadata-about-delegations

URL: https://uptane.github.io/uptane-standard/uptane-standard.html#construct_manifest_primary
Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
Location: Operations section, last paragraph
Phrase/Word: diffs
Question: Change link to: ?

https://uptane.github.io/docs/standard/uptane-standard#5421-construct-and-send-vehicle-version-manifest

URL: https://uptane.github.io/uptane-standard/uptane-standard.html#targets_role_delegations
Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
Location: Operations section, 4th paragraph
Phrase/Word: "optional in the Standard"
Change link to: https://uptane.github.io/docs/standard/uptane-standard ?

https://uptane.github.io/docs/standard/uptane-standard#5121-delegations

URL: https://uptane.github.io/uptane-standard/uptane-standard.html#custom-metadata-about-images
Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
Location: Metadata section, 4th bullet point
Phrase/Word: "Targets metadata as described in the Standard"
Change link to: https://uptane.github.io/docs/standard/uptane-standard ?

https://uptane.github.io/docs/standard/uptane-standard#52311-custom-metadata-about-images

URL: https://uptane.github.io/uptane-standard/uptane-standard.html#root_meta
Parent: https://uptane.github.io/docs/enhancements/pouf/pouf1
Location: Metadata section, 2nd bullet point
Phrase/Word: "mappings of roles to lists of URLs as described in TAP 5"
Question: Change link to: ?

https://uptane.github.io/docs/standard/uptane-standard#522-root-metadata

@hexsecs
Copy link
Member Author

hexsecs commented Nov 6, 2023

BROKEN LINKS: VERSION
URL: https://www.d2pmagazine.com/2020/04/02/6099/
Parent: https://uptane.github.io/docs/1.1.0/learn-more/press
Location: Press section, 5th bullet
Phrase/Word: Open Source Framework Helps Automakers...
Comment: Will change to the archive.org version of the article?:
https://web.archive.org/web/20230703104528/https://www.d2pmagazine.com/2020/04/02/6099/

👍

@hexsecs
Copy link
Member Author

hexsecs commented Nov 6, 2023

BROKEN LINKS: BEST PRACTICES PAGE
URL: https://uptane.github.io/deployment-considerations/normal_operation.html
Parent: https://uptane.github.io/docs/deployment/best-practices
a. Location: Section 6.3 Adding or removing a supplier, 2nd para
Phrase: Normal Operating Procedures
Change to: ?

https://uptane.github.io/docs/deployment/best-practices#5-normal-operating-procedures

b. Location: 3.2 What suppliers should do, 1st para
Phrase: Normal Operating Guidelines
Change to: ?

https://uptane.github.io/docs/deployment/best-practices#5-normal-operating-procedures

URL: https://uptane.github.io/deployment-considerations/key_management.html
Parent: https://uptane.github.io/docs/deployment/best-practices
a.
Location: Section 3.1.1.6 Time source key compromise
Phrase: "Managing singing keys and metadata expiration"
Change to: ?

https://uptane.github.io/docs/deployment/best-practices#4-managing-signing-keys-and-metadata-expiration

b.
Location: Section 3.3.1 Director repository
Phrase: "Managing singing keys and metadata expiration"
Change to: ?

https://uptane.github.io/docs/deployment/best-practices#4-managing-signing-keys-and-metadata-expiration

c. Location: Section 3.3.2 Image repository
Phrase: "Managing singing keys and metadata expiration"
Change to: ?

https://uptane.github.io/docs/deployment/best-practices#4-managing-signing-keys-and-metadata-expiration

d. Location: Section 6.4 Key compromise
Phrase: See "Key Management"
Change to: ?

https://uptane.github.io/docs/deployment/best-practices#4-managing-signing-keys-and-metadata-expiration

URL: https://uptane.github.io/deployment-considerations/security_considerations.html
Parent: https://uptane.github.io/docs/deployment/best-practices
a. Location: Section 5.1.1 Receiving updates from tier-1 suppliers, para 3
Phrase: See "Enhanced Security Practices"
Change to: ?

https://uptane.github.io/docs/deployment/best-practices#8-enhanced-security-practices

b. Location: Section 6.1 Rolling back software, para 4
Phrase: See "Enhanced Security Practices"
Change to: ?

https://uptane.github.io/docs/deployment/best-practices#8-enhanced-security-practices

c. Location: Section 6.1 Rolling back software, para 7
Phrase: See "Enhanced Security Practices"
Change to: ?

https://uptane.github.io/docs/deployment/best-practices#8-enhanced-security-practices

URL: https://uptane.github.io/deployment-considerations/ecus.html
Parent: https://uptane.github.io/docs/deployment/best-practices
Location: Section 5.1.2 Testing metadata and images, para 3
Phrase: See the "Preparing an ECU for Uptane"
Change to: ?

https://uptane.github.io/docs/deployment/best-practices#2-preparing-an-ecu-for-uptane

URL: https://uptane.github.io/deployment-considerations/customizations.html#delta-update-strategies
Parent: https://uptane.github.io/docs/deployment/best-practices
Location: Section 5.2 Backup and garbage collection for the Image... para 3
Phrase: subsection of the "Customizing Uptane" section
Change to: ?

https://uptane.github.io/docs/deployment/best-practices#7-customizing-uptane

URL: https://uptane.github.io/deployment-considerations/exceptional_operations.html#rolling-back-software
Parent: https://uptane.github.io/docs/deployment/best-practices
Location: Section 8.0.4 Preventing rollback attacks in case of Director...1st para
Phrase: In the Exceptional Operations...
Change to: ?

https://uptane.github.io/docs/deployment/best-practices#6-exceptional-operations

URL: https://uptane.github.io/uptane-standard/uptane-standard.html#check_root
Parent: https://uptane.github.io/docs/deployment/best-practices
Location: Section 9.0.4 Must all signatures be valid...1st para
Phrase: "mentioned in Section 5.4.4.3"
Change to: ?

https://uptane.github.io/docs/standard/uptane-standard#5443-how-to-check-root-metadata

URL: https://uptane.github.io/deployment-considerations/repositories.html
Parent: https://uptane.github.io/docs/deployment/best-practices

a.
Location: Section 9.0.3 What are the cost implications...
Phrase: "found in the Setting up Uptane repositories"
Change to: https://uptane.github.io/docs/deployment/best-practices#3-setting-up-uptane-repositories ?

👍

b.
Location: Section 10.3.3 Removed
Phrase: are discussed in the "Setting up Uptane repositories"
Change to: https://uptane.github.io/docs/deployment/best-practices#3-setting-up-uptane-repositories ?

👍

URL: https://uptane.github.io/deployment-considerations/customizations.html
Parent: https://uptane.github.io/docs/deployment/best-practices
a. Location: 5.2 Backup and garbage collection para 3
Phrase: subsection of the "Customizing Uptane"
Change to: https://uptane.github.io/docs/deployment/best-practices#7-customizing-uptane ?

👍

b. Location: 9.0.2 How does Uptane work with other...
Phrase: see the "Customizing Uptane" section
Change to: https://uptane.github.io/docs/deployment/best-practices#7-customizing-uptane ?

👍

@hexsecs
Copy link
Member Author

hexsecs commented Nov 6, 2023

BROKEN LINKS: PURES
URL: https://uptane.github.io/uptane-standard/1.2.0/uptane-standard.html
Parent: https://uptane.github.io/docs/enhancements/pures/pure2
Location: Metadata Verification procedures, 2nd para
Change to: https://uptane.github.io/docs/1.2.0/standard/uptane-standard ?

Correct. Although, this may actually be an issue with the text of this page. I think ultimately we don't want this pinned to a particular version of Uptane. I created a separate issue in the PURE repository for that.
uptane/pures#12

BROKEN LINKS: CHANGELOG
Notes: This is unreleased, should I still change them or ignore?

I think we should delete the "unreleased" section altogether in release versions of the changelog. This should only appear in a working copy.

URL: https://uptane.github.io/reference_pouf.html
Parent: https://uptane.github.io/docs/2.0.0/deployment/best-practices#10-changelog

URL: https://uptane.github.io/pouf.html
Parent: https://uptane.github.io/docs/2.0.0/deployment/best-practices#10-changelog

URL: https://github.com/uptane/uptane.github.io/blob/master/reference_pouf.md#file-formats
Parent: https://uptane.github.io/docs/2.0.0/deployment/best-practices#10-changelog

URL: https://uptane.github.io/deployment-considerations/repositories.html#time-server
Parent: https://uptane.github.io/docs/1.2.0/deployment/best-practices#changelog

BROKEN LINKS: OTHER
URL: https://uptane.github.io/deployment/introduction.html
Parent: https://uptane.github.io/papers/ieee-isto-6100.1.0.0.uptane-standard.html#director_repository
HTML to fix: Uptane Deployment Guidelines
Phrase/Section to fix: Section 6.2. [DEPLOY] Members of the Uptane Alliance Community, "Uptane Deployment Guidelines"
Comment: Which link to put?

https://uptane.github.io/docs/deployment/best-practices

@Mikerniker Mikerniker mentioned this issue Nov 6, 2023
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants