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 README, by adding more references to installation options #2209

Merged
merged 3 commits into from
Jan 24, 2024

Conversation

EMaksy
Copy link
Member

@EMaksy EMaksy commented Jan 22, 2024

Description

As in the description, adding a reference to the manual installation guide and the Ansible repository in the installation section.

@EMaksy EMaksy added the documentation Improvements or additions to documentation label Jan 22, 2024
@EMaksy EMaksy self-assigned this Jan 22, 2024
@EMaksy EMaksy marked this pull request as ready for review January 23, 2024 08:42
README.md Outdated

For manual instructions on installing Trento, please refer to our [Installation of Trento](https://github.com/trento-project/docs/blob/main/guides/manual-installation.md) guide.

## Installing Trento using Ansible (WIP)
Copy link
Contributor

Choose a reason for hiding this comment

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

I would remove the WIP reference.
The ansible playbook is "finished" so to say.

README.md Outdated
@@ -71,6 +71,14 @@ See [related documentation](./guides/alerting/alerting.md) for more information.

**Trento** can be installed in various ways, depending on your needs and the requirements of its different components. Please refer to the specific [Agent](https://github.com/trento-project/agent) documentation for more information.

## Installing Trento manually
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't like the manually term.
What does it mean?
I would go simply with Installing Trento.
The same for the body of the chapter. `To install Trento, please refer to the

README.md Outdated
@@ -71,6 +71,14 @@ See [related documentation](./guides/alerting/alerting.md) for more information.

**Trento** can be installed in various ways, depending on your needs and the requirements of its different components. Please refer to the specific [Agent](https://github.com/trento-project/agent) documentation for more information.

## Installing Trento manually

For manual instructions on installing Trento, please refer to our [Installation of Trento](https://github.com/trento-project/docs/blob/main/guides/manual-installation.md) guide.
Copy link
Contributor

Choose a reason for hiding this comment

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

refer to our, i would remove our. please refer to the ... guide

@EMaksy
Copy link
Member Author

EMaksy commented Jan 23, 2024

Thanks for the feedback, I adjusted and aligned all the installation options 👍

@EMaksy EMaksy force-pushed the update_readme_installation branch 2 times, most recently from e847969 to 4ae30a2 Compare January 24, 2024 13:01
@EMaksy EMaksy requested a review from arbulu89 January 24, 2024 13:22
Copy link
Contributor

@rtorrero rtorrero left a comment

Choose a reason for hiding this comment

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

LGTM

@EMaksy EMaksy merged commit 9a52676 into main Jan 24, 2024
24 checks passed
@EMaksy EMaksy deleted the update_readme_installation branch January 24, 2024 13:30
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
Development

Successfully merging this pull request may close these issues.

None yet

4 participants