Skip to content

Commit 8857da9

Browse files
authored
Minor edits for commercial download page (#4479)
Signed-off-by: Ian Maddaus <[email protected]>
1 parent 7560bbf commit 8857da9

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

content/download/commercial.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,15 @@ Commercial customers can use Chef's Commercial API to download Chef software pac
1414

1515
## Install script
1616

17-
You can also use an install script from the API to download and install Chef packages. See the [Chef install script documentation](/chef_install_script/) for more information.
17+
You can use an install script from the API to download and install Chef packages. For more information, see the [Chef install script documentation](/chef_install_script/).
1818

1919
## License
2020

21-
You must use a license ID to download packages and review metadata with this API.
21+
To download packages and review metadata with this API, you need a license ID.
2222

23-
You can get your license ID from the [Chef Downloads portal](https://chef.io/downloads),
24-
or [contact Chef](https://www.chef.io/contact-us) if you don't already have one.
23+
You can get your license ID from the [Chef Downloads portal](https://chef.io/downloads), or [contact Chef](https://www.chef.io/contact-us) if you don't have one.
2524

26-
See [Chef's licensing documentation]({{< relref "licensing" >}}) for more information on the Chef license.
25+
For more information, see [Chef's licensing documentation]({{< relref "licensing" >}}).
2726

2827
## Endpoints
2928

@@ -38,50 +37,49 @@ The Chef Commercial Download API has the following endpoints:
3837
- `/metadata`
3938
- `/download`
4039

41-
See the [parameters section](#parameters) below to understand the query strings used in the following endpoint descriptions.
40+
For details about query strings, see the [parameters section](#parameters).
4241

4342
### architectures
4443

45-
The `architectures` endpoint returns a valid list of architecture that Chef products are built for.
46-
Any of these architectures can be used in the `m` [query string](#parameters) value in various endpoints below.
44+
The `architectures` endpoint returns a list of valid architectures for Chef products. You can use any of these architectures as the `m` [query string](#parameters) value in the endpoints below.
4745

4846
```plain
4947
https://chefdownload-commercial.chef.io/architectures
5048
```
5149

5250
### platforms
5351

54-
The `platforms` endpoint returns a list of valid platform keys along with full friendly names. Any of these platform keys can be used in the `p` [query string](#parameters) value in various endpoints below.
52+
The `platforms` endpoint returns a list of valid platform keys and friendly names. You can use any of these platform keys as the `p` [query string](#parameters) value in the endpoints below.
5553

5654
```plain
5755
https://chefdownload-commercial.chef.io/platforms
5856
```
5957

6058
### products
6159

62-
The `products` endpoint returns a list of valid product keys. In the following endpoints, you can replace the `<PRODUCT>` string with a product key in the response of this endpoint.
60+
The `products` endpoint returns a list of valid product keys. In the endpoints below, replace `<PRODUCT>` with a product key from this response.
6361

6462
```plain
6563
https://chefdownload-commercial.chef.io/products
6664
```
6765

68-
Use `eol=true` to return EOL products.
66+
To include EOL products, use `eol=true`:
6967

7068
```plain
7169
https://chefdownload-commercial.chef.io/products?eol=true
7270
```
7371

7472
### packages
7573

76-
Use `packages` to get a full list of all packages for a particular release channel and product.
74+
Use the `packages` endpoint to get a full list of packages for a particular release channel and product.
7775

78-
By default, it returns packages for the latest version.
76+
By default, this endpoint returns packages for the latest version.
7977

8078
```plain
8179
https://chefdownload-commercial.chef.io/<CHANNEL>/<PRODUCT>/packages?license_id=<LICENSE_ID>
8280
```
8381

84-
You can specify a version number with the `v` query string to get packages for a particular product version.
82+
To get packages for a specific product version, use the `v` query string:
8583

8684
```plain
8785
https://chefdownload-commercial.chef.io/<CHANNEL>/<PRODUCT>/packages?v=<VERSION_NUMBER>&license_id=<LICENSE_ID>

0 commit comments

Comments
 (0)