From e981db620f9f7ee05d4f42ad8b4ebb4fcff57f14 Mon Sep 17 00:00:00 2001 From: Hedy Li Date: Thu, 4 Nov 2021 13:04:46 +0800 Subject: Improve Gitpod section in Sir Lancebot contributing guide - Add newlines so it's not a big unfriendly paragraph - Fix gitpod workspace link - Clarification on terminal commands - Clarification on test server and bot - Add links for that ^ and for environment variables --- .../resources/guides/pydis-guides/contributing/sir-lancebot.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'pydis_site/apps/content/resources/guides') 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..53674063 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/#/python-discord/sir-lancebot](https://gitpod.io/#/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. -- cgit v1.2.3 From 8faaddceb37cd71d9c11ec827a71b3b67521fbe0 Mon Sep 17 00:00:00 2001 From: Hedy Li Date: Thu, 4 Nov 2021 13:18:38 +0800 Subject: Fix gitpod link in Sir Lancebot contributing guide --- .../content/resources/guides/pydis-guides/contributing/sir-lancebot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'pydis_site/apps/content/resources/guides') 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 53674063..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 @@ -21,7 +21,7 @@ Sir Lancebot can be edited and tested on Gitpod. Gitpod will automatically insta 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/#/python-discord/sir-lancebot](https://gitpod.io/#/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: +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 -- cgit v1.2.3 From 512b1659f5bb5d2dfb8029f42d7b8c7e3436ede1 Mon Sep 17 00:00:00 2001 From: Krish Date: Fri, 7 Jan 2022 12:19:29 +0530 Subject: Resource Suggestion: #639 solved --- .../pydis-guides/contributing/setting-test-server-and-bot-account.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) (limited to 'pydis_site/apps/content/resources/guides') 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 `` 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=&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 -- cgit v1.2.3 From 7242fb9492f07c724d4b354ca34d07e2948e4a1f Mon Sep 17 00:00:00 2001 From: Chris Lovering Date: Wed, 26 Jan 2022 23:15:05 +0000 Subject: Fix pynews config in example file The python news cog relies on the python_news section of the config being filled in via a named alias. Since we were using the DEV_ prefix, this meant it was not being populated, leading to the cog throwing an error on boot. --- .../apps/content/resources/guides/pydis-guides/contributing/bot.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'pydis_site/apps/content/resources/guides') 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..d31c6dbf 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 @@ -350,7 +350,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 +426,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 >> ##### -- cgit v1.2.3 From 8b50bef2f43d660679702c8043390b2e3ec62f03 Mon Sep 17 00:00:00 2001 From: Chris Lovering Date: Wed, 26 Jan 2022 23:15:39 +0000 Subject: Add new incidents webhook to exmaple config.yml This was recently added to the bot. --- .../apps/content/resources/guides/pydis-guides/contributing/bot.md | 1 + 1 file changed, 1 insertion(+) (limited to 'pydis_site/apps/content/resources/guides') 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 d31c6dbf..ed9e3db3 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 @@ -196,6 +196,7 @@ guild: big_brother: � dev_log: � duck_pond: � + incidents: � incidents_archive: � python_news: &PYNEWS_WEBHOOK � talent_pool: � -- cgit v1.2.3 From e144d4d1b4d1ef2ec2f9f8b771b3606b581ace34 Mon Sep 17 00:00:00 2001 From: Leon Sandøy Date: Tue, 1 Feb 2022 22:43:15 +0100 Subject: Complete refactor of collapsibles. This is now a completely self-contained feature, which can be used in the same way on every page. I've moved all the collapsible-related logics out of the resources.js file and into collapsibles.js, and added documentation and other quality-of-life features that will apply to other pages, as well. Changes: - The icon will now always change when the collapsible opens or closes. - By adding the "collapsed" class, you can tell the collapsible to be collapsed by default. --- .../guides/pydis-guides/contributing/bot.md | 20 ++++---- pydis_site/static/css/collapsibles.css | 4 -- pydis_site/static/js/collapsibles.js | 60 ++++++++++++++++++++-- pydis_site/static/js/resources/resources.js | 15 +----- 4 files changed, 67 insertions(+), 32 deletions(-) (limited to 'pydis_site/apps/content/resources/guides') 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 ed9e3db3..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 -
+