aboutsummaryrefslogtreecommitdiffstats
path: root/pydis_site/apps/content/resources/guides
diff options
context:
space:
mode:
authorGravatar minalike <[email protected]>2022-02-20 21:20:29 -0500
committerGravatar minalike <[email protected]>2022-02-20 21:20:29 -0500
commit0e1257d6eca90fa45ba7c11454a0fba7e3fc74f7 (patch)
treee3ad78be879f615b2621c0afba9db813e70fafff /pydis_site/apps/content/resources/guides
parentAdd table of content and final edits (diff)
parentMerge pull request #668 from python-discord/update/name-profile-policy (diff)
Merge branch 'main' into content/update-help-channel-timing
Diffstat (limited to 'pydis_site/apps/content/resources/guides')
-rw-r--r--pydis_site/apps/content/resources/guides/pydis-guides/contributing.md6
-rw-r--r--pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md27
-rw-r--r--pydis_site/apps/content/resources/guides/pydis-guides/contributing/setting-test-server-and-bot-account.md4
-rw-r--r--pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md9
4 files changed, 27 insertions, 19 deletions
diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing.md
index d367dbc7..4013962c 100644
--- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing.md
+++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing.md
@@ -27,7 +27,7 @@ Our projects on Python Discord are open source and [available on Github](https:/
</div>
</div>
<div class="card-footer">
- <a href="https://github.com/python-discord/sir-lancebot/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" class="card-footer-item"><i class="far fa-exclamation-circle"></i>&ensp;Issues</a>
+ <a href="https://github.com/python-discord/sir-lancebot/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" class="card-footer-item"><i class="fas fa-exclamation-circle"></i>&ensp;Issues</a>
<a href="https://github.com/python-discord/sir-lancebot/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc" class="card-footer-item"><i class="fas fa-code-merge"></i>&ensp;PRs</a>
</div>
<div class="card-footer">
@@ -54,7 +54,7 @@ Our projects on Python Discord are open source and [available on Github](https:/
</div>
</div>
<div class="card-footer">
- <a href="https://github.com/python-discord/bot/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" class="card-footer-item"><i class="far fa-exclamation-circle"></i>&ensp;Issues</a>
+ <a href="https://github.com/python-discord/bot/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" class="card-footer-item"><i class="fas fa-exclamation-circle"></i>&ensp;Issues</a>
<a href="https://github.com/python-discord/bot/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc" class="card-footer-item"><i class="fas fa-code-merge"></i>&ensp;PRs</a>
</div>
<div class="card-footer">
@@ -81,7 +81,7 @@ Our projects on Python Discord are open source and [available on Github](https:/
</div>
</div>
<div class="card-footer">
- <a href="https://github.com/python-discord/site/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" class="card-footer-item"><i class="far fa-exclamation-circle"></i>&ensp;Issues</a>
+ <a href="https://github.com/python-discord/site/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" class="card-footer-item"><i class="fas fa-exclamation-circle"></i>&ensp;Issues</a>
<a href="https://github.com/python-discord/site/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc" class="card-footer-item"><i class="fas fa-code-merge"></i>&ensp;PRs</a>
</div>
<div class="card-footer">
diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md
index b9589def..2aa10aa3 100644
--- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md
+++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md
@@ -14,10 +14,10 @@ First things first, to run the bot's code and make changes to it, you need a loc
<button type="button" class="card-header collapsible">
<span class="card-header-title subtitle is-6 my-2 ml-2">Getting started with Git and GitHub</span>
<span class="card-header-icon">
- <i class="fas fa-angle-down title is-5" aria-hidden="true"></i>
+ <i class="fas fa-fw fa-angle-down title is-5" aria-hidden="true"></i>
</span>
</button>
- <div class="collapsible-content">
+ <div class="collapsible-content collapsed">
<div class="card-content">
<p>If you don't have Git on your computer already, <a href="https://git-scm.com/downloads">install it</a>. You can additionally install a Git GUI such as <a href="https://www.gitkraken.com/download">GitKraken</a>, or the <a href="https://cli.github.com/manual/installation">GitHub CLI</a>.</p>
<p>To learn more about Git, you can look into <a href="../working-with-git">our guides</a>, as well as <a href="https://education.github.com/git-cheat-sheet-education.pdf">this cheatsheet</a>, <a href="https://learngitbranching.js.org">Learn Git Branching</a>, and otherwise any guide you can find on the internet. Once you got the basic idea though, the best way to learn Git is to use it.</p>
@@ -78,10 +78,10 @@ See [here](../obtaining-discord-ids) for help with obtaining Discord IDs.
<button type="button" class="card-header collapsible">
<span class="card-header-title subtitle is-6 my-2 ml-2">Optional config.yml</span>
<span class="card-header-icon">
- <i class="fas fa-angle-down title is-5" aria-hidden="true"></i>
+ <i class="fas fa-fw fa-angle-down title is-5" aria-hidden="true"></i>
</span>
</button>
- <div class="collapsible-content">
+ <div class="collapsible-content collapsed">
<div class="card-content">
<p>If you used the provided server template, and you're not sure which channels belong where in the config file, you can use the config below. Pay attention to the comments with several <code>#</code> symbols, and replace the <code>�</code> characters with the right IDs.</p>
<pre>
@@ -196,6 +196,7 @@ guild:
big_brother: �
dev_log: �
duck_pond: �
+ incidents: �
incidents_archive: �
python_news: &PYNEWS_WEBHOOK �
talent_pool: �
@@ -350,7 +351,7 @@ style:
trashcan: "<:trashcan:�>"
-##### << Optional - If you don't care about the filtering and help channel cogs, ignore the rest of this file >> #####
+##### << Optional - If you don't care about the filtering, help channel and py-news cogs, ignore the rest of this file >> #####
filter:
# What do we filter?
filter_domains: true
@@ -426,6 +427,10 @@ help_channels:
notify_roles:
- *HELPERS_ROLE
+python_news:
+ channel: *DEV_PY_NEWS
+ webhook: *PYNEWS_WEBHOOK
+
##### << Add any additional sections you need to override from config-default.yml >> #####
</code>
</pre>
@@ -453,10 +458,10 @@ We understand this is tedious and are working on a better solution for setting u
<button type="button" class="card-header collapsible">
<span class="card-header-title subtitle is-6 my-2 ml-2">Why do you need a separate config file?</span>
<span class="card-header-icon">
- <i class="fas fa-angle-down title is-5" aria-hidden="true"></i>
+ <i class="fas fa-fw fa-angle-down title is-5" aria-hidden="true"></i>
</span>
</button>
- <div class="collapsible-content">
+ <div class="collapsible-content collapsed">
<div class="card-content">
While it's technically possible to edit <code>config-default.yml</code> to match your server, it is heavily discouraged.
This file's purpose is to provide the configurations the Python bot needs to run in the Python server in production, and should remain as such.
@@ -482,10 +487,10 @@ You are now almost ready to run the Python bot. The simplest way to do so is wit
<button type="button" class="card-header collapsible">
<span class="card-header-title subtitle is-6 my-2 ml-2">Getting started with Docker</span>
<span class="card-header-icon">
- <i class="fas fa-angle-down title is-5" aria-hidden="true"></i>
+ <i class="fas fa-fw fa-angle-down title is-5" aria-hidden="true"></i>
</span>
</button>
- <div class="collapsible-content">
+ <div class="collapsible-content collapsed">
<div class="card-content">
The requirements for Docker are:
<ul>
@@ -536,10 +541,10 @@ With at least the site running in Docker already (see the previous section on ho
<button type="button" class="card-header collapsible">
<span class="card-header-title subtitle is-6 my-2 ml-2">Ways to run code</span>
<span class="card-header-icon">
- <i class="fas fa-angle-down title is-5" aria-hidden="true"></i>
+ <i class="fas fa-fw fa-angle-down title is-5" aria-hidden="true"></i>
</span>
</button>
- <div class="collapsible-content">
+ <div class="collapsible-content collapsed">
<div class="card-content">
Notice that the bot is started as a module. There are several ways to do so:
<ul>
diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/setting-test-server-and-bot-account.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/setting-test-server-and-bot-account.md
index c14fe50d..43d1c8f5 100644
--- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/setting-test-server-and-bot-account.md
+++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/setting-test-server-and-bot-account.md
@@ -18,13 +18,11 @@ icon: fab fa-discord
4. Change your bot's `Public Bot` setting off so only you can invite it, save, and then get your **Bot Token** with the `Copy` button.
> **Note:** **DO NOT** post your bot token anywhere public, or it can and will be compromised.
5. Save your **Bot Token** somewhere safe to use in the project settings later.
-6. In the `General Information` tab, grab the **Client ID**.
+6. In the `OAuth2` tab, grab the **Client ID**.
7. Replace `<CLIENT_ID_HERE>` in the following URL and visit it in the browser to invite your bot to your new test server.
```plaintext
https://discordapp.com/api/oauth2/authorize?client_id=<CLIENT_ID_HERE>&permissions=8&scope=bot
```
-Optionally, you can generate your own invite url in the `OAuth` tab, after selecting `bot` as the scope.
-
---
## Obtain the IDs
diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md
index a0d3d463..e3cd8f0c 100644
--- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md
+++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md
@@ -18,12 +18,17 @@ toc: 1
## Using Gitpod
Sir Lancebot can be edited and tested on Gitpod. Gitpod will automatically install the correct dependencies and Python version, so you can get straight to coding.
-To do this, you will need a Gitpod account, which you can get [here](https://www.gitpod.io/#get-started), and a fork of Sir Lancebot. This guide covers forking the repository [here](#fork-the-project). Afterwards, either click the button on Sir Lancebot's README or go to [https://gitpod.io/#/python-discord/sir-lancebot]() and run the following commands in the terminal:
+
+To do this, you will need a Gitpod account, which you can get [here](https://www.gitpod.io/#get-started), and a fork of Sir Lancebot. This guide covers forking the repository [here](#fork-the-project).
+
+Afterwards, click on [this link](https://gitpod.io/#/github.com/python-discord/sir-lancebot) to spin up a new workspace for Sir Lancebot. Then run the following commands in the terminal after the existing tasks have finished running:
```sh
git remote rename origin upstream
git add remote origin https://github.com/{your_username}/sir-lancebot
```
-Make sure you replace `{your_username}` with your Github username. These commands will set Python Discord as the parent repository, and your branch as the fork. This means you can easily grab new changes from the parent repository. Once you set your environment variables to test your code, you are ready to begin contributing to Sir Lancebot.
+Make sure you replace `{your_username}` with your Github username. These commands will set the Sir Lancebot repository as the secondary remote, and your fork as the primary remote. This means you can easily grab new changes from the main Sir Lancebot repository.
+
+Once you've set up [a test server and bot account](#test-server-and-bot-account) and your [environment variables](#environment-variables), you are ready to begin contributing to Sir Lancebot!
## Using Docker
Sir Lancebot can be started using Docker. Using Docker is generally recommended (but not strictly required) because it abstracts away some additional set up work.