Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Update upstream doc with add subcommand details in installing.md #317

Merged
merged 4 commits into from
Nov 11, 2024

Conversation

tanwigeetika1618
Copy link
Contributor

@tanwigeetika1618 tanwigeetika1618 commented Nov 7, 2024

Related Issue : #305, #308

Description

This PR adds detailed documentation for the add subcommand in the installing.md file, covering the following:

  • Positional Arguments: Added descriptions for content-type (options: resource, plugin) and resource-type (options: devfile, devcontainer, role).
  • Usage Examples: Provided command examples for ansible-creator add resource devfile and similar commands.

This update mentions the add subcommand documentation for better usability and clarity.

@tanwigeetika1618 tanwigeetika1618 added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 7, 2024
@tanwigeetika1618 tanwigeetika1618 self-assigned this Nov 7, 2024
@tanwigeetika1618 tanwigeetika1618 requested a review from a team as a code owner November 7, 2024 10:31
Copy link
Contributor

@shatakshiiii shatakshiiii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please replace "create" with "add" inside Installation and Usage section of installing.md

It should say something like: ansible-creator provides two main functionalities: init and add. The init command allows you to initialize an ansible project, while add command allows you to add resources to an existing ansible project.

@tanwigeetika1618
Copy link
Contributor Author

Sorted @shatakshiiii

Copy link
Contributor

@shatakshiiii shatakshiiii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect!

@shatakshiiii shatakshiiii merged commit b0c1d58 into ansible:main Nov 11, 2024
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants