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.

Sign up for GitHub

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

Jump to bottom

doc(features): Document optional zebrad features and clean up README #4680

Merged
merged 5 commits into from
Jun 28, 2022
Merged

doc(features): Document optional zebrad features and clean up README #4680

merged 5 commits into from
Jun 28, 2022

Conversation

teor2345
Copy link
Contributor

Motivation

We want to document optional zebrad features, and make it easier for new users to start using Zebra.

Close #1617.
Close #4549.

Solution

Compile-time features:

  • Document features in zebrad/src/lib.rs
    • Link to the feature list from the README
  • Document configs that need compile-time features

README cleanup:

  • Remove some outdated README info
  • Move some detailed README info to the zebrad crate docs
    • Link to it from the README

Review

Anyone can review this PR.

Reviewer Checklist

  • Docs make sense

@teor2345 teor2345 added A-docs Area: Documentation C-enhancement Category: This is an improvement C-cleanup Category: This is a cleanup P-Medium ⚡ labels Jun 23, 2022
@teor2345 teor2345 requested a review from a team as a code owner June 23, 2022 07:29
@teor2345 teor2345 self-assigned this Jun 23, 2022
@teor2345 teor2345 requested review from dconnolly and removed request for a team June 23, 2022 07:29
@codecov
Copy link

codecov bot commented Jun 23, 2022

Codecov Report

Merging #4680 (a969d9c) into main (c75a68e) will increase coverage by 0.11%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #4680      +/-   ##
==========================================
+ Coverage   78.81%   78.93%   +0.11%     
==========================================
  Files         304      304              
  Lines       37509    37509              
==========================================
+ Hits        29564    29609      +45     
+ Misses       7945     7900      -45

@teor2345 teor2345 mentioned this pull request Jun 28, 2022
Merged
31 tasks
dconnolly
dconnolly approved these changes Jun 28, 2022
View reviewed changes
Copy link
Contributor

@dconnolly dconnolly left a comment

Choose a reason for hiding this comment

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

💯

mergify bot added a commit that referenced this pull request Jun 28, 2022
@mergify
Merge of #4680
8109e9a
@mergify mergify bot mentioned this pull request Jun 28, 2022
Closed
@teor2345
Copy link
Contributor Author

@Mergifyio requeue

@mergify
Copy link
Contributor

mergify bot commented Jun 28, 2022

requeue

✅ The queue state of this pull request has been cleaned. It can be re-embarked automatically

mergify bot added a commit that referenced this pull request Jun 28, 2022
@mergify
Merge of #4680
7876bbd
@mergify mergify bot mentioned this pull request Jun 28, 2022
Closed
@mergify mergify bot merged commit ad524f2 into main Jun 28, 2022
@mergify mergify bot deleted the zebra-feature-doc branch June 28, 2022 22:15
teor2345 added a commit that referenced this pull request Jun 28, 2022
@teor2345
Update CHANGELOG to PR #4680
dfc5504
mergify bot pushed a commit that referenced this pull request Jun 29, 2022
@teor2345
Release Zebra 1.0.0-beta.12 (#4714)
9e277ed 
* Update Zebra to 1.0.0-beta.12

* Simplify tower-* versioning by updating both to 0.2.27

* Simplify version search and replace by removing an old version from the docs

* Update Cargo.lock

* Add draft changelog as of PR #4693

* Update CHANGELOG to PR #4680
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dconnolly dconnolly dconnolly approved these changes

Assignees

@teor2345 teor2345

Labels
A-docs Area: Documentation C-cleanup Category: This is a cleanup C-enhancement Category: This is an improvement
Projects
None yet
Milestone
No milestone
2 participants
@teor2345 @dconnolly