Merge pull request #1328 from pouchrobot/auto-doc-2018-05-16

docs: auto generate pouch cli/api docs via code
AliyunContainerService · May 16, 2018 · 3c29c40 · 3c29c40
2 parents ebb3a2b + deabef9
commit 3c29c40
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -43,6 +43,7 @@ Runrioter Wung <[email protected]>
 Sam Xie <[email protected]>
 skoo <[email protected]>
 skoo87 <[email protected]>
+soarpenguin <[email protected]>
 Starnop <[email protected]>
 Tao Qingyun <[email protected]>
 Tiramisu 1993 <[email protected]>

diff --git a/docs/commandline/pouch_exec.md b/docs/commandline/pouch_exec.md
@@ -10,6 +10,16 @@ Exec a process in a running container
 pouch exec [OPTIONS] CONTAINER COMMAND [ARG...]
 ```
 
+### Examples
+
+```
+$ pouch exec -it 25bf50 ps
+PID   USER     TIME  COMMAND
+    1 root      0:00 /bin/sh
+   38 root      0:00 ps
+
+```
+
 ### Options
 
 ```

diff --git a/docs/commandline/pouch_top.md b/docs/commandline/pouch_top.md
@@ -14,9 +14,9 @@ pouch top CONTAINER [ps OPTIONS]
 
 ```
 $ pouch top 44f675
-	UID     PID      PPID     C    STIME    TTY    TIME        CMD
-	root    28725    28714    0    3月14     ?      00:00:00    sh
-	
+UID     PID      PPID     C    STIME    TTY    TIME        CMD
+root    28725    28714    0    3月14     ?      00:00:00    sh
+
 ```
 
 ### Options