search

ansible / ansible-builder

An Ansible execution environment builder
Other
287 stars 93 forks source link

Suggest adt installation #662

Closed audgirka closed 4 months ago

audgirka commented 5 months ago

Suggest ADT installation

Jira-https://issues.redhat.com/browse/AAP-19818

ssbarnea commented 5 months ago

@audgirka This is not rendering correct, see https://ansible--662.org.readthedocs.build/projects/builder/en/662/installation/ correct the RST syntax.

audgirka commented 5 months ago

Hi, thank you for your interest in ansible-builder.

We've looked over this proposed change, however we would like to see some of the wording changed.

Instead of recommending this as the preferred way to install ansible-builder, we believe it should be presented as just an additional option. The reasoning for the decision making as to why a user would want to use this installation option, that includes many more tools than just builder should be explained, and also indicated what audience may be best served by doing so. However, this should probably be a link to the ansible-dev-tools repo or documentation, where that information can be explained in more detail.

Will look at the wording changes for the "recommended" approach. We've tried to keep the same message across the other projects included as part of the adt package.

Line 20 onwards explains briefly the use case for ansible-dev-tools https://github.com/ansible/ansible-builder/pull/662/files#diff-d9b149498982c0663c3b7170398773361ed5678f1a627e9c2fd8d2c955c563dbR20

We do have a link in place for adt docs which can help explain user the purpose of using this package and tools included as part of it.

@ssbarnea @cidrblock ^^

cidrblock commented 5 months ago

Let's update the wording per @sivel request so we can get this in. If it needs to be revised further in the futre we can do that at a later date.

ssbarnea commented 5 months ago

@sivel Please take another look, that should be the text we agreed on ("alternative"), renders ok, it has the note and no extra heading.

You might want to retrigger the failed job, which fails for unrelated reason. I cannot do it myself.