Documentation updates #3738
Merged
Documentation updates #3738
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
When we say "here" as a link target, it becomes subtly hard to read. Expand the URL in order to promote visibility.
* 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.
The status viewing documentation deserves its own page, outside of the profile creation 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.
The CLI configuration is a non-trivial bit; move it into the reference section.
blkt
approved these changes
Jun 28, 2024
| You can also register an individual repository by name, or a set of repositories, comma-separated. For example: | ||
|
|
||
| ```bash | ||
| minder repo register --name "owner/repo1,owner/repo2" |
There was a problem hiding this comment.
note: IIRC we also support repeated --name flags, e.g.
$ minder repo register --name owner/repo1 --name owner/repo2| * [A Minder account](./login.md) | ||
| * [An enrolled GitHub token](./login.md#enrolling-the-github-provider) that is either an Owner in the organization or an Admin on the repositories | ||
| * [One or more repositories registered with Minder](./register_repos.md) | ||
| Before you can create a profile, you should [register repositories](register_repos). |
There was a problem hiding this comment.
nit: this is not strictly a prerequisite, but I guess this is the desired experience for a user going through the docs.
There was a problem hiding this comment.
True. 😁 I worded it as should because of that. I didn't really want to untangle all the details in the getting started page. 😁
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Several documentation updates, primarily around the Getting Started content.
Change Type
Mark the type of change your PR introduces:
Testing
Clicked through; read; ensured no dead links. 🤞
Review Checklist: