docs: update the v0 & v1 envd reference (#1969)

Signed-off-by: Keming <[email protected]>
tensorchord · Feb 7, 2025 · 698349a · 698349a
1 parent 6b49023
commit 698349a
Show file tree

Hide file tree

Showing 10 changed files with 30 additions and 30 deletions.
diff --git a/envd/api/v0/__init__.py b/envd/api/v0/__init__.py
@@ -19,6 +19,12 @@
 in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
 Please update the python file there instead of directly editing file inside envd-docs repo.
 :::
+
+::: warning
+v0 syntax is no longer supported from `envd>=v1.0`. Check the [upgrade guide](https://envd.tensorchord.ai/guide/v1.html).
+
+If you want to use v0 syntax, try `pip install 'envd<1'`.
+:::
 """
 
 from typing import List, Optional

diff --git a/envd/api/v0/config.py b/envd/api/v0/config.py
@@ -19,6 +19,12 @@
 in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
 Please update the python file there instead of directly editing file inside envd-docs repo.
 :::
+
+::: warning
+v0 syntax is no longer supported from `envd>=v1.0`. Check the [upgrade guide](https://envd.tensorchord.ai/guide/v1.html).
+
+If you want to use v0 syntax, try `pip install 'envd<1'`.
+:::
 """
 
 from typing import List, Optional

diff --git a/envd/api/v0/install.py b/envd/api/v0/install.py
@@ -19,6 +19,12 @@
 in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
 Please update the python file there instead of directly editing file inside envd-docs repo.
 :::
+
+::: warning
+v0 syntax is no longer supported from `envd>=v1.0`. Check the [upgrade guide](https://envd.tensorchord.ai/guide/v1.html).
+
+If you want to use v0 syntax, try `pip install 'envd<1'`.
+:::
 """
 
 from typing import List, Optional

diff --git a/envd/api/v0/io.py b/envd/api/v0/io.py
@@ -19,6 +19,12 @@
 in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
 Please update the python file there instead of directly editing file inside envd-docs repo.
 :::
+
+::: warning
+v0 syntax is no longer supported from `envd>=v1.0`. Check the [upgrade guide](https://envd.tensorchord.ai/guide/v1.html).
+
+If you want to use v0 syntax, try `pip install 'envd<1'`.
+:::
 """
 
 from typing import Optional

diff --git a/envd/api/v0/runtime.py b/envd/api/v0/runtime.py
@@ -19,6 +19,12 @@
 in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
 Please update the python file there instead of directly editing file inside envd-docs repo.
 :::
+
+::: warning
+v0 syntax is no longer supported from `envd>=v1.0`. Check the [upgrade guide](https://envd.tensorchord.ai/guide/v1.html).
+
+If you want to use v0 syntax, try `pip install 'envd<1'`.
+:::
 """
 
 from typing import Dict, List, Optional

diff --git a/envd/api/v1/__init__.py b/envd/api/v1/__init__.py
@@ -19,12 +19,6 @@
 in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
 Please update the python file there instead of directly editing file inside envd-docs repo.
 :::
-
-::: warning
-Enable v1 by adding `# syntax=v1` to the 1st line of your envd file.
-
-v1 is experimental and may change in the future. Make sure to freeze the envd version for online CI/CD.
-:::
 """
 
 from typing import List, Optional

diff --git a/envd/api/v1/config.py b/envd/api/v1/config.py
@@ -19,12 +19,6 @@
 in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
 Please update the python file there instead of directly editing file inside envd-docs repo.
 :::
-
-::: warning
-Enable v1 by adding `# syntax=v1` to the 1st line of your envd file.
-
-v1 is experimental and may change in the future. Make sure to freeze the envd version for online CI/CD.
-:::
 """
 
 from typing import List, Optional

diff --git a/envd/api/v1/install.py b/envd/api/v1/install.py
@@ -19,12 +19,6 @@
 in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
 Please update the python file there instead of directly editing file inside envd-docs repo.
 :::
-
-::: warning
-Enable v1 by adding `# syntax=v1` to the 1st line of your envd file.
-
-v1 is experimental and may change in the future. Make sure to freeze the envd version for online CI/CD.
-:::
 """
 
 from typing import Optional, Sequence

diff --git a/envd/api/v1/io.py b/envd/api/v1/io.py
@@ -19,12 +19,6 @@
 in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
 Please update the python file there instead of directly editing file inside envd-docs repo.
 :::
-
-::: warning
-Enable v1 by adding `# syntax=v1` to the 1st line of your envd file.
-
-v1 is experimental and may change in the future. Make sure to freeze the envd version for online CI/CD.
-:::
 """
 
 from typing import Optional

diff --git a/envd/api/v1/runtime.py b/envd/api/v1/runtime.py
@@ -19,12 +19,6 @@
 in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
 Please update the python file there instead of directly editing file inside envd-docs repo.
 :::
-
-::: warning
-Enable v1 by adding `# syntax=v1` to the 1st line of your envd file.
-
-v1 is experimental and may change in the future. Make sure to freeze the envd version for online CI/CD.
-:::
 """
 
 from typing import Dict, List, Optional