Skip to content

Commit bbbfa5b

Browse files
committed
(doc) Add REFERENCE.md link to README
The puppet-strings tool doesn't play nicely with long task descriptions, truncating them in the summary, so I shortened those to fit. Detailed task descriptions will be in the README.
1 parent 4df5599 commit bbbfa5b

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,10 @@ bolt task run openvox_bootstrap::install_build_artifact \
7474
--run-as root
7575
```
7676

77+
## Reference
78+
79+
See [REFERENCE.md](./REFERENCE.md) for the generated reference doc.
80+
7781
## TODO
7882

7983
* Windows support

REFERENCE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
### Tasks
88

99
* [`install`](#install): Installs an openvox package. By default, this will be the latest openvox-agent from the latest collection.
10-
* [`install_build_artifact`](#install_build_artifact): Downloads and installs a package directly from openvox build artifact server. This can be used to help with testing builds prior to release.
10+
* [`install_build_artifact`](#install_build_artifact): Downloads and installs a package directly from the openvox build artifact server.
1111

1212
## Tasks
1313

@@ -51,7 +51,7 @@ The yum source repository to retrieve rpm packages from.
5151

5252
### <a name="install_build_artifact"></a>`install_build_artifact`
5353

54-
Downloads and installs a package directly from openvox build artifact server. This can be used to help with testing builds prior to release. (To install a released version, use the openvox_bootstrap::install task.)
54+
Downloads and installs a package directly from the openvox build artifact server.
5555

5656
**Supports noop?** false
5757

tasks/install_build_artifact.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"description": "Downloads and installs a package directly from openvox build artifact server. This can be used to help with testing builds prior to release. (To install a released version, use the openvox_bootstrap::install task.)",
2+
"description": "Downloads and installs a package directly from the openvox build artifact server.",
33
"parameters": {
44
"package": {
55
"description": "The name of the package to install.",

0 commit comments

Comments
 (0)