docs: Migrate all docs in rustdoc instead (#1281)

* Save work Signed-off-by: Xuanwo <[email protected]> * Migrate rfcs Signed-off-by: Xuanwo <[email protected]> * migration done Signed-off-by: Xuanwo <[email protected]> * Fix CI Signed-off-by: Xuanwo <[email protected]> * no doc test for some docs Signed-off-by: Xuanwo <[email protected]> * FIx format Signed-off-by: Xuanwo <[email protected]> --------- Signed-off-by: Xuanwo <[email protected]>
apache · Feb 5, 2023 · 9730a00 · 9730a00 · github-actions · Feb 5, 2023
1 parent 8ae3081
commit 9730a00
Show file tree

Hide file tree

Showing 136 changed files with 1,528 additions and 6,185 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -22,19 +22,10 @@ jobs:
       - uses: actions-rs/cargo@v1
         with:
           command: doc
-          args: --no-deps --all-features
+          args: --no-deps --all-features -p opendal
         env:
           LD_LIBRARY_PATH: ${{ env.JAVA_HOME }}/lib/server:${{ env.LD_LIBRARY_PATH }}
 
-      - name: Setup mdBook
-        uses: peaceiris/actions-mdbook@v1
-        with:
-          mdbook-version: 'latest'
-
-      - run: |
-          mdbook build
-          cp -r ./target/doc/* ./target/book
-
       - name: Deploy to vercel
         if: github.repository_owner == 'datafuselabs' && github.ref_name == 'main'
         uses: amondnet/[email protected]
@@ -45,7 +36,7 @@ jobs:
           vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }}
           vercel-args: '--prod'
           scope: databend
-          working-directory: ./target/book
+          working-directory: ./target/doc
 
       - name: Deploy to vercel (preview)
         if: github.repository_owner == 'datafuselabs' && github.ref_name != 'main'
@@ -58,4 +49,4 @@ jobs:
           alias-domains: |
             opendal-git-{{BRANCH}}.vercel.app
           scope: databend
-          working-directory: ./target/book
+          working-directory: ./target/doc
diff --git a/Cargo.toml b/Cargo.toml
@@ -6,7 +6,6 @@ edition = "2021"
 exclude = [
   ".github/",
   "bindings/",
-  "docs/",
   "profiles/",
   "oay/",
   "oli/",
@@ -30,6 +29,12 @@ debug = true
 [features]
 default = ["rustls"]
 
+# Build docs or not.
+#
+# This features is used to control whether or not to build opendal's docs.
+# And doesn't have any other effects.
+docs = []
+
 # Enable compress support so that users can decompress while reading.
 compress = ["async-compression"]
 # Enable trust-dns for pure rust dns cache.
@@ -76,30 +81,6 @@ harness = false
 name = "io"
 required-features = ["layers-all"]
 
-[[example]]
-name = "hdfs"
-required-features = ["services-hdfs"]
-
-[[example]]
-name = "ipfs"
-required-features = ["services-ipfs"]
-
-[[example]]
-name = "ftp"
-required-features = ["services-ftp"]
-
-[[example]]
-name = "redis"
-required-features = ["services-redis"]
-
-[[example]]
-name = "rocksdb"
-required-features = ["services-rocksdb"]
-
-[[example]]
-name = "tracing_layer"
-required-features = ["layers-all"]
-
 [dependencies]
 anyhow = { version = "1.0.30", features = ["std"] }
 async-compat = "0.2"

diff --git a/README.md b/README.md
@@ -8,31 +8,30 @@
 
 **Open** **D**ata **A**ccess **L**ayer: Access data freely, painlessly, and efficiently
 
-- [User Guide](https://opendal.databend.rs)
-- API Documentation: [stable](https://docs.rs/opendal/) | [main](https://opendal.databend.rs/opendal/)
+- Documentation: [stable](https://docs.rs/opendal/) | [main](https://opendal.databend.rs/opendal/)
 - [Release notes](https://github.com/datafuselabs/opendal/releases)
 
 ## Services
 
-- [azblob](https://opendal.databend.rs/opendal/services/azblob/index.html): [Azure Storage Blob](https://azure.microsoft.com/en-us/services/storage/blobs/) services.
-- [azdfs](https://opendal.databend.rs/opendal/services/azdfs/index.html): [Azure Data Lake Storage Gen2](https://azure.microsoft.com/en-us/products/storage/data-lake-storage/) services. (As known as [abfs](https://learn.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-abfs-driver))
-- [fs](https://opendal.databend.rs/opendal/services/fs/index.html): POSIX alike file system.
-- [ftp](https://opendal.databend.rs/opendal/services/ftp/index.html): FTP and FTPS support.
-- [gcs](https://opendal.databend.rs/opendal/services/gcs/index.html): [Google Cloud Storage](https://cloud.google.com/storage) Service.
-- [ghac](https://opendal.databend.rs/opendal/services/ghac/index.html): [Github Action Cache](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows) Service.
-- [hdfs](https://opendal.databend.rs/opendal/services/hdfs/index.html): [Hadoop Distributed File System](https://hadoop.apache.org/docs/r3.3.4/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html)(HDFS).
-- [http](https://opendal.databend.rs/opendal/services/http/index.html): HTTP read-only services.
-- [ipfs](https://opendal.databend.rs/opendal/services/ipfs/index.html): [InterPlanetary File System](https://ipfs.tech/) HTTP Gateway support.
-- [ipmfs](https://opendal.databend.rs/opendal/services/ipmfs/index.html): [InterPlanetary File System](https://ipfs.tech/) MFS API support.
-- [memcached](https://opendal.databend.rs/opendal/services/memcached/index.html): [Memcached](https://memcached.org/) service support.
-- [memory](https://opendal.databend.rs/opendal/services/memory/index.html): In memory backend.
-- [moka](https://opendal.databend.rs/opendal/services/moka/index.html): [moka](https://github.com/moka-rs/moka) backend support.
-- [obs](https://opendal.databend.rs/opendal/services/obs/index.html): [Huawei Cloud Object Storage](https://www.huaweicloud.com/intl/en-us/product/obs.html) Service (OBS).
-- [oss](https://opendal.databend.rs/opendal/services/oss/index.html): [Aliyun Object Storage Service](https://www.aliyun.com/product/oss) (OSS).
-- [redis](https://opendal.databend.rs/opendal/services/redis/index.html): [Redis](https://redis.io/) services support.
-- [rocksdb](https://opendal.databend.rs/opendal/services/rocksdb/index.html): [RocksDB](http://rocksdb.org/) services support.
-- [s3](https://opendal.databend.rs/opendal/services/s3/index.html): [AWS S3](https://aws.amazon.com/s3/) alike services.
-- [webdav](https://opendal.databend.rs/opendal/services/webdav/index.html): [WebDAV](https://datatracker.ietf.org/doc/html/rfc4918) Service Support.
+- [azblob](https://opendal.databend.rs/opendal/services/struct.Azblob.html): [Azure Storage Blob](https://azure.microsoft.com/en-us/services/storage/blobs/) services.
+- [azdfs](https://opendal.databend.rs/opendal/services/struct.Azdfs.html): [Azure Data Lake Storage Gen2](https://azure.microsoft.com/en-us/products/storage/data-lake-storage/) services. (As known as [abfs](https://learn.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-abfs-driver))
+- [fs](https://opendal.databend.rs/opendal/services/struct.Fs.html): POSIX alike file system.
+- [ftp](https://opendal.databend.rs/opendal/services/struct.Ftp.html): FTP and FTPS support.
+- [gcs](https://opendal.databend.rs/opendal/services/struct.Gcs.html): [Google Cloud Storage](https://cloud.google.com/storage) Service.
+- [ghac](https://opendal.databend.rs/opendal/services/struct.Ghac.html): [Github Action Cache](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows) Service.
+- [hdfs](https://opendal.databend.rs/opendal/services/struct.Hdfs.html): [Hadoop Distributed File System](https://hadoop.apache.org/docs/r3.3.4/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html)(HDFS).
+- [http](https://opendal.databend.rs/opendal/services/struct.Http.html): HTTP read-only services.
+- [ipfs](https://opendal.databend.rs/opendal/services/struct.Ipfs.html): [InterPlanetary File System](https://ipfs.tech/) HTTP Gateway support.
+- [ipmfs](https://opendal.databend.rs/opendal/services/struct.Ipmfs.html): [InterPlanetary File System](https://ipfs.tech/) MFS API support.
+- [memcached](https://opendal.databend.rs/opendal/services/struct.Memcached.html): [Memcached](https://memcached.org/) service support.
+- [memory](https://opendal.databend.rs/opendal/services/struct.Memory.html): In memory backend.
+- [moka](https://opendal.databend.rs/opendal/services/struct.Moka.html): [moka](https://github.com/moka-rs/moka) backend support.
+- [obs](https://opendal.databend.rs/opendal/services/struct.Obs.html): [Huawei Cloud Object Storage](https://www.huaweicloud.com/intl/en-us/product/obs.html) Service (OBS).
+- [oss](https://opendal.databend.rs/opendal/services/struct.Oss.html): [Aliyun Object Storage Service](https://www.aliyun.com/product/oss) (OSS).
+- [redis](https://opendal.databend.rs/opendal/services/struct.Redis.html): [Redis](https://redis.io/) services support.
+- [rocksdb](https://opendal.databend.rs/opendal/services/struct.Rocksdb.html): [RocksDB](http://rocksdb.org/) services support.
+- [s3](https://opendal.databend.rs/opendal/services/struct.S3.html): [AWS S3](https://aws.amazon.com/s3/) alike services.
+- [webdav](https://opendal.databend.rs/opendal/services/struct.Webdav.html): [WebDAV](https://datatracker.ietf.org/doc/html/rfc4918) Service Support.
 
 ## Features
 

diff --git a/book.toml b/book.toml
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
diff --git a/docs/assets/accessor.png b/docs/assets/accessor.png