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

Docs updates #3091

Merged
merged 2 commits into from
Apr 15, 2024
Merged

Docs updates #3091

merged 2 commits into from
Apr 15, 2024

Conversation

ethomson
Copy link
Member

Summary

Some minor docs updates to clarify the main point in each of the "How Minder Works" components.

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.

minder provider enroll
```

To enroll a specific GitHub organization, use the following command:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should not advertise the --owner flag anymore or tell peopple that they need to be an owner since the switch to the GH app. The rest of the PR looks good.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed - thanks

* Update the intro paragraph in each page
* Move information about Alerts into its page, out of the Remediations
  page
@coveralls
Copy link

Coverage Status

coverage: 48.123% (+0.01%) from 48.112%
when pulling b4ce154 on ethomson/docs
into ae4dcdf on main.

@ethomson ethomson merged commit 4c81e26 into main Apr 15, 2024
17 of 18 checks passed
@ethomson ethomson deleted the ethomson/docs branch April 15, 2024 23:44
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.

None yet

3 participants