Skip to content

Commit 197264a

Browse files
sverdlov93sverdlov93
authored
Reformat new Docs, fix tables and typos and add missing envs (#1932)
1 parent 53b6054 commit 197264a

7 files changed

+1265
-1259
lines changed

Diff for: ‎docs/common/env.go

+4
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ const (
3636
JfrogCliBuildProject = ` JFROG_CLI_BUILD_PROJECT
3737
Artifactory project key.`
3838

39+
JfrogCliServerID = ` JFROG_CLI_SERVER_ID
40+
Server ID configured using the config command.`
41+
3942
Ci = ` CI
4043
[Default: false]
4144
If true, disables interactive prompts and progress bar.`
@@ -104,6 +107,7 @@ func GetGlobalEnvVars() string {
104107
JfrogCliBuildName,
105108
JfrogCliBuildNumber,
106109
JfrogCliBuildProject,
110+
JfrogCliServerID,
107111
Ci,
108112
JfrogCliPluginsServer,
109113
JfrogCliPluginsRepo,

Diff for: ‎documentation/CLI-for-JFrog-Artifactory.md

+882-881
Large diffs are not rendered by default.

Diff for: ‎documentation/CLI-for-JFrog-Distribution.md

+77-77
Large diffs are not rendered by default.

Diff for: ‎documentation/CLI-for-JFrog-Mission-Control.md

+56-56
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ Syntax
1515

1616
Where:
1717

18-
| | |
19-
| --- | --- |
20-
| command-name | The command to execute. Note that you can use either the full command name or its abbreviation. |
21-
| global-options | A set of global options that may be used for all commands:<br><br>`--url:` (Optional) Mission Control URL.<br><br>`--access-token:` (Optional) Mission Control admin access token.<br><br>**Use the config command**<br><br>To avoid having to set these for every command, you may set them once using the [config](#CLIforJFrogMissionControl-Configuration) command and then omit them for every following command. |
22-
| command-options | A set of options corresponding to the command |
23-
| arguments | A set of arguments corresponding to the command |
18+
| | |
19+
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
20+
| command-name | The command to execute. Note that you can use either the full command name or its abbreviation. |
21+
| global-options | A set of global options that may be used for all commands:<br><br>`--url:` (Optional) Mission Control URL.<br><br>`--access-token:` (Optional) Mission Control admin access token.<br><br>**Use the config command**<br><br>To avoid having to set these for every command, you may set them once using the [config](#CLIforJFrogMissionControl-Configuration) command and then omit them for every following command. |
22+
| command-options | A set of options corresponding to the command |
23+
| arguments | A set of arguments corresponding to the command |
2424

2525

2626

@@ -31,16 +31,16 @@ Commands
3131

3232
The following sections describe the commands available in the JFrog CLI for use with JFrog Mission Control.
3333

34-
### Adding a JPD 
34+
### Adding a JPD
3535

36-
| | |
37-
| --- | --- |
38-
| Command name | jpd-add |
39-
| Abbreviation | ja |
40-
| Description | Adds a JPD to Mission Control |
41-
| Command arguments | |
42-
| Config | Path to a JSON configuration file containing the JPD details. |
43-
| Command options | The command accepts no options, other than the global options. |
36+
| | |
37+
|-------------------|----------------------------------------------------------------|
38+
| Command name | jpd-add |
39+
| Abbreviation | ja |
40+
| Description | Adds a JPD to Mission Control |
41+
| Command arguments | |
42+
| Config | Path to a JSON configuration file containing the JPD details. |
43+
| Command options | The command accepts no options, other than the global options. |
4444

4545
#### **Config JSON schema**
4646
```
@@ -65,32 +65,32 @@ The following sections describe the commands available in the JFrog CLI for use
6565

6666
### Deleting a JPD
6767

68-
| | |
69-
| --- | --- |
70-
| Command name | jpd-delete |
71-
| Abbreviation | jd |
72-
| Description | Delete a JPD from Mission Control. |
73-
| Command arguments | |
74-
| JPD ID | The ID of the JPD to be removed from Mission Control. |
75-
| | |
76-
| Command options | The command accepts no options, other than the global options. |
68+
| | |
69+
|-------------------|----------------------------------------------------------------|
70+
| Command name | jpd-delete |
71+
| Abbreviation | jd |
72+
| Description | Delete a JPD from Mission Control. |
73+
| Command arguments | |
74+
| JPD ID | The ID of the JPD to be removed from Mission Control. |
75+
| | |
76+
| Command options | The command accepts no options, other than the global options. |
7777

7878
**Example**
7979

8080
jf mc jd my-jpd-id
8181

8282
### Acquiring a License
8383

84-
| | |
85-
| --- | --- |
86-
| Command name | license-acquire |
87-
| Abbreviation | la |
88-
| Description | Acquire a license from the specified bucket and mark it as taken by the provided name. |
89-
| Command arguments | |
90-
| Bucket ID | Bucket name or identifier to acquire license from. |
91-
| Name | A custom name used to mark the license as taken. Can be a JPD ID or a temporary name. If the license does not end up being used by a JPD, this is the name that should be used to release the license. |
92-
| | |
93-
| Command options | The command accepts no options, other than the global options. |
84+
| | |
85+
|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
86+
| Command name | license-acquire |
87+
| Abbreviation | la |
88+
| Description | Acquire a license from the specified bucket and mark it as taken by the provided name. |
89+
| Command arguments | |
90+
| Bucket ID | Bucket name or identifier to acquire license from. |
91+
| Name | A custom name used to mark the license as taken. Can be a JPD ID or a temporary name. If the license does not end up being used by a JPD, this is the name that should be used to release the license. |
92+
| | |
93+
| Command options | The command accepts no options, other than the global options. |
9494

9595
**Examples**
9696

@@ -102,17 +102,17 @@ Assign a license from the _my-bucket-id_ and mark it as taken by _my-unique-name
102102

103103
### Deploying a License
104104

105-
| | |
106-
| --- | --- |
107-
| Command name | license-deploy |
108-
| Abbreviation | ld |
109-
| Description | pecified bucket to an existing JPD. You may also deploy a number of licenses to an Artifactory HA. |
110-
| Command arguments | |
111-
| Bucket ID | Bucket name or identifier to deploy licenses from. |
112-
| JPD ID | An existing JPD's ID. |
113-
| | |
114-
| Command options | |
115-
| --license-count | \[Default: 1\]<br><br>The number of licenses to deploy. Minimum value is 1. |
105+
| | |
106+
|-------------------|-----------------------------------------------------------------------------------------------------|
107+
| Command name | license-deploy |
108+
| Abbreviation | ld |
109+
| Description | specified bucket to an existing JPD. You may also deploy a number of licenses to an Artifactory HA. |
110+
| Command arguments | |
111+
| Bucket ID | Bucket name or identifier to deploy licenses from. |
112+
| JPD ID | An existing JPD's ID. |
113+
| | |
114+
| Command options | |
115+
| --license-count | \[Default: 1\]<br><br>The number of licenses to deploy. Minimum value is 1. |
116116

117117
**Example**
118118

@@ -122,19 +122,19 @@ Deploy a single license from _my-bucket-id_ on _my-jpd-id_.
122122

123123
### Releasing a License
124124

125-
| | |
126-
| --- | --- |
127-
| Command name | license-release |
128-
| Abbreviation | lr |
129-
| Description | Release all licenses of a JPD and return them to the specified bucket. |
130-
| Command arguments | |
131-
| Bucket ID | Bucket name or identifier to release all of its licenses. |
132-
| JPD ID | If the license is used by a JPD, pass the JPD's ID. If the license was only acquired but is not used, pass the name it was acquired with. |
133-
| | |
134-
| Command options | The command accepts no options, other than the global options. |
125+
| | |
126+
|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
127+
| Command name | license-release |
128+
| Abbreviation | lr |
129+
| Description | Release all licenses of a JPD and return them to the specified bucket. |
130+
| Command arguments | |
131+
| Bucket ID | Bucket name or identifier to release all of its licenses. |
132+
| JPD ID | If the license is used by a JPD, pass the JPD's ID. If the license was only acquired but is not used, pass the name it was acquired with. |
133+
| | |
134+
| Command options | The command accepts no options, other than the global options. |
135135

136136
**Example**
137137

138-
Releases all licenses of _my-jpd-id_ to to _my-bucket-id_.
138+
Releases all licenses of _my-jpd-id_ to _my-bucket-id_.
139139

140140
jf mc lr my-bucket-id my-jpd-id

0 commit comments

Comments
 (0)