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

Update README troubleshooting and beta scope #2996

Merged
merged 5 commits into from
Nov 2, 2021
Merged

Conversation

teor2345
Copy link
Contributor

@teor2345 teor2345 commented Nov 1, 2021

Motivation

  1. We shared some troubleshooting tips with external users, so we want to add them to the README
  2. macOS can report crashes in the Zebra tests, which is confusing for users
  3. The "current features" section is outdated and overlaps with the "beta" section
  4. The summary of missing features in the beta section is confusing and incomplete

This is unscheduled but expected beta-related work in sprint 22.

Closes #2990.

Solution

  1. Add troubleshooting tips to the README
  2. Document that macOS can report crashes in the Zebra tests, but they are intentional
  3. Delete the "current features" section
  4. Update the summary in the beta section from the detailed list

Review

Anyone can review this low-priority PR.

Reviewer Checklist

  • Documentation makes sense
  • Do we want to keep anything from the "current features" section?

@teor2345 teor2345 added A-docs Area: Documentation C-enhancement Category: This is an improvement C-cleanup Category: This is a cleanup P-Low labels Nov 1, 2021
@teor2345 teor2345 added this to the 2021 Sprint 22 milestone Nov 1, 2021
@teor2345 teor2345 self-assigned this Nov 1, 2021
README.md Outdated Show resolved Hide resolved
@teor2345 teor2345 changed the title Add troubleshooting and remove outdated section from README Update README troubleshooting and beta scope Nov 2, 2021
@teor2345 teor2345 requested a review from mpguerra November 2, 2021 07:45
Copy link
Contributor

@mpguerra mpguerra left a comment

Choose a reason for hiding this comment

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

This looks great!

I am struggling with what to do about the "Current features" section. If everything that we explicitly covered in this section is still covered by our broad explanation about what zebra is and does then I'm happy to remove.

If we get questions or issues opened in future because users are confused about why zebra is or isn't doing something then we should consider adding it back in

@mpguerra mpguerra merged commit d7286f5 into main Nov 2, 2021
@mpguerra mpguerra deleted the readme-troubleshooting branch November 2, 2021 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation C-cleanup Category: This is a cleanup C-enhancement Category: This is an improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Several crashes when running cargo test
2 participants