Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Clean up for upstream docs for add subcommand and devfile resource type #329

Merged
merged 1 commit into from
Nov 16, 2024
Merged

Clean up for upstream docs for add subcommand and devfile resource type #329

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 9 additions & 26 deletions docs/installing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,11 +296,10 @@ $ ansible-creator add --help

#### Positional Arguments

| Parameter | Description |
| ------------ | --------------------------------------------- |
| content-type | Specifies the type of content to add. |
| resource | Add resources to an existing Ansible project. |
| plugin | Add a plugin to an Ansible collection. |
| Parameter | Description |
| --------- | --------------------------------------------- |
| resource | Add resources to an existing Ansible project. |
| plugin | Add a plugin to an Ansible collection. |

#### Optional Arguments

Expand All @@ -318,27 +317,11 @@ $ ansible-creator add resource <resource-type> <path>

#### Positional Arguments

| Parameter | Description |
| ------------- | ------------------------------------------------------ |
| resource-type | Specifies the type of resource to add to the project. |
| devcontainer | Add devcontainer files to an existing Ansible project. |
| devfile | Add a devfile file to an existing Ansible project. |
| role | Add a role to an existing Ansible collection. |

### Add support to scaffold resource in an existing project

The `add resource devfile` command enables you to add a devfile resource type to an already existing project. Use the following command template:

```console
$ ansible-creator add resource devfile <path>
```

#### Positional Arguments

| Parameter | Description |
| --------- | ------------------------------------------------------------------------------------------------------------- |
| devfile | Add a devfile file to an existing Ansible project. |
| path | The destination directory for the devfile file. The default is the current working directory. (default: `./`) |
| Parameter | Description |
| ------------ | ------------------------------------------------------ |
| devcontainer | Add devcontainer files to an existing Ansible project. |
| devfile | Add a devfile file to an existing Ansible project. |
| role | Add a role to an existing Ansible collection. |

#### Example

Expand Down
Loading