Skip to content

Conversation

sspencerwire
Copy link
Contributor

@sspencerwire sspencerwire commented Jun 9, 2023

  • change Observations to Functionality

Author checklist (Completed by original Author)

  • Good fit for the Rocky Linux project? Title and Author Metatags inserted ?
  • If applicable, steps and instructions have been tested to work
  • Initial self-review to fix basic typos and grammar completed

Rocky Documentation checklist (Completed by Rocky team)

  • 1st Pass (Document is good fit for project and author checklist completed)
  • 2nd Pass (Technical Review - check for technical correctness)
  • 3rd Pass (Detailed Editorial Review and Peer Review)
  • Final approval (Final Review)

* change Observations to Functionality
@sspencerwire
Copy link
Contributor Author

Holding... may need to add to this as Anna works.

@github-actions
Copy link

github-actions bot commented Jun 9, 2023

Test results for 6442a8f:

Number of broken URLs: 0

URL,RESULT,FILENAME

@@ -51,7 +51,7 @@ ansible-galaxy role [import|init|install|login|remove|...]
ansible-galaxy collection [import|init|install|login|remove|...]
```

| Sub-commands | Observations |
| Sub-commands | Functionality |
|--------------|------------------------------------------------------------|
| `init` | generate a skeleton of a new collection. |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| `init` | generate a skeleton of a new collection. |
| `init` | generates a skeleton of a new collection. |

Copy link
Contributor

@SergeCroise SergeCroise Jun 9, 2023

Choose a reason for hiding this comment

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

for a new or of a new collection ?

@@ -36,7 +36,7 @@ The `ansible-galaxy` command manages roles and collections using [galaxy.ansible
ansible-galaxy role [import|init|install|login|remove|...]
```

| Sub-commands | Observations |
| Sub-commands | Functionality |
|--------------|-----------------------------------------------------------|
| `install` | installs a role. |
| `remove` | remove one or more roles. |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| `remove` | remove one or more roles. |
| `remove` | removes one or more roles. |

@sspencerwire
Copy link
Contributor Author

Hey @SergeCroise Anna and I just discussed this. Honestly, I think instead of changing the the lines you have changed, we need to change "installs a role" to "install a role" and leave the functionality column all using a singular rather than plural. The plural is hinted at where needed. (in other words) "remove one or more roles" It's either that, or we change them all like:

Sub-commands Functionality
install installs a role.
remove removes one or more roles.
list displays the name and the version of installed roles.
info displays information about a role.
init generates a skeleton of a new role.
import imports a role from the galaxy web site. Requires a login.

Which is best? I'm not really sure I know.

@sspencerwire
Copy link
Contributor Author

What I'm going to do is merge this as is. I've got a problem I need to resolve associated with this branch anyway. Then we can take a look at fixing these lines so that they are consistent.

@sspencerwire sspencerwire merged commit c69af66 into rocky-linux:main Jun 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants