-
Notifications
You must be signed in to change notification settings - Fork 160
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Doc: remove useless info from docs.rs front page
Add `lib_readme.md` as docs.rs front page. Replace links in README.md with urls to docs.rs.
- Loading branch information
1 parent
aad7876
commit 36d84f2
Showing
7 changed files
with
76 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,40 @@ | ||
| # Openraft Document | ||
|
|
||
| If you're starting to build an application with Openraft, check out | ||
| - [`getting_started`]. | ||
| - [`faq`], | ||
| - [`getting_started`](crate::docs::getting_started). | ||
| - [`faq`](crate::docs::faq), | ||
|
|
||
| To maintain an Openraft cluster, e.g., add or remove nodes, refer to | ||
| - [`cluster_control`] : | ||
| - [`cluster_formation`](`cluster_control::cluster_formation`) describes how to form a cluster; | ||
| - [`dynamic membership`](`cluster_control::dynamic_membership`) describes how to add or remove nodes without downtime; | ||
| - [`node lifecycle`](`cluster_control::node_lifecycle`) describes the transition of a node's state; | ||
| - [`cluster_control`](crate::docs::cluster_control) : | ||
| - [`cluster_formation`](`crate::docs::cluster_control::cluster_formation`) describes how to form a cluster; | ||
| - [`dynamic membership`](`crate::docs::cluster_control::dynamic_membership`) describes how to add or remove nodes without downtime; | ||
| - [`node lifecycle`](`crate::docs::cluster_control::node_lifecycle`) describes the transition of a node's state; | ||
|
|
||
| When upgrading an Openraft application, consult: | ||
| - [`upgrade_guide`] : | ||
| - [`v0.6-to-v0.7`](`upgrade_guide::upgrade_06_07`); | ||
| - [`v0.7-to-v0.8`](`upgrade_guide::upgrade_07_08`); | ||
| - [`v0.8.3-to-v0.8.4`](`upgrade_guide::upgrade_083_084`); | ||
| - [`upgrade_guide`](crate::docs::upgrade_guide) : | ||
| - [`v0.6-to-v0.7`](`crate::docs::upgrade_guide::upgrade_06_07`); | ||
| - [`v0.7-to-v0.8`](`crate::docs::upgrade_guide::upgrade_07_08`); | ||
| - [`v0.8.3-to-v0.8.4`](`crate::docs::upgrade_guide::upgrade_083_084`); | ||
|
|
||
| To learn about the data structures used in Openraft and the commit protocol, see | ||
| - [`feature_flags`] ; | ||
| - [`data`] : | ||
| - [`Vote`](`data::vote`) is the core in a distributed system; | ||
| - [`Log pointers`](`data::log_pointers`) shows how Openraft tracks entries in the log; | ||
| - [`Extended membership`](`data::extended_membership`) explains how members are organized in Openraft; | ||
| - [`Effective membership`](`data::effective_membership`) explains when membership config takes effect; | ||
| - [`protocol`] : | ||
| - [`replication`](`protocol::replication`); | ||
| - [`leader_lease`](`protocol::replication::leader_lease`); | ||
| - [`log_replication`](`protocol::replication::log_replication`); | ||
| - [`snapshot_replication`](`protocol::replication::snapshot_replication`); | ||
| - [`feature_flags`](crate::docs::feature_flags); | ||
| - [`data`](crate::docs::data) : | ||
| - [`Vote`](`crate::docs::data::vote`) is the core in a distributed system; | ||
| - [`Log pointers`](`crate::docs::data::log_pointers`) shows how Openraft tracks entries in the log; | ||
| - [`Extended membership`](`crate::docs::data::extended_membership`) explains how members are organized in Openraft; | ||
| - [`Effective membership`](`crate::docs::data::effective_membership`) explains when membership config takes effect; | ||
| - [`protocol`](crate::docs::protocol) : | ||
| - [`replication`](`crate::docs::protocol::replication`); | ||
| - [`leader_lease`](`crate::docs::protocol::replication::leader_lease`); | ||
| - [`log_replication`](`crate::docs::protocol::replication::log_replication`); | ||
| - [`snapshot_replication`](`crate::docs::protocol::replication::snapshot_replication`); | ||
|
|
||
| Contributors who want to understand the internals of Openraft can find relevant information in | ||
| - [`internal`] : | ||
| - [`internal`](crate::docs::internal) : | ||
| - [Architecture](`crate::docs::internal::architecture`) shows the overall architecture of Openraft; | ||
| - [Threading](`crate::docs::internal::threading`) describes the threading model of Openraft; | ||
|
|
||
| Finally, the archived and discarded documents: | ||
| - [`obsolete`] describes obsolete design documents and why they are discarded; | ||
| - [`blank-log-heartbeeat`](`obsolete::heartbeat`); | ||
| - [`fast-commit`](`obsolete::fast_commit`); | ||
| - [`obsolete`](crate::docs::obsolete) describes obsolete design documents and why they are discarded; | ||
| - [`blank-log-heartbeeat`](`crate::docs::obsolete::heartbeat`); | ||
| - [`fast-commit`](`crate::docs::obsolete::fast_commit`); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| <!-- This page is rendered by docs.rs --> | ||
|
|
||
| <div align="center"> | ||
| <h1>Openraft</h1> | ||
| </div> | ||
|
|
||
| ## API status | ||
|
|
||
| **Openraft API is currently unstable**. | ||
| Incompatibilities may arise in upgrades prior to `1.0.0`. | ||
| Refer to our [Change-Log](https://github.com/datafuselabs/openraft/blob/main/change-log.md) for details. | ||
| [Upgrade Guides](crate::docs::upgrade_guide) explains how to upgrade. | ||
|
|
||
| Each commit message begins with a keyword indicating the type of change: | ||
|
|
||
| - `DataChange:` Changes to on-disk data types, possibly requiring manual upgrade. | ||
| - `Change:` Introduces incompatible API changes. | ||
| - `Feature:` Adds compatible, non-breaking new features. | ||
| - `Fix:` Addresses bug fixes. | ||
|
|