Skip to content

Simplify the bot contributing guide#939

Merged
shtlrs merged 2 commits into
mainfrom
Simplify-the-bot-contributing-guide
Apr 22, 2023
Merged

Simplify the bot contributing guide#939
shtlrs merged 2 commits into
mainfrom
Simplify-the-bot-contributing-guide

Conversation

@ChrisLovering
Copy link
Copy Markdown
Member

This splits out the manual configuration setup from the main guide, along with updating the guide to be far simpler, and less words to read for our contributors to get setup.

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 14, 2023

Deploy Preview for pydis-static ready!

Name Link
🔨 Latest commit 7d944f7
🔍 Latest deploy log https://app.netlify.com/sites/pydis-static/deploys/6443daab5c52a40008745d88
😎 Deploy Preview https://deploy-preview-939--pydis-static.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@coveralls
Copy link
Copy Markdown

coveralls commented Apr 14, 2023

Coverage Status

Coverage: 100.0%. Remained the same when pulling 7d944f7 on Simplify-the-bot-contributing-guide into aa303ed on main.

@ChrisLovering ChrisLovering marked this pull request as draft April 14, 2023 20:55
@ChrisLovering ChrisLovering reopened this Apr 14, 2023
@ChrisLovering ChrisLovering force-pushed the Simplify-the-bot-contributing-guide branch 5 times, most recently from 3fa33da to adb81c4 Compare April 14, 2023 22:20
@jchristgit
Copy link
Copy Markdown
Contributor

Feel free to assign me when this is ready for review.

@ChrisLovering ChrisLovering force-pushed the Simplify-the-bot-contributing-guide branch from adb81c4 to 7064ab7 Compare April 17, 2023 11:10
@ChrisLovering ChrisLovering marked this pull request as ready for review April 17, 2023 11:10
@ChrisLovering ChrisLovering force-pushed the Simplify-the-bot-contributing-guide branch from 7064ab7 to 5c0e04f Compare April 17, 2023 11:11
Copy link
Copy Markdown
Contributor

@shtlrs shtlrs left a comment

Choose a reason for hiding this comment

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

Looking great, 2 small comments.


The site, however, is a mandatory service for the bot.
Refer to the [previous section](#with-the-bot-running-locally) and the [site contributing guide](../site) to learn how to start it on the host, in which case you will need to change `urls.site` in `.env.server` to wherever the site is being hosted.
If you want to read about how to make debugging with an IDE a easier, or for additional running methods, check out our [extended configuration guide](../bot-extended-configuration-options).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think this should be a note, so that it jumps to the eye easily

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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


Once the previous steps are done, all that is left is to:
1. Create a new channel
2. Choose the `Forum` type
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This currently renders like this

image

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@ChrisLovering ChrisLovering force-pushed the Simplify-the-bot-contributing-guide branch from 5c0e04f to a5b7c50 Compare April 22, 2023 12:47
Also update the guide to be far simpler, and less words to read for our contributors to get setup.
@ChrisLovering ChrisLovering force-pushed the Simplify-the-bot-contributing-guide branch from a5b7c50 to facb030 Compare April 22, 2023 12:47
Copy link
Copy Markdown
Contributor

@shtlrs shtlrs left a comment

Choose a reason for hiding this comment

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

🚀

@shtlrs shtlrs enabled auto-merge April 22, 2023 13:01
@shtlrs shtlrs merged commit 0031b04 into main Apr 22, 2023
@shtlrs shtlrs deleted the Simplify-the-bot-contributing-guide branch April 22, 2023 13:03
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.

4 participants