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

[Bug Report] - best-practices.md is cosmetically different between the main deployed doc and the one in versioned_docs/version-2.1.0 #213

Open
tkfu opened this issue Aug 27, 2024 · 0 comments
Labels

Comments

@tkfu
Copy link
Member

tkfu commented Aug 27, 2024

Describe the bug.

The best practices document at /docs/deployment/best-practices.md should be identical to the one at versioned_docsversion-2.1.0/deployment/best-practices.md, but it isn't. The changes appear to just be related to formatting and other minor issues, but nevertheless we shouldn't have them.

Describe the steps to reproduce the behavior.

No response

Expected behavior.

  • Instead of using path-relative links (i.e. ../../file.md), we should use site-root-relative links (i.e. /static/papers/assets/file.pdf)
  • Intra-document links should always link to the same document via relative URI (i.e. [Key Management](#4-managing-signing-keys-and-metadata-expiration), not by absolute path (i.e. [Key Management](https://uptane.github.io/docs/deployment/best-practices#4-managing-signing-keys-and-metadata-expiration).
  • No cosmetic changes should be made, e.g. adding/removing bolding on section titles

Screenshots.

No response

Operating environment

No response

What browsers are you seeing the problem on?

No response

Additional context

As a general practice, the documents in /docs should never be changed directly, nor should any document under versioned_docs. The one in /docs should only change when we officially cut a release, and in that case should only be changed to bring in the accepted changes under version-future.

@tkfu tkfu added the bug label Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant