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.

Sign up for GitHub

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

Documentation updates #3738

Merged
merged 16 commits into from
Jun 28, 2024
Merged

Documentation updates #3738

merged 16 commits into from
Jun 28, 2024

Commits on Jun 28, 2024

  1. Update "installing the CLI" documentation 

    Explain what the Minder CLI can talk to; remove discussion about running
/ installing the server and link to the separate running / installing
the server page.
    @ethomson
    ethomson committed Jun 28, 2024
    Configuration menu
    Copy the full SHA
    1aa8370 View commit details
    Browse the repository at this point in the history

  2. Update docs main page 

    When we say "here" as a link target, it becomes subtly hard to read.
Expand the URL in order to promote visibility.
    @ethomson
    ethomson committed Jun 28, 2024
    Configuration menu
    Copy the full SHA
    f602ada View commit details
    Browse the repository at this point in the history

  3. Documentation: some readability tweaks 

    * Explain the default is to Minder Cloud
* Clarify that we're enrolling the GitHub provider; we'll have other
  providers in the future, but we can be more clear about the current
  state.
* Clarify that you don't need to enroll if you did a quickstart.
* For prerequisites, don't list all the prerequisites; they implicitly
  chain, so you only need to point to the previous step in the getting
  started guide.
    @ethomson
    ethomson committed Jun 28, 2024
    Configuration menu
    Copy the full SHA
    b2a2239 View commit details
    Browse the repository at this point in the history

  4. Update the "enrolling the GitHub Provider" documentation

    @ethomson
    ethomson committed Jun 28, 2024
    Configuration menu
    Copy the full SHA
    636f709 View commit details
    Browse the repository at this point in the history

  5. Documentation: tidy up register repos

    @ethomson
    ethomson committed Jun 28, 2024
    Configuration menu
    Copy the full SHA
    1b8d436 View commit details
    Browse the repository at this point in the history

  6. Update profile creation documentation

    @ethomson
    ethomson committed Jun 28, 2024
    Configuration menu
    Copy the full SHA
    1a31302 View commit details
    Browse the repository at this point in the history

  7. Move status documentation to its own page 

    The status viewing documentation deserves its own page, outside of the
profile creation page.
    @ethomson
    ethomson committed Jun 28, 2024
    Configuration menu
    Copy the full SHA
    5997c45 View commit details
    Browse the repository at this point in the history

  8. Documentation: use sentence case

    @ethomson
    ethomson committed Jun 28, 2024
    Configuration menu
    Copy the full SHA
    b4a0c7c View commit details
    Browse the repository at this point in the history

  9. Documentation: Use sentence case

    @ethomson
    ethomson committed Jun 28, 2024
    Configuration menu
    Copy the full SHA
    f0f28bc View commit details
    Browse the repository at this point in the history

  10. Documentation: merge the two "add users to project" pages

    @ethomson
    ethomson committed Jun 28, 2024
    Configuration menu
    Copy the full SHA
    8593ac9 View commit details
    Browse the repository at this point in the history

  11. Documentation: keep getting started bits separate and simpler

    @ethomson
    ethomson committed Jun 28, 2024
    Configuration menu
    Copy the full SHA
    0f9d28a View commit details
    Browse the repository at this point in the history

  12. Reorder sidebar

    @ethomson
    ethomson committed Jun 28, 2024
    Configuration menu
    Copy the full SHA
    f0acac2 View commit details
    Browse the repository at this point in the history

  13. Documentation: give repository registration its own page 

    There's a lot of details in the repository registration page that aren't
strictly applicable to getting started. Move them out into their own
page so that the getting started page remains simpler.
    @ethomson
    ethomson committed Jun 28, 2024
    Configuration menu
    Copy the full SHA
    3648cd4 View commit details
    Browse the repository at this point in the history

  14. Move the Minder CLI configuration documentation out of getting started 

    The CLI configuration is a non-trivial bit; move it into the reference
section.
    @ethomson
    ethomson committed Jun 28, 2024
    Configuration menu
    Copy the full SHA
    b697a80 View commit details
    Browse the repository at this point in the history

  15. Update protocol documentation to use sentence case in title

    @ethomson
    ethomson committed Jun 28, 2024
    Configuration menu
    Copy the full SHA
    9b89632 View commit details
    Browse the repository at this point in the history

  16. Merge branch 'main' into ethomson/docs

    @ethomson
    ethomson authored Jun 28, 2024
    Configuration menu
    Copy the full SHA
    a6034e0 View commit details
    Browse the repository at this point in the history