Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Mar 7, 2024

Conversation

zjregee
Copy link
Member

@zjregee zjregee commented Mar 6, 2024

fix: #4316 .

@Xuanwo
Copy link
Member

Xuanwo commented Mar 6, 2024

Apologies for the lack of clarity on this issue. I aim to build and publish the API documentation for object-store-opendal using rustdoc, similar to what we've done with opendal:

build-rust-doc:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Rust toolchain
uses: ./.github/actions/setup
with:
need-rocksdb: true
need-protoc: true
github-token: ${{ secrets.GITHUB_TOKEN }}
# Revert to nightly after https://github.com/apache/opendal/issues/4161 addressed
- name: Setup Rust Nightly
run: |
rustup toolchain install nightly-2024-01-01
- uses: actions/setup-java@v4
with:
distribution: temurin
java-version: '17'
- name: Build OpenDAL doc
working-directory: core
run: cargo +nightly-2024-01-01 doc --lib --no-deps --all-features
env:
LD_LIBRARY_PATH: ${{ env.JAVA_HOME }}/lib/server:${{ env.LD_LIBRARY_PATH }}
# Enable cfg docs to make sure docs are built.
RUSTDOCFLAGS: "--cfg docs"
- name: Upload docs
uses: actions/upload-artifact@v3
with:
name: rust-docs
path: ./core/target/doc

So we can read object-store-opendal docs like https://opendal.apache.org/docs/rust/opendal/

@zjregee
Copy link
Member Author

zjregee commented Mar 7, 2024

Got this, I had a misunderstanding here before.

Copy link
Member

@Xuanwo Xuanwo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect, thanks!

@Xuanwo Xuanwo merged commit a2e7749 into apache:main Mar 7, 2024
21 checks passed
@Xuanwo
Copy link
Member

Xuanwo commented Mar 7, 2024

Visit https://opendal.apache.org/docs/object-store-opendal/object-store-opendal is not found, would you like to take a look? Thanks.

@zjregee
Copy link
Member Author

zjregee commented Mar 7, 2024

There's a typo here, I've submitted a PR to fix it.

@zjregee
Copy link
Member Author

zjregee commented Mar 7, 2024

object_store_opendal document has been uploaded in https://opendal.apache.org/docs/object-store-opendal/object_store_opendal/ but does not point to it correctly.

@zjregee zjregee deleted the publish-object-store-opendal-docs branch March 7, 2024 04:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Build and publish docs for object_store_opendal
2 participants