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

Collection links: allow to mention forums #288

Merged
merged 1 commit into from
Jul 5, 2024

Conversation

felixfontein
Copy link
Collaborator

Right now we only mention Matrix, IRC, and mailing lists...

@felixfontein felixfontein requested a review from oraNod June 30, 2024 19:03
@felixfontein
Copy link
Collaborator Author

(A next step would be updating the default list of communication channels for ansible-core - the Forum is added in the change in src/antsibull_docs/collection_links.py, but the others are still there. It might make sense to wait until https://forum.ansible.com/t/6812/7 is decided though. WDYT?)

@oraNod
Copy link
Contributor

oraNod commented Jul 5, 2024

(A next step would be updating the default list of communication channels for ansible-core - the Forum is added in the change in src/antsibull_docs/collection_links.py, but the others are still there. It might make sense to wait until https://forum.ansible.com/t/6812/7 is decided though. WDYT?)

I feel like a good next step is to make additional changes that align with the recent communication guide overhaul from @Andersson007 Not quite sure how to approach it with antsibull-docs but this seems like a good first step in making sure the forum is the default in collection links. Also FYI @gundalow

Copy link
Contributor

@oraNod oraNod left a comment

Choose a reason for hiding this comment

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

🚀 Thank you @felixfontein

"forums": [
{
"topic": "Ansible Forum",
"url": "https://forum.ansible.com/c/help/6/none",
Copy link

Choose a reason for hiding this comment

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

Is this the default link that will show if forums isn't explicitly set?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No, this is only for the Communications sections of ansible.builtin (https://docs.ansible.com/ansible/devel/collections/ansible/builtin/#communication). Right now there are no default entries.

@felixfontein felixfontein merged commit 421ed2f into ansible-community:main Jul 5, 2024
12 checks passed
@felixfontein felixfontein deleted the communication branch July 5, 2024 20:02
@felixfontein
Copy link
Collaborator Author

Thanks for reviewing this! I'll work on a antsibull-docs release next, so this goes out and collections can start referencing the Forum (and potentially drop other communication channels in favor of it). If we want to add defaults (in certain cases), or adjust the list of communication channels for ansible.builtin / ansible-core, we can do that in follow-up releases.

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.

3 participants