docs: update version control chapter based on newly added Branch section

1. remove "linear version control" description in version_control.rst 2. modify content about creating draft in draft_and_commit.rst 3. modify content about branch and draft in glossary.rst PR Closed: #670
Graviti-AI · Jun 7, 2021 · 4ffdb65 · 4ffdb65
1 parent bd92d9f
commit 4ffdb65
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 5 deletions.
diff --git a/docs/code/draft_and_commit.py b/docs/code/draft_and_commit.py
@@ -31,6 +31,12 @@
 # is_draft = True (True for draft, False for commit)
 draft_number = dataset_client.status.draft_number
 # draft_number = 1
+branch_name = dataset_client.status.branch_name
+# branch_name = main
+""""""
+
+"""Create Draft on a Branch"""
+dataset_client.create_draft("draft-1", branch_name="main")
 """"""
 
 """List Drafts"""

diff --git a/docs/source/features/version_control.rst b/docs/source/features/version_control.rst
@@ -2,7 +2,7 @@
  Version Control
 #################
 
-TensorBay currently supports the linear version control.
+TensorBay supports version control.
 A new version of a dataset can be built upon the previous version.
 :numref:`Figure. %s <version_control>` demonstrates the relations
 between different versions of a dataset.

diff --git a/docs/source/reference/glossary.rst b/docs/source/reference/glossary.rst
@@ -21,8 +21,6 @@ branch
 
 Similar to git, a branch is a lightweight pointer to one of the commits.
 
-Currently, TensorBay only supports a single branch, which is the default "main" branch.
-
 Every time a :ref:`reference/glossary:commit` is submitted,
 the main branch pointer moves forward automatically to the latest commit.
 
@@ -130,7 +128,7 @@ draft
 
 Similar with Git, a draft is a workspace in which changing the dataset is allowed.
 
-A draft is created based on a :ref:`reference/glossary:commit`,
+A draft is created based on a :ref:`reference/glossary:branch`,
 and the changes inside it will be made into a commit.
 
 There are scenarios when modifications of a dataset are required,

diff --git a/docs/source/version_control/draft_and_commit.rst b/docs/source/version_control/draft_and_commit.rst
@@ -25,7 +25,8 @@ Authorization
 Create Draft
 *************
 
-TensorBay SDK supports creating the draft straightforwardly, which is based on the current commit.
+TensorBay SDK supports creating the draft straightforwardly, which is based on the current branch.
+Note that currently there can be only one open draft in each branch.
 
 .. literalinclude:: ../../../docs/code/draft_and_commit.py
       :language: python
@@ -40,6 +41,13 @@ The draft number will be auto-increasing every time a draft is created.
       :start-after: """Draft Number Will Be Stored"""
       :end-before: """"""
 
+Also, TensorBay SDK supports creating a draft based on a given branch.
+
+.. literalinclude:: ../../../docs/code/draft_and_commit.py
+      :language: python
+      :start-after: """Create Draft on a Branch"""
+      :end-before: """"""
+
 ************
 List Drafts
 ************