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

Add docs for user management and invitations (#3837) #3972

Merged
merged 3 commits into from
Jul 24, 2024

Conversation

rdimitrov
Copy link
Member

Summary

Details:

  • Add conceptual docs on projects, document how to create new projects, because I was there
  • Add role requirements to how-to prereqs
  • Clarify one role per project
  • Rewrite adding users to describe invitations
  • Undo excessive prettier formatting
  • Update docs/docs/how-to/create_project.md
  • Switch naming from Stacklok (vendor) to Minder (project) in documentation where I missed it.

Change Type

Mark the type of change your PR introduces:

  • Bug fix (resolves an issue without affecting existing features)
  • Feature (adds new functionality without breaking changes)
  • Breaking change (may impact existing functionalities or require documentation updates)
  • Documentation (updates or additions to documentation)
  • Refactoring or test improvements (no bug fixes or new functionality)

Testing

Outline how the changes were tested, including steps to reproduce and any relevant configurations.
Attach screenshots if helpful.

Review Checklist:

  • Reviewed my own code for quality and clarity.
  • Added comments to complex or tricky code sections.
  • Updated any affected documentation.
  • Included tests that validate the fix or feature.
  • Checked that related changes are merged.

* Add conceptual docs on projects, document how to create new projects, because I was there

* Add role requirements to how-to prereqs

* Clarify one role per project

* Rewrite adding users to describe invitations

* Undo excessive prettier formatting

* Update docs/docs/how-to/create_project.md

Co-authored-by: Puerco <puerco@users.noreply.github.com>

* Switch naming from Stacklok (vendor) to Minder (project) in documentation where I missed it.

Co-authored-by: Radoslav Dimitrov <radoslav@stacklok.com>

---------

Co-authored-by: Radoslav Dimitrov <radoslav@stacklok.com>
Co-authored-by: Puerco <puerco@users.noreply.github.com>
@rdimitrov rdimitrov requested a review from a team as a code owner July 24, 2024 08:41
@rdimitrov rdimitrov linked an issue Jul 24, 2024 that may be closed by this pull request
@coveralls
Copy link

coveralls commented Jul 24, 2024

Coverage Status

coverage: 54.219%. remained the same
when pulling 7880cb4 on 3795-add-docs-for-user-management-and-invitations
into ac3241f on main.

@rdimitrov rdimitrov merged commit aef3071 into main Jul 24, 2024
19 checks passed
@rdimitrov rdimitrov deleted the 3795-add-docs-for-user-management-and-invitations branch July 24, 2024 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs for user management and invitations
5 participants