Update glossary documentation for project (#129)

zanata · Sep 22, 2016 · a6e96af · a6e96af
1 parent e48e996
commit a6e96af
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 4 deletions.
diff --git a/docs/commands/glossary-delete.md b/docs/commands/glossary-delete.md
@@ -9,12 +9,17 @@ This command will:
 1. Look up the server config from `zanata.xml`.
 2. Delete glossary entry with id `1005`
 
-To delete all glossary in Zanata
+To delete all system glossary entries
 
 ```bash
 zanata-cli glossary-delete --all
 ```
 
+To delete all project glossary entries
+```
+zanata-cli glossary-delete --all --project project1
+```
+
 To see all options available for `glossary-delete` option:
 ```bash
 zanata-cli help glossary-delete

diff --git a/docs/commands/glossary-pull.md b/docs/commands/glossary-pull.md
@@ -1,15 +1,31 @@
 To download glossary entries from Zanata, the command-line client's `glossary-pull` command can be used.
 
+### Pull from System glossary
+
 ```bash
 zanata-cli glossary-pull
 ```
 
 This command will:
 
-1. look up the server config from `zanata.xml`.
+1. Look up the server config from `zanata.xml`.
 2. Download all glossary entries in server
 3. The file will be in `.csv` format. (default)
 
+### Pull from Project glossary
+
+```bash
+zanata-cli glossary-pull --project project1
+```
+
+This command will:
+
+1. look up the server config from `zanata.xml`.
+2. Download all glossary entries from `project1` in server
+3. The file will be in `.csv` format. (default)
+
+### Pull in different format
+
 To download in different format, use the `--file-type` options (csv or po). 
 For example:
 

diff --git a/docs/commands/glossary-push.md b/docs/commands/glossary-push.md
@@ -1,6 +1,9 @@
 To push glossary entries to Zanata, the command-line client's `glossary-push` command can be used.
+
 The source language of the glossary file should be in `en-US`
 
+### Push to System glossary
+
 ```bash
 zanata-cli glossary-push --file glossary.csv
 ```
@@ -10,7 +13,21 @@ This command will:
 1. Look up the server config from `zanata.xml`.
 2. Push glossary.csv file to Zanata.
 
-To push a po file, `--trans-lang` option will be needed.
+### Push to Project glossary
+
+```bash
+zanata-cli glossary-push --file glossary.csv --project project1
+```
+
+This command will:
+
+1. Look up the server config from `zanata.xml`.
+2. Push glossary.csv file to `project1` in Zanata.
+
+
+### Push po file
+
+`--trans-lang` option will be needed.
 For example:
 
 ```bash
@@ -20,4 +37,4 @@ zanata-cli glossary-push --file german-glossary.po --trans-lang de
 To see all options available for `glossary-push` option:
 ```bash
 zanata-cli help glossary-push
-```
+```