Skip to content

Commit

Permalink
docs: keep docs updated and tidy (#4709)
Browse files Browse the repository at this point in the history
  • Loading branch information
tisonkun committed Jun 7, 2024
1 parent f2aa333 commit 7bf40ec
Show file tree
Hide file tree
Showing 57 changed files with 60 additions and 3,032 deletions.
8 changes: 8 additions & 0 deletions website/docs/binding-java.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Java API
sidebar_position: 4
---

Read the nightly version of Java API docs at [here](pathname:///docs/java/).

Read the latest stable version instead at https://javadoc.io/doc/org.apache.opendal/opendal-java/latest/index.html.
8 changes: 8 additions & 0 deletions website/docs/binding-nodejs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Node.js API
sidebar_position: 6
---

Read the nightly version of Node.js API docs at [here](pathname:///docs/nodejs/).

Read the README of latest stable version instead at https://www.npmjs.com/package/opendal.
8 changes: 8 additions & 0 deletions website/docs/binding-python.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Python API
sidebar_position: 5
---

Read the nightly version of Python API docs at [here](pathname:///docs/python/).

Read the README of latest stable version instead at https://pypi.org/project/opendal/.
8 changes: 8 additions & 0 deletions website/docs/dav-server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: WebDAV Integration
sidebar_position: 8
---

Read the nightly version of the API docs at [here](pathname:///docs/dav-server-opendalfs/dav_server_opendalfs).

Read the latest stable version instead at https://docs.rs/dav-server-opendalfs/latest/dav_server_opendalfs/index.html.
24 changes: 0 additions & 24 deletions website/docs/integrations/_category_.yml

This file was deleted.

7 changes: 0 additions & 7 deletions website/docs/integrations/dav-server-opendalfs.mdx

This file was deleted.

9 changes: 0 additions & 9 deletions website/docs/integrations/object_store_opendal.mdx

This file was deleted.

8 changes: 8 additions & 0 deletions website/docs/object-store.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: object_store Integration
sidebar_position: 7
---

Read the nightly version of the API docs at [here](pathname:///docs/object-store-opendal/object_store_opendal).

Read the latest stable version instead at https://docs.rs/object_store_opendal/latest/object_store_opendal/index.html.
4 changes: 2 additions & 2 deletions website/docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Quickstart
sidebar_position: 3
sidebar_position: 2
---

Apache OpenDAL™ can be easily integrated into different software with its Rust core and multilingual bindings.
Expand All @@ -20,7 +20,7 @@ cargo add opendal
Or add the following line to your Cargo.toml:

```shell
opendal = "0.40.0"
opendal = "0.46.0"
```

### Demo
Expand Down
18 changes: 18 additions & 0 deletions website/docs/rust-core.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Rust Core
sidebar_position: 3
---

Read the nightly version of Rust API docs at [here](pathname:///docs/rust/opendal/).

Read the latest stable version instead at https://docs.rs/opendal/latest/opendal/index.html.

Below are selected docs you should read:

| Topic | Link |
| -------- | --------------------------------------------------------------- |
| Usage | https://docs.rs/opendal/latest/opendal/index.html |
| Concepts | https://docs.rs/opendal/latest/opendal/docs/concepts/index.html |
| Services | https://docs.rs/opendal/latest/opendal/services/index.html |
| Layers | https://docs.rs/opendal/latest/opendal/layers/index.html |
| Upgrade | https://docs.rs/opendal/latest/opendal/docs/upgrade/index.html |
24 changes: 0 additions & 24 deletions website/docs/services/_category_.yml

This file was deleted.

69 changes: 0 additions & 69 deletions website/docs/services/atomicserver.mdx

This file was deleted.

72 changes: 0 additions & 72 deletions website/docs/services/azblob.mdx

This file was deleted.

73 changes: 0 additions & 73 deletions website/docs/services/azdls.mdx

This file was deleted.

Loading

0 comments on commit 7bf40ec

Please sign in to comment.