Skip to content

Update documentation #68

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.

Sign up for GitHub

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

Merged
arhimede merged 9 commits into from
Jun 13, 2025
Merged

Update documentation #68

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
24e3df2
Update documentation
arhimede Jun 12, 2025
bce3a8a
Update setup-packages.md
arhimede Jun 12, 2025
2da344b
Update README.md
arhimede Jun 12, 2025
75a9e1d
Update README.md
arhimede Jun 12, 2025
09c7f81
Update setup-packages.md
arhimede Jun 12, 2025
1d113a2
Update setup-packages.md
arhimede Jun 12, 2025
7c3c7e4
Update README.md
arhimede Jun 12, 2025
eb38d89
Update README.md
arhimede Jun 12, 2025
22ad641
Update setup-packages.md
arhimede Jun 12, 2025
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
15 changes: 10 additions & 5 deletions docs/book/v2/setup/setup-packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
Install system packages:

```shell
# If install Ansible via pip: sudo dnf install epel-release dnf-utils python3-pip https://rpms.remirepo.net/enterprise/remi-release-10.rpm -y
sudo dnf install epel-release dnf-utils https://rpms.remirepo.net/enterprise/remi-release-10.rpm -y
```

Expand All @@ -30,12 +29,18 @@ Update/Upgrade system packages:
sudo dnf upgrade -y
```

Now, install the latest version of **Ansible**:
Now, install the latest version of **Ansible Core** and run **ansible-galaxy** in order to install collections:

```shell
sudo dnf install ansible -y
# If install Ansible from packages: sudo dnf install ansible-core ansible-collection-community-general -y
# If install Ansible via pip: pip install ansible
sudo dnf install ansible-core -y
```

```shell
ansible-galaxy collection install community.general
```

```shell
ansible-galaxy collection install community.mysql
```

Copilot AI Jun 12, 2025

Copy link

Choose a reason for hiding this comment

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

[nitpick] Consider combining multiple ansible-galaxy collection install commands into a single invocation (e.g. ansible-galaxy collection install community.general community.mysql) to streamline setup.

Suggested change
ansible-galaxy collection install community.general
```
```shell
ansible-galaxy collection install community.mysql
```
ansible-galaxy collection install community.general community.mysql

Copilot uses AI. Check for mistakes.
Comment on lines +36 to 41

Copilot AI Jun 12, 2025

Copy link

Choose a reason for hiding this comment

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

[nitpick] To streamline the steps, you can merge the DNF install and both galaxy installs into one code block. For example: ```shell
sudo dnf install ansible-core -y
ansible-galaxy collection install community.general community.mysql

```suggestion
ansible-galaxy collection install community.general community.mysql

Copilot uses AI. Check for mistakes.
Move inside your home directory (it is `/home/` followed by your AlmaLinux10 username, for example: `/home/dotkernel`):
Expand Down
15 changes: 10 additions & 5 deletions wsl/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,6 @@ passwd: all authentication tokens updated successfully.
Install system packages:

```shell
# If install Ansible via pip: sudo dnf install epel-release dnf-utils python3-pip https://rpms.remirepo.net/enterprise/remi-release-10.rpm -y
sudo dnf install epel-release dnf-utils https://rpms.remirepo.net/enterprise/remi-release-10.rpm -y
```

Expand All @@ -113,12 +112,18 @@ Update/Upgrade system packages:
sudo dnf upgrade -y
```

Now, install the latest version of **Ansible**:
Now, install the latest version of **Ansible Core** and run **ansible-galaxy** in order to install collections:

```shell
sudo dnf install ansible -y
# If install Ansible from packages: sudo dnf install ansible-core ansible-collection-community-general -y
# If install Ansible via pip: pip install ansible
sudo dnf install ansible-core -y
```

```shell
ansible-galaxy collection install community.general
```

```shell

Copilot AI Jun 12, 2025

Copy link

Choose a reason for hiding this comment

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

[nitpick] Instead of three separate code blocks, you could combine all commands into one block to reduce repetition and improve readability. E.g.: ```shell
sudo dnf install ansible-core -y
ansible-galaxy collection install community.general community.mysql

```suggestion
ansible-galaxy collection install community.general

Copilot uses AI. Check for mistakes.

@arhimede arhimede Jun 12, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@alexmerlin
For visibility, should we have multiple commands in one long line or on separate lines( like are now 3 separate shell commands) ?

@alexmerlin alexmerlin Jun 12, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Being that there are two different types of commands, one installing system packages, the other two installing app-specific packages, I would leave the first as is and group the other two together:

sudo dnf install ansible-core -y

and

ansible-galaxy collection install community.general community.mysql

Copilot's suggestion (concatenating the two lines together) seems to be the easy but less readable solution.

ansible-galaxy collection install community.mysql
```

Copilot AI Jun 12, 2025

Copy link

Choose a reason for hiding this comment

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

[nitpick] Consider combining multiple ansible-galaxy collection install commands into a single invocation (e.g. ansible-galaxy collection install community.general community.mysql) to streamline setup.

Suggested change
ansible-galaxy collection install community.general
```
```shell
ansible-galaxy collection install community.mysql
```
ansible-galaxy collection install community.general community.mysql

Copilot uses AI. Check for mistakes.
Move inside your home directory (it is `/home/` followed by your AlmaLinux10 username, for example: `/home/dotkernel`):
Expand Down