From 4d080169f0ec5bf4308f2a0ae8951f1f0b9aa941 Mon Sep 17 00:00:00 2001 From: Irmantas Date: Fri, 16 Sep 2016 17:32:34 +0100 Subject: [PATCH] Update to ensure that all documentation content is up-to-date --- site/_docs/reference/cli/target.md | 51 ++++++++++++++++++++++- site/_docs/reference/cli/workspace.md | 58 ++++++++++++++++++++++++++- 2 files changed, 107 insertions(+), 2 deletions(-) diff --git a/site/_docs/reference/cli/target.md b/site/_docs/reference/cli/target.md index 85b24f58f..f8c96e112 100644 --- a/site/_docs/reference/cli/target.md +++ b/site/_docs/reference/cli/target.md @@ -1,6 +1,55 @@ --- layout: docs -chapter: Reference +chapter: Reference - CLI title: target permalink: /docs/reference/cli/target/ --- + +[Back to CLI Commands](/adop-docker-compose/docs/reference/cli/) + +## Command + +`./adop target ` + +Used for setting up environment variables to connect with ADOP stack. + +## Subcommands + +### set + + + + + + + + + + + + + + + + + + + + + + + + + + +
Subcommand
set [<options>]Sets the environment variables to point to ADOP stack.
Option
-t [<ENDPOINT>]Sets the endpoint URL to connect to ADOP stack, where <ENDPOINT> the URL to ADOP stack (required) (hint: https://54.77.198.55/).
-u [<USERNAME>]Sets the username required for authentication with ADOP stack, where <USERNAME> the username with permissions to access ADOP stack (required).
-p [<PASSWORD>]Sets the password required for authentication with ADOP stack, where <PASSWORD> the password with permissions to access ADOP stack (required).
+ +### unset + +Unsets the environment variables pointing to ADOP stack. + +### help + +Prints out help information. + +## Examples [WIP] diff --git a/site/_docs/reference/cli/workspace.md b/site/_docs/reference/cli/workspace.md index 2b4818073..95be7e6c5 100644 --- a/site/_docs/reference/cli/workspace.md +++ b/site/_docs/reference/cli/workspace.md @@ -1,6 +1,62 @@ --- layout: docs -chapter: Command Line Interface +chapter: Reference - CLI title: workspace permalink: /docs/reference/cli/workspace/ --- + +[Back to CLI Commands](/adop-docker-compose/docs/reference/cli/) + +## Command + +`./adop workspace [] ` + +Used for setting up workspaces to store projects. + +## Options + + + + + + + + + + +
Option
-w <WORKSPACE_NAME> Sets the name for the workspace, where <WORKSPACE_NAME> is the name of the workspace that you are creating (required).
+ +## Subcommands + +### create + + + + + + + + + + + + + + + + + + + + + + + + + + +
Subcommand
create [<options>]Creates a new workspace in Jenkins.
Option
-a [<ADMIN_USERS>]Sets users with admin permissions on the workspace, where <ADMIN_USERS> is a comma separated list of users (optional) (default: blank).
-d [<DEVELOPER_USERS>]Sets users with developer permissions on the workspace, where <DEVELOPER_USERS> is a comma separated list of users (optional) (default: blank).
-v [<VIEWER_USERS>]Sets users with viewer (read-only) permissions on the workspace, where <VIEWER_USERS> is a comma separated list of users (optional) (default: blank).
+ +## Examples [WIP] + +`./adop workspace -w create []` - creates a new workspace in Jenkins. \ No newline at end of file