added a lot of documentation

Author: emptymalei

dataherb/command.py

@@ -141,7 +141,7 @@ def search(flora, id=None, keywords=None):
 @dataherb.command()
 @click.option("--flora", "-f", default=which_flora)
 @click.option("--workdir", "-w", default=WD, required=True)
-@click.option("--dev_addr", "-a", metavar="<IP:PORT>")
+@click.option("--dev_addr", "-a", default="localhost:52125", metavar="<IP:PORT>")
 @click.option("--recreate", "-r", default=False, required=False)
 def serve(flora, workdir, dev_addr, recreate):
     fl = Flora(flora=flora)
@@ -150,8 +150,8 @@ def serve(flora, workdir, dev_addr, recreate):
 
     mkdocs_config = str(Path(workdir) / "serve" / "mkdocs.yml")
 
-    click.echo("Open http://localhost:8000")
-    click.launch("http://localhost:8000")
+    click.echo(f"Open http://{dev_addr}")
+    click.launch(f"http://{dev_addr}")
     _serve(config_file=mkdocs_config, dev_addr=dev_addr)
 
 

docs/tutorials/create/index.md

@@ -224,4 +224,18 @@ Two things happened after this.
             ]
         }
     }
-    ```
+    ```
+
+
+
+### Sync to Remote
+
+
+!!! warning "WIP"
+    Sync local dataset to remote is still a WIP.
+
+
+After creating the dataset, run the command `dataherb upload`.
+
+!!! warning "Using Experimental Feature"
+    Use `dataherb upload --experimental True` to use experimental feature. For example, git repo will automatically add, commit ,and push.

docs/tutorials/download/index.md

@@ -0,0 +1,9 @@
+## Download
+
+Download dataset by dataherb id
+
+```
+dataherb download git-dataherb-python-demo-dataset
+```
+
+The dataset will be downloaded to the workdir set in the configuration step. The folder name will be the dataset id.

docs/tutorials/search/index.md

@@ -0,0 +1,22 @@
+## Search
+
+
+### Search by keyword
+
+```bash
+dataherb search demo
+```
+
+From the returns, we can find the dataset id which can be used to download the dataset.
+
+For example, we find this `git-dataherb-python-demo-dataset` id as we just added this dataset in the creation step.
+
+
+### Search by ID
+
+Search by dataherb id
+
+```bash
+dataherb search -i covid19_eu_data
+```
+

docs/tutorials/serve/assets/dataherb_serve_demo_dataset.png

@@ -0,0 +1,16 @@
+## Serve
+
+!!! warning "WIP"
+
+    Though it works, we are still improving the UI.
+
+
+We can serve the whole flora as a website. To achive this, simple run
+
+```bash
+dataherb serve
+```
+
+This is an example. You can search for datasets using the search box.
+
+![](assets/dataherb_serve_demo_dataset.png)

docs/tutorials/serve/index.md

@@ -77,6 +77,9 @@ nav:
     - "Tutorials": tutorials/index.md
     - "Configuration": tutorials/configuration/index.md
     - "Create Dataset": tutorials/create/index.md
+    - "Search Dataset": tutorials/search/index.md
+    - "Download Dataset": tutorials/download/index.md
+    - "Serve Flora": tutorials/serve/index.md
   - References:
     - "Introduction": references/index.md
     - "dataherb.command": references/command.md