You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
Describe the bug.
The best practices document at
/docs/deployment/best-practices.md
should be identical to the one atversioned_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.
../../file.md
), we should use site-root-relative links (i.e./static/papers/assets/file.pdf
)[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)
.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.
The text was updated successfully, but these errors were encountered: