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

Add a Discord link to the docs #870

Merged
merged 1 commit into from Apr 2, 2022
Merged

Add a Discord link to the docs #870

merged 1 commit into from Apr 2, 2022

Conversation

ericwb
Copy link
Member

@ericwb ericwb commented Apr 1, 2022

This change adds a Discord link to our docs in the contributing
section so users know where they can reach out for questions
and discussion.

Closes #775

Signed-off-by: Eric Brown browne@vmware.com

Copy link
Member

@lukehinds lukehinds left a comment

Choose a reason for hiding this comment

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

I tried the discord link, but it does not land me in any server or channels? Is it a temporary link perhaps?

@sigmavirus24
Copy link
Member

You need to generate a non-expiring invite link to a specific channel.

This change adds a Discord link to our docs in the contributing
section so users know where they can reach out for questions
and discussion.

Closes #775

Signed-off-by: Eric Brown <browne@vmware.com>
@ericwb
Copy link
Member Author

ericwb commented Apr 2, 2022

You need to generate a non-expiring invite link to a specific channel.

Thank you, I believe the new link should work better.

Comment on lines 28 to +30
.. _`Source code`: https://github.com/PyCQA/bandit
.. _`Issue tracker`: https://github.com/PyCQA/bandit/issues
.. _`Discord`: https://discord.gg/qYxpadCgkx
Copy link
Member

Choose a reason for hiding this comment

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

Believe it or not, these don't need the backticks around them, they can be more simply:

.. _Source code: ...
.. _Issue tracker: ...
.. _Discord: ...

but that's not important

Copy link
Member Author

Choose a reason for hiding this comment

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

I notice in my IDE at least, it will de-highlight the line as if it's a comment or hidden text when using the back ticks. That might help to inform people these lines are not intended to be visible, just for link mapping.

Copy link
Member

Choose a reason for hiding this comment

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

I think that's a bug with your IDE not supporting a superior documentation format then ;)

@ericwb ericwb merged commit 83df96c into PyCQA:main Apr 2, 2022
@ericwb ericwb deleted the discord branch April 2, 2022 15:42
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.

Add a link or badge to Discord for discussions
3 participants