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

Reference the in-house Ansible tutorial, from the Ansible-Galaxy tutorial #4956

Merged
merged 15 commits into from
May 29, 2024

Conversation

vladvisan
Copy link
Contributor

Not paramount, but why not mention it since the effort was put into writing it?

@vladvisan vladvisan requested a review from a team as a code owner May 23, 2024 15:43
@github-actions github-actions bot added the admin label May 23, 2024
@vladvisan
Copy link
Contributor Author

Maybe also do the mirror version: refer to this tutorial from the Ansible tutorial https://github.com/galaxyproject/training-material/blob/main/topics/admin/tutorials/ansible/tutorial.md?plain=1

I see there is an "Ansible-Galaxy" section there, but no link to this tutorial.

I don't want to spam pull requests, so let me know if this is a good idea.

Copy link
Member

@hexylena hexylena left a comment

Choose a reason for hiding this comment

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

@vladvisan sure it's fine to do links both directions (though not every ansible tutorial follower will subsequent follow the galaxy one.) Maybe this makes it more clear for learners which is a nice improvement ! Please add the link from ansible to ansible-galaxy to this PR as well.

That said, we actually currently do make these links (scroll up in the metadata)

image

but I can agree it's easy to miss. If you have suggestions on improving the display of requirements I'd be happy to hear your ideas :)

topics/admin/tutorials/ansible-galaxy/tutorial.md Outdated Show resolved Hide resolved
@vladvisan
Copy link
Contributor Author

vladvisan commented May 27, 2024

Thank you for the feedback.
I'm following the tutorial and will update the PR at the same time.
I'll post a new comment when it's ready for a new review.

visanv added 2 commits May 27, 2024 18:16
…e between Ansible Galaxy and the Ansible Galaxy installation process and the Galaxy roles on the Ansible Galaxy. Since, as a beginner, the wordings really confused me at first.

Also modified a "Galaxyproject's" to "Galaxy Project's" for consistency's sake.
… line, then the subsequent text does not get a newline. As a patch, reducing the length make the 'Create the roles directory' be on a new line
@hexylena
Copy link
Member

hexylena commented May 28, 2024

I'm following the tutorial and will update the PR at the same time.

when you're done, please add yourself to the testing section of the tutorial header (under contributions) :)

visanv added 4 commits May 28, 2024 19:38
… line, then the subsequent text does not get a newline. As a patch, reducing the length makes the 'Create the roles directory' be on a new line
… pure Ansible one which doesn't install Galaxy. Updated them
visanv added 3 commits May 28, 2024 19:57
…the most recent version (there was a naming convention change, 9==2.17)) 2) there was a redirect occuring, the link had actually changed locations, so might as well put the correct link
@vladvisan
Copy link
Contributor Author

vladvisan commented May 28, 2024

Thank you for the "testing" suggestion.

I have not followed the "install Galaxy with Ansible" tutorial yet, but this should be enough progress for now.

  1. The "contributors.yaml/organisation.yaml" additions are redundant with my other PR (WiP / Draft - Galaxy SSA Poll Results Slides #4972) , but will not cause any merge conflict (same change in same location in the files)
  2. Feedback on the display of requirements:
    • Thanks, I had not seen it
    • "Hands on: Hands on: " seems like a mistake? Should be 0 "Hands on" since there is a "Hands on" link to the right?
    • I feel like "Galaxy server administration" should not be a hyperlink
    • I feel like "Ansible" should be in bold
    • This seems to be in the website's engine, as opposed to something I can change in the tutorial.md directly
  3. There are alot of links that point to version 2.9 of the Ansible doc website, in both tutorials
    • I understand not pointing to /latest/, so that the link is more stable since /latest/ can change the subpath to the right, in the future
    • But I think it would be good to update it to /9/ (Ansible changed version naming conventions, 9==2.17) since 2.9 is 5 years old
    • I tried to it, but it was too time-consuming so I did not have the time
      • It is time-consuming because there are tens of links and about half are invalid if you just replace /2.9/ with /9/
      • I spent some time searching for the corresponding links in the new documentation, but I'm not good enough at Ansible for the moment to do that
  4. I think there is a bug in the "details" tag, when the text is longer than one line, causing bugs such as the following:
    • image
    • you can see that the "4. Create the roles directory (...)" is to the right instead of on a new line
    • this is in the "live" version
    • As a patch (not the cleanest solution but it works), I changed the content of the detail-title, to make it smaller than one line, and so the bug does not happen, and there is a new line

And thanks for writing the tutorial, it helped me understand the basics of Ansible!

@vladvisan
Copy link
Contributor Author

vladvisan commented May 28, 2024

I forgot to mention why I added a lot of "repository (unrelated to the Galaxy Project)", because as a novice, this was very confusing me
Especially since I started by looking at https://github.com/galaxyproject/ansible-galaxy , it took me a while to realise "ansible-galaxy" didn't refer to that, but actually to the CLI tool that comes packaged with Ansible.

@hexylena
Copy link
Member

hexylena commented May 29, 2024

"Hands on: Hands on: " seems like a mistake? Should be 0 "Hands on" since there is a "Hands on" link to the right?
I feel like "Galaxy server administration" should not be a hyperlink
I feel like "Ansible" should be in bold
This seems to be in the website's engine, as opposed to something I can change in the tutorial.md directly

yes these seem like reasonable suggestions (the duplicate hands-on is a known issue I hadn't fixed yet.)

We'll take care of them #4976

But I think it would be good to update it to /9/ (Ansible changed version naming conventions, 9==2.17) since 2.9 is 5 years old

Yes, it would be good. We'll see about doing that during the next GAT, whenever that is. Outside of the GAT events the materials do not get updated very often because the update process is quite laborious and we want to be sure that all tutorials in the GAT series work together correctly.

You intended this to be a small change, I think that's good :) Please don't feel the need to take on big tasks like that, that can be a task for the team.

I'll file it as a separate issue and add to our GAT roadmap: #4974

I think there is a bug in the "details" tag, when the text is longer than one line, causing bugs such as the following:

I will move it into a separate bug, I've suggested reverting that change because it would cause other issues. We will investigate it more thoroughly #4975

And thanks for writing the tutorial, it helped me understand the basics of Ansible!

I'm glad it was helpful! I don't think it is a great tutorial, it's not my best work, I think it could be improved a lot but I have not had time for it lately. but good that it is still useful in this state.

@hexylena
Copy link
Member

Thanks! And welcome to the GTN @vladvisan !

@hexylena hexylena merged commit 342364a into galaxyproject:main May 29, 2024
4 checks passed
@vladvisan
Copy link
Contributor Author

@hexylena Thank you for the feedback and for creating the related issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants