Skip to content

Commit

Permalink
made doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
jdoliner committed Jul 17, 2019
1 parent 3794e13 commit 6183da5
Show file tree
Hide file tree
Showing 141 changed files with 289 additions and 161 deletions.
2 changes: 1 addition & 1 deletion doc/deployment/amazon_web_services.md
Expand Up @@ -57,7 +57,7 @@ To deploy and interact with Pachyderm, you will need `pachctl`, Pachyderm's comm
$ brew tap pachyderm/tap && brew install pachyderm/tap/pachctl@1.9

# For Linux (64 bit) or Window 10+ on WSL:
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.9.0/pachctl_1.9.0_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.9.1/pachctl_1.9.1_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
```

You can try running `pachctl version --client-only` to verify that `pachctl` has been successfully installed.
Expand Down
2 changes: 1 addition & 1 deletion doc/deployment/azure.md
Expand Up @@ -42,7 +42,7 @@ Install the following prerequisites:
* To install on Linux 64-bit or Windows 10 or later, run the following command:

```bash
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.9.0/pachctl_1.9.0_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.9.1/pachctl_1.9.1_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
```

1. Verify your installation by running `pachctl version`:
Expand Down
2 changes: 1 addition & 1 deletion doc/deployment/google_cloud_platform.md
Expand Up @@ -114,7 +114,7 @@ $ gsutil ls
$ brew tap pachyderm/tap && brew install pachyderm/tap/pachctl@1.9

# For Linux (64 bit) or Window 10+ on WSL:
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.9.0/pachctl_1.9.0_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.9.1/pachctl_1.9.1_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
```

You can then run `pachctl version --client-only` to check that the installation was successful.
Expand Down
4 changes: 2 additions & 2 deletions doc/getting_started/local_installation.md
Expand Up @@ -43,10 +43,10 @@ To reset your kubernetes cluster on Docker For Desktop just click the reset butt
$ brew tap pachyderm/tap && brew install pachyderm/tap/pachctl@1.9

# For Debian based linux (64 bit) or Window 10+ on WSL:
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.9.0/pachctl_1.9.0_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.9.1/pachctl_1.9.1_amd64.deb && sudo dpkg -i /tmp/pachctl.deb

# For all other linux flavors
$ curl -o /tmp/pachctl.tar.gz -L https://github.com/pachyderm/pachyderm/releases/download/v1.9.0/pachctl_1.9.0_linux_amd64.tar.gz && tar -xvf /tmp/pachctl.tar.gz -C /tmp && sudo cp /tmp/pachctl_1.9.0_linux_amd64/pachctl /usr/local/bin
$ curl -o /tmp/pachctl.tar.gz -L https://github.com/pachyderm/pachyderm/releases/download/v1.9.1/pachctl_1.9.1_linux_amd64.tar.gz && tar -xvf /tmp/pachctl.tar.gz -C /tmp && sudo cp /tmp/pachctl_1.9.1_linux_amd64/pachctl /usr/local/bin
```


Expand Down
3 changes: 2 additions & 1 deletion doc/pachctl/pachctl.md
Expand Up @@ -18,6 +18,7 @@ Environment variables:
### Options

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_auth.md
Expand Up @@ -10,6 +10,7 @@ Auth commands manage access to data in a Pachyderm cluster
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_auth_activate.md
Expand Up @@ -27,6 +27,7 @@ pachctl auth activate
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_auth_check.md
Expand Up @@ -14,6 +14,7 @@ pachctl auth check (none|reader|writer|owner) <repo>
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_auth_deactivate.md
Expand Up @@ -14,6 +14,7 @@ pachctl auth deactivate
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_auth_get-auth-token.md
Expand Up @@ -20,6 +20,7 @@ pachctl auth get-auth-token <username>
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_auth_get-config.md
Expand Up @@ -20,6 +20,7 @@ pachctl auth get-config
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

20 changes: 20 additions & 0 deletions doc/pachctl/pachctl_auth_get-otp.md
@@ -0,0 +1,20 @@
## pachctl auth get-otp

Get a one-time password that authenticates the holder as "username"

### Synopsis


Get a one-time password that authenticates the holder as "username"

```
pachctl auth get-otp <username>
```

### Options inherited from parent commands

```
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_auth_get.md
Expand Up @@ -14,6 +14,7 @@ pachctl auth get [<username>] <repo>
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_auth_list-admins.md
Expand Up @@ -14,6 +14,7 @@ pachctl auth list-admins
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_auth_login.md
Expand Up @@ -20,6 +20,7 @@ pachctl auth login
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_auth_logout.md
Expand Up @@ -14,6 +14,7 @@ pachctl auth logout
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_auth_modify-admins.md
Expand Up @@ -21,6 +21,7 @@ pachctl auth modify-admins
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_auth_set-config.md
Expand Up @@ -20,6 +20,7 @@ pachctl auth set-config
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_auth_set.md
Expand Up @@ -14,6 +14,7 @@ pachctl auth set <username> (none|reader|writer|owner) <repo>
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_auth_use-auth-token.md
Expand Up @@ -14,6 +14,7 @@ pachctl auth use-auth-token
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_auth_whoami.md
Expand Up @@ -14,6 +14,7 @@ pachctl auth whoami
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_completion.md
Expand Up @@ -21,6 +21,7 @@ pachctl completion
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_config.md
Expand Up @@ -10,6 +10,7 @@ Gets/sets pachyderm config values.
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_config_delete.md
Expand Up @@ -10,6 +10,7 @@
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_config_delete_context.md
Expand Up @@ -14,6 +14,7 @@ pachctl config delete context
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_config_get.md
Expand Up @@ -10,6 +10,7 @@
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_config_get_active-context.md
Expand Up @@ -14,6 +14,7 @@ pachctl config get active-context
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_config_get_context.md
Expand Up @@ -14,6 +14,7 @@ pachctl config get context
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_config_get_metrics.md
Expand Up @@ -14,6 +14,7 @@ pachctl config get metrics
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_config_list.md
Expand Up @@ -10,6 +10,7 @@
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_config_list_context.md
Expand Up @@ -14,6 +14,7 @@ pachctl config list context
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_config_set.md
Expand Up @@ -10,6 +10,7 @@
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_config_set_active-context.md
Expand Up @@ -14,6 +14,7 @@ pachctl config set active-context
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_config_set_context.md
Expand Up @@ -20,6 +20,7 @@ pachctl config set context
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_config_set_metrics.md
Expand Up @@ -14,6 +14,7 @@ pachctl config set metrics
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_config_update.md
Expand Up @@ -10,6 +10,7 @@
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_config_update_context.md
Expand Up @@ -20,6 +20,7 @@ pachctl config update context
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_copy.md
Expand Up @@ -10,6 +10,7 @@ Copy a Pachyderm resource.
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_copy_file.md
Expand Up @@ -20,6 +20,7 @@ pachctl copy file <src-repo>@<src-branch-or-commit>:<src-path> <dst-repo>@<dst-b
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_create.md
Expand Up @@ -10,6 +10,7 @@ Create a new instance of a Pachyderm resource.
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_create_branch.md
Expand Up @@ -21,6 +21,7 @@ pachctl create branch <repo>@<branch-or-commit>
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

3 changes: 2 additions & 1 deletion doc/pachctl/pachctl_create_pipeline.md
Expand Up @@ -24,6 +24,7 @@ pachctl create pipeline
### Options inherited from parent commands

```
-v, --verbose Output verbose logs
--no-color Turn off colors.
-v, --verbose Output verbose logs
```

0 comments on commit 6183da5

Please sign in to comment.