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

doc(README): update README goals and performance troubleshooting #3525

Merged
merged 6 commits into from
Feb 17, 2022

Conversation

teor2345
Copy link
Contributor

Motivation

Some users have found it hard to work out why Zebra is running slowly (#3042).

Solution

Document performance requirements and troubleshooting:

  • add configs that can speed up Zebra's performance
  • add network latency requirement
  • clarify and expand disk requirements
  • de-duplicate README info, to avoid confusion and inconsistencies (replaced with a link)

Unrelated README cleanups:

  • remove completed Zebra goals
  • docker now uses bullseye

Closes #3101.

Review

Anyone can review this PR, but I'd like @conradoplg and @ftm1000 to take a look at the goals changes.

Reviewer Checklist

  • Documentation makes sense
  • Changes are inserted in the correct places

Follow Up Work

@teor2345 teor2345 added A-docs Area: Documentation C-enhancement Category: This is an improvement P-Low ❄️ I-slow Problems with performance or responsiveness I-usability Zebra is hard to understand or use labels Feb 14, 2022
@teor2345 teor2345 self-assigned this Feb 14, 2022
Copy link
Collaborator

@conradoplg conradoplg left a comment

Choose a reason for hiding this comment

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

Looks great, thanks!

mergify bot added a commit that referenced this pull request Feb 16, 2022
@mergify mergify bot merged commit 763475e into main Feb 17, 2022
@mergify mergify bot deleted the readme-performance branch February 17, 2022 00:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation C-enhancement Category: This is an improvement I-slow Problems with performance or responsiveness I-usability Zebra is hard to understand or use
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how to speed up full validation in the README
2 participants