You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by xu...@apache.org on 2023/10/16 09:23:45 UTC
[incubator-opendal] branch main updated: docs: Add docs on website for Vercel Artifacts service (#3303)
This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git
The following commit(s) were added to refs/heads/main by this push:
new 5d0850bb6 docs: Add docs on website for Vercel Artifacts service (#3303)
5d0850bb6 is described below
commit 5d0850bb61c22e71e10c2fd1498d1a35d939abb4
Author: Nadeshiko Manju <me...@manjusaka.me>
AuthorDate: Mon Oct 16 17:23:39 2023 +0800
docs: Add docs on website for Vercel Artifacts service (#3303)
Signed-off-by: Manjusaka <me...@manjusaka.me>
---
core/src/services/vercel_artifacts/builder.rs | 45 +-------------------
core/src/services/vercel_artifacts/docs.md | 42 +++++++++++++++++++
website/docs/services/vercel_artifacts.mdx | 60 +++++++++++++++++++++++++++
3 files changed, 103 insertions(+), 44 deletions(-)
diff --git a/core/src/services/vercel_artifacts/builder.rs b/core/src/services/vercel_artifacts/builder.rs
index c2c2b33ca..2390c09fd 100644
--- a/core/src/services/vercel_artifacts/builder.rs
+++ b/core/src/services/vercel_artifacts/builder.rs
@@ -23,50 +23,7 @@ use crate::Scheme;
use crate::*;
/// [Vercel Cache](https://vercel.com/docs/concepts/monorepos/remote-caching) backend support.
-///
-/// # Capabilities
-///
-/// This service can be used to:
-///
-/// - [ ] stat
-/// - [x] read
-/// - [x] write
-/// - [x] create_dir
-/// - [x] delete
-/// - [ ] ~~copy~~
-/// - [ ] ~~rename~~
-/// - [ ] ~~list~~
-/// - [ ] ~~scan~~
-/// - [ ] ~~presign~~
-/// - [ ] blocking
-///
-/// # Notes
-/// # Configuration
-///
-/// - `access_token`: set the access_token for Rest API
-///
-/// You can refer to [`VercelArtifactsBuilder`]'s docs for more information
-///
-/// # Example
-///
-/// ## Via Builder
-///
-/// ```no_run
-/// use anyhow::Result;
-/// use opendal::services::VercelArtifacts;
-/// use opendal::Operator;
-///
-/// #[tokio::main]
-/// async fn main() -> Result<()> {
-/// // create backend builder
-/// let mut builder = VercelArtifacts::default();
-///
-/// builder.access_token("xxx");
-///
-/// let op: Operator = Operator::new(builder)?.finish();
-/// Ok(())
-/// }
-/// ```
+#[doc = include_str!("docs.md")]
#[derive(Default)]
pub struct VercelArtifactsBuilder {
access_token: Option<String>,
diff --git a/core/src/services/vercel_artifacts/docs.md b/core/src/services/vercel_artifacts/docs.md
new file mode 100644
index 000000000..61eadc661
--- /dev/null
+++ b/core/src/services/vercel_artifacts/docs.md
@@ -0,0 +1,42 @@
+## Capabilities
+
+This service can be used to:
+
+- [ ] stat
+- [x] read
+- [x] write
+- [x] create_dir
+- [x] delete
+- [ ] ~~copy~~
+- [ ] ~~rename~~
+- [ ] ~~list~~
+- [ ] ~~scan~~
+- [ ] ~~presign~~
+- [ ] blocking
+
+## Configuration
+
+- `access_token`: set the access_token for Rest API
+
+You can refer to [`VercelArtifactsBuilder`]'s docs for more information
+
+## Example
+
+### Via Builder
+
+```no_run
+use anyhow::Result;
+use opendal::services::VercelArtifacts;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+ // create backend builder
+ let mut builder = VercelArtifacts::default();
+
+ builder.access_token("xxx");
+
+ let op: Operator = Operator::new(builder)?.finish();
+ Ok(())
+}
+```
diff --git a/website/docs/services/vercel_artifacts.mdx b/website/docs/services/vercel_artifacts.mdx
new file mode 100644
index 000000000..d00036029
--- /dev/null
+++ b/website/docs/services/vercel_artifacts.mdx
@@ -0,0 +1,60 @@
+---
+title: Vercel Artifacts
+---
+
+[Vercel Cache](https://vercel.com/docs/concepts/monorepos/remote-caching) service support.
+
+import Docs from '../../../core/src/services/vercel_artifacts/docs.md'
+
+<Docs components={props.components} />
+
+### Via Config
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs>
+ <TabItem value="rust" label="Rust" default>
+
+```rust
+use anyhow::Result;
+use opendal::Operator;
+use opendal::Scheme;
+use std::collections::HashMap;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+ let mut map = HashMap::new();
+ map.insert("access_token".to_string(), "your_access_token".to_string());
+
+ let op: Operator = Operator::via_map(Scheme::VercelArtifacts, map)?;
+ Ok(())
+}
+```
+
+ </TabItem>
+ <TabItem value="node.js" label="Node.js">
+
+```javascript
+import { Operator } from "opendal";
+
+async function main() {
+ const op = new Operator("vercel_artifacts", {
+ access_token: "your_access_token",
+ });
+}
+```
+
+ </TabItem>
+ <TabItem value="python" label="Python">
+
+```python
+import opendal
+
+op = opendal.Operator("vercel_artifacts",
+ access_token="your_access_token",
+)
+```
+
+ </TabItem>
+</Tabs>
\ No newline at end of file