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

doc: update installation documentation #1853

Merged
merged 6 commits into from
Feb 14, 2022

Commits on Feb 9, 2022

  1. doc: update installation documentation

    Update severely outdated installation documentation.
    
    - Simplify "Simple Installation" section
    - Update "Release Verification" section to actually verify a tuf
      release and with a key of an active maintainer
    - Update and simplify section about non-python dependencies
      (just point to installation instructions for underlying crypto
      backends, they are up-to-date and have become a lot easier)
    - Add "Development installation" section
    
    Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
    lukpueh committed Feb 9, 2022
    Configuration menu
    Copy the full SHA
    5ec4c95 View commit details
    Browse the repository at this point in the history
  2. doc: update install section in contributing doc

    Replace custom installation section in contribution docs with
    pointer to updated installation documentation.
    
    Also configure sphinx autosectionlabel for cross-document refs.
    
    Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
    lukpueh committed Feb 9, 2022
    Configuration menu
    Copy the full SHA
    4343931 View commit details
    Browse the repository at this point in the history
  3. doc: minor title changes for rtd navbar

    Make contributing document header sentence case for consistency
    with other docs and shorten menu name in side navbar to stand out
    less.
    
    Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
    lukpueh committed Feb 9, 2022
    Configuration menu
    Copy the full SHA
    0b2b1bb View commit details
    Browse the repository at this point in the history
  4. doc: fix link to tox docs

    Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
    lukpueh committed Feb 9, 2022
    Configuration menu
    Copy the full SHA
    c40bb30 View commit details
    Browse the repository at this point in the history

Commits on Feb 10, 2022

  1. doc: move verify section in install docs

    Move release signature verification instructions to bottom of
    install docs. The doc is short, so the section is still prominent
    enough for promoting verification, but does not break the reading
    flow as much anymore.
    
    Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
    lukpueh committed Feb 10, 2022
    Configuration menu
    Copy the full SHA
    0216740 View commit details
    Browse the repository at this point in the history
  2. doc: cross-doc absolute link hack

    This is an ugly hack to also resolve the link when the document is
    rendered in GitHub, where it is likely to be browsed, because it is
    the community standard location for a GitHub repo's contributing
    docs.
    
    Coordinate with theupdateframework#1849 to better separate RTD docs with GitHub docs
    in the future.
    
    Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
    lukpueh committed Feb 10, 2022
    Configuration menu
    Copy the full SHA
    cd70e47 View commit details
    Browse the repository at this point in the history