docs: publish docs for object-store-opendal (#4328)

* publish docs for object-store-opendal * add ci jobs to publish object-store-opendal docs
apache · Mar 7, 2024 · a2e7749 · a2e7749
1 parent 2665e63
commit a2e7749
Show file tree

Hide file tree

Showing 5 changed files with 73 additions and 1 deletion.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -27,6 +27,7 @@ on:
     paths:
       - "core/**"
       - "bindings/**"
+      - "integrations/**"
       - ".github/workflows/docs.yml"
 
 concurrency:
@@ -292,6 +293,33 @@ jobs:
           name: ocaml-docs
           path: ./bindings/ocaml/_build/default/_doc/_html
 
+  build-object-store-opendal-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 object-store-opendal doc
+        working-directory: "integrations/object_store"
+        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: object-store-opendal-docs
+          path: ./integrations/object_store/target/doc
+
   build-website:
     runs-on: ubuntu-latest
     needs:
@@ -304,6 +332,7 @@ jobs:
       - build-haskell-doc
       - build-cpp-doc
       - build-ocaml-doc
+      - build-object-store-opendal-doc
 
     steps:
       - uses: actions/checkout@v4
@@ -376,6 +405,12 @@ jobs:
           name: ocaml-docs
           path: ./website/static/docs/ocaml
 
+      - name: Download object-store-opendal docs
+        uses: actions/download-artifact@v3
+        with:
+          name: object-store-opendal-docs
+          path: ./website/static/docs/object-store-opendal
+
       - name: Install Dependencies
         working-directory: website
         run: pnpm install --frozen-lockfile

diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@ OpenDAL offers a unified data access layer, empowering users to seamlessly and e
 | Name                                                                | Description                                                                                | Release                                                                                                        | 
 |---------------------------------------------------------------------|--------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| 
 | [dav-server-opendalfs](integrations/dav-server/README.md)           | Access data via integrations to [dav-server-rs](https://github.com/messense/dav-server-rs) | [![](https://img.shields.io/crates/v/dav-server-opendalfs.svg)](https://crates.io/crates/dav-server-opendalfs) |
-| [object_store_opendal](integrations/object_store_opendal/README.md) | Access data via integrations to [object_store](https://docs.rs/object_store)               | [![](https://img.shields.io/crates/v/object_store_opendal.svg)](https://crates.io/crates/object_store_opendal) |
+| [object_store_opendal](integrations/object_store/README.md) | Access data via integrations to [object_store](https://docs.rs/object_store)               | [![](https://img.shields.io/crates/v/object_store_opendal.svg)](https://crates.io/crates/object_store_opendal) |
 
 ## For *ANY* services
 

diff --git a/website/docs/integrations/_category_.yml b/website/docs/integrations/_category_.yml
@@ -0,0 +1,24 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+position: 5
+label: 'Integrations'
+collapsible: true
+collapsed: true
+link:
+  type: generated-index
+  title: Integrations
diff --git a/website/docs/integrations/object_store_opendal.mdx b/website/docs/integrations/object_store_opendal.mdx
@@ -0,0 +1,9 @@
+---
+title: object_store_opendal
+---
+
+[`object_store_opendal`](https://crates.io/crates/object_store_opendal) is an integration which uses OpenDAL as a backend for the [object_store](https://docs.rs/object_store/latest/object_store/).
+
+import Docs from '../../../integrations/object_store/README.md'
+
+<Docs components={props.components} />
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -152,6 +152,10 @@ const config = {
                 label: 'Java Binding',
                 to: 'pathname:///docs/java/'
               },
+              {
+                label: 'object-store-opendal',
+                to: 'pathname:///docs/object-store-opendal/object-store-opendal'
+              },
             ]
           },
           {