Merge remote-tracking branch 'upstream/main' into native_hdfs_read_write

apache · Apr 19, 2024 · 1a709df · 1a709df
2 parents 5b8bce6 + 5895cd8
commit 1a709df
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 1 deletion.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -320,6 +320,33 @@ jobs:
           name: object-store-opendal-docs
           path: ./integrations/object_store/target/doc
 
+  build-dav-server-opendalfs-doc:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Rust toolchain
+        uses: ./.github/actions/setup
+
+      # Revert to nightly after https://github.com/apache/opendal/issues/4161 addressed
+      - name: Setup Rust Nightly
+        run: |
+          rustup toolchain install nightly-2024-01-01
+
+      - name: Build dav-server-opendalfs doc
+        working-directory: "integrations/dav-server"
+        run: cargo +nightly-2024-01-01 doc --lib --no-deps --all-features
+        env:
+          # Enable cfg docs to make sure docs are built.
+          RUSTDOCFLAGS: "--cfg docs"
+
+      - name: Upload docs
+        uses: actions/upload-artifact@v3
+        with:
+          name: dav-server-opendalfs-docs
+          path: ./integrations/dav-server/target/doc
+
   build-website:
     runs-on: ubuntu-latest
     needs:
@@ -333,6 +360,7 @@ jobs:
       - build-cpp-doc
       - build-ocaml-doc
       - build-object-store-opendal-doc
+      - build-dav-server-opendalfs-doc
 
     steps:
       - uses: actions/checkout@v4
@@ -411,6 +439,12 @@ jobs:
           name: object-store-opendal-docs
           path: ./website/static/docs/object-store-opendal
 
+      - name: Download dav-server-opendalfs docs
+        uses: actions/download-artifact@v3
+        with:
+          name: dav-server-opendalfs-docs
+          path: ./website/static/docs/dav-server-opendalfs
+
       - name: Install Dependencies
         working-directory: website
         run: pnpm install --frozen-lockfile

diff --git a/integrations/dav-server/README.md b/integrations/dav-server/README.md
@@ -1,3 +1,3 @@
 # dav-server-opendalfs
 
-`dav-server-opendalfs` is an integration which uses OpenDAL as a backend to access data in various service with WebDAV protocol.
+[`dav-server-opendalfs`](https://crates.io/crates/dav-server-opendalfs) is an integration which uses OpenDAL as a backend to access data in various service with WebDAV protocol.
diff --git a/website/docs/integrations/dav-server-opendalfs.mdx b/website/docs/integrations/dav-server-opendalfs.mdx
@@ -0,0 +1,7 @@
+---
+title: dav-server-opendalfs
+---
+
+import Docs from '../../../integrations/dav-server/README.md'
+
+<Docs components={props.components} />
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -157,6 +157,10 @@ const config = {
                 label: 'object-store-opendal',
                 to: 'pathname:///docs/object-store-opendal/object_store_opendal'
               },
+              {
+                label: 'dav-server-opendalfs',
+                to: 'pathname:///docs/dav-server-opendalfs/dav_server_opendalfs'
+              }
             ]
           },
           {