Skip to content

Commit 14cfff3

Browse files
committed
Doc: move mdbook doc to rust doc
In order to keep consistency between the doc and the source code. Old online guide https://datafuselabs.github.io/openraft/ will not be maintained.
1 parent 79ec570 commit 14cfff3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+2318
-1856
lines changed

.github/workflows/pages.yaml

+24-23
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
1-
on:
2-
push:
3-
branches:
4-
- main
5-
paths:
6-
- 'guide/**'
7-
- 'book.toml'
8-
- 'README.md'
9-
jobs:
10-
deploy-guide:
11-
runs-on: ubuntu-18.04
12-
steps:
13-
- name: Checkout
14-
uses: actions/checkout@v2
1+
# Disabled, guide is moved to https://docs.rs/openraft/0.8.3/openraft/docs
2+
# on:
3+
# push:
4+
# branches:
5+
# - main
6+
# paths:
7+
# - 'guide/**'
8+
# - 'book.toml'
9+
# - 'README.md'
10+
# jobs:
11+
# deploy-guide:
12+
# runs-on: ubuntu-18.04
13+
# steps:
14+
# - name: Checkout
15+
# uses: actions/checkout@v2
1516

16-
- name: Install mdbook
17-
uses: drmingdrmer/mdbook-full@main
17+
# - name: Install mdbook
18+
# uses: drmingdrmer/mdbook-full@main
1819

19-
- name: Build mdbook
20-
run: mdbook build
20+
# - name: Build mdbook
21+
# run: mdbook build
2122

22-
- name: Deploy to github page
23-
uses: peaceiris/actions-gh-pages@v3
24-
with:
25-
github_token: ${{ secrets.GITHUB_TOKEN }}
26-
publish_dir: ./guide/book
23+
# - name: Deploy to github page
24+
# uses: peaceiris/actions-gh-pages@v3
25+
# with:
26+
# github_token: ${{ secrets.GITHUB_TOKEN }}
27+
# publish_dir: ./guide/book

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ fix:
3535
cargo fix --allow-staged
3636

3737
doc:
38-
RUSTDOCFLAGS="-D warnings" cargo doc --all --no-deps
38+
RUSTDOCFLAGS="-D warnings" cargo doc --document-private-items --all --no-deps
3939

4040
check_missing_doc:
4141
# Warn about missing doc for public API

guide/src/SUMMARY.md

-34
This file was deleted.

guide/src/architecture.md

-61
This file was deleted.

guide/src/cluster-controls.md

-32
This file was deleted.

guide/src/cluster-formation.md

-53
This file was deleted.

guide/src/delete_log.md

-27
This file was deleted.

guide/src/dynamic-membership.md

-73
This file was deleted.

guide/src/effective-membership.md

-29
This file was deleted.

0 commit comments

Comments
 (0)