Merge pull request #18 from Stef-00012/main

add discord verification, how to delete and how to edit a domain
is-a-dev · Mar 28, 2024 · be25dca · be25dca
2 parents 10e69fa + 4d12587
commit be25dca
Show file tree

Hide file tree

Showing 25 changed files with 118 additions and 15 deletions.
diff --git a/src/docs/cloudflare_pages/index.md b/src/docs/cloudflare_pages/index.md
@@ -13,12 +13,11 @@ Create a JSON file inside `domains` directory (`domains/<subdomain>.json`) with
 ```json 
 {
     "owner": {
-        "username": "<github-username>",
-        "email": "email@address",
-        "twitter": "<twitter-username>"
+        "username": "github-username",
+        "email": "[email protected]"
     },
     "record": {
-        "CNAME": "<sitename>.pages.dev"
+        "CNAME": "sitename.pages.dev"
     }
 } 
 ```

diff --git a/src/docs/delete_domain/index.md b/src/docs/delete_domain/index.md
@@ -0,0 +1,27 @@
+# How to delete your is-a.dev domain
+
+## Open your fork of the [is-a-dev/register](https://github.com/is-a-dev/register) repository
+
+1. Open your fork, or if you deleted it, [fork](https://github.com/is-a-dev/register/fork) the repository once again.
+2. Find your domain file in the `domains/` folder (e.g. `/domains/myname.json`)
+3. Press the 3 dots and press the `Delete file` button.
+
+<img src="../img/delete_domain_step_1.png" height="250">
+
+4. Press `Commit changes`.
+
+<img src="../img/delete_domain_step_2.png" height="250">
+
+5. In the popup that appears, press `Commit changes` once again.
+
+<img src="../img/delete_domain_step_3.png" height="250">
+
+6. Click the `Contribute` button, then press `Open pull request`.
+
+<img src="../img/delete_domain_step_4.png" height="250">
+
+7. Press `Create pull request` again.
+
+<img src="../img/delete_domain_step_5.png" height="250">
+
+And you're done! After you pull request has been merged, the domain will be deleted.
diff --git a/src/docs/discord_verification/index.md b/src/docs/discord_verification/index.md
@@ -0,0 +1,47 @@
+# Setting up Discord domain connection with your is-a.dev domain
+
+## Get your verification string
+
+1. Open your Discord app and press `Settings`.
+
+<img src="../img/discord_step_1.png" height="259">
+
+2. Open the `Connections` section.
+
+<img src="../img/discord_step_2.png" height="259">
+
+3. Press the `View more` button.
+
+<img src="../img/discord_step_3.png" height="259">
+
+4. Click on the domain button (the globe icon).
+
+<img src="../img/discord_step_4.png" height="259">
+
+5. In the field that appears type your is-a.dev domain name (e.g. `myname.is-a.dev`).
+
+<img src="../img/discord_step_5.png" height="259">
+
+6. Copy the verification string.
+
+<img src="../img/discord_step_6.png" height="259">
+
+## Create the domain file
+
+Create a JSON file inside the `domains/` directory called `domains/_discord.yourname.json` with the following content:
+
+```json 
+{
+    "owner": {
+        "username": "github-username",
+        "email": "email@address"
+    },
+    "record": {
+        "TXT": "discord-verification-string"
+    }
+} 
+```
+
+# Configuration
+After your pull request has been merged, repeat the steps to get the verification string and press the `Verify` button.
+If it shows any error such as `Unable to verify your domain`, try waiting a few minutes (sometimes up to 24 hours) as the DNS change might not have reflected on the DNS server.
diff --git a/src/docs/domain-structure/index.md b/src/docs/domain-structure/index.md
@@ -41,17 +41,6 @@ In the owner object, the fields username and email are required. You can add mor
   }
 }
 ```
-If you don't wish to share your email address here, please share your twitter or discord or any other social media account.
-```json
-{
-  "owner": {
-    "username": "<github-username>",
-    "email": "",
-    "twitter": "twitter-handle",
-    "discord": "discord-user-id"
-  }
-}
-```
 
 ### description
 Describe your domain name and your usage. This is purely for documentation purpose and is optional.

diff --git a/src/docs/edit_domain/index.md b/src/docs/edit_domain/index.md
@@ -0,0 +1,35 @@
+# How to edit your is-a.dev domain
+
+## Open your fork of the [is-a-dev/register](https://github.com/is-a-dev/register) repository
+
+1. Open your fork, or if you deleted it, [fork](https://github.com/is-a-dev/register/fork) the repository once again.
+2. Find your domain file in the `domains/` folder (e.g. `/domains/myname.json`)
+3. Press the `Edit this file` button (a pencil icon).
+
+<img src="../img/edit_domain_step_1.png" height="250">
+
+4. Apply your changes in the text field and then press the `Commit changes` button.
+
+<img src="../img/edit_domain_step_2.png" height="250">
+
+5. In the pop-up that appears, press the button `Commit changes`.
+
+<img src="../img/edit_domain_step_3.png" height="250">
+
+6. Press on the `register` text to go back to the homepage of the repository.
+
+<img src="../img/edit_domain_step_4.png" height="250">
+
+7. Press the `Contribute` button and then press on the `Open pull request` button.
+
+<img src="../img/edit_domain_step_5.png" height="250">
+
+8. Press the `Create pull request` button.
+
+<img src="../img/edit_domain_step_6.png" height="250">
+
+8. Complete the pull request template in the description field, add a title to the pull request, then press `Create pull request`.
+
+<img src="../img/edit_domain_step_7.png" height="250">
+
+And you're done! After you pull request has been merged, the domain should be updated with-in 24 hours.
diff --git a/src/docs/img/delete_domain_step_1.png b/src/docs/img/delete_domain_step_1.png
diff --git a/src/docs/img/delete_domain_step_2.png b/src/docs/img/delete_domain_step_2.png
diff --git a/src/docs/img/delete_domain_step_3.png b/src/docs/img/delete_domain_step_3.png
diff --git a/src/docs/img/delete_domain_step_4.png b/src/docs/img/delete_domain_step_4.png
diff --git a/src/docs/img/delete_domain_step_5.png b/src/docs/img/delete_domain_step_5.png
diff --git a/src/docs/img/discord_step_1.png b/src/docs/img/discord_step_1.png
diff --git a/src/docs/img/discord_step_2.png b/src/docs/img/discord_step_2.png
diff --git a/src/docs/img/discord_step_3.png b/src/docs/img/discord_step_3.png
diff --git a/src/docs/img/discord_step_4.png b/src/docs/img/discord_step_4.png
diff --git a/src/docs/img/discord_step_5.png b/src/docs/img/discord_step_5.png
diff --git a/src/docs/img/discord_step_6.png b/src/docs/img/discord_step_6.png
diff --git a/src/docs/img/edit_domain_step_1.png b/src/docs/img/edit_domain_step_1.png
diff --git a/src/docs/img/edit_domain_step_2.png b/src/docs/img/edit_domain_step_2.png
diff --git a/src/docs/img/edit_domain_step_3.png b/src/docs/img/edit_domain_step_3.png
diff --git a/src/docs/img/edit_domain_step_4.png b/src/docs/img/edit_domain_step_4.png
diff --git a/src/docs/img/edit_domain_step_5.png b/src/docs/img/edit_domain_step_5.png
diff --git a/src/docs/img/edit_domain_step_6.png b/src/docs/img/edit_domain_step_6.png
diff --git a/src/docs/img/edit_domain_step_7.png b/src/docs/img/edit_domain_step_7.png
diff --git a/src/docs/index.md b/src/docs/index.md
@@ -5,6 +5,9 @@ You can read more about the domains JSON file structure [here](domain-structure)
 - [GitHub Pages](github_pages)
 - [Hashnode Blogs](hashnode)
 - [Cloudflare Pages](cloudflare_pages)
+- [Discord Domain Verification](discord_verification)
+- [Delete Your Domain](delete_domain)
+- [Edit Your Domain](edit_domain)
 - [Replit](replit)
 - [Railway](railway)
 - [Other Services](other)

diff --git a/src/mkdocs.yml b/src/mkdocs.yml
@@ -27,6 +27,9 @@ nav:
   - GitHub Pages: github_pages/index.md
   - Hashnode Blog: hashnode/index.md
   - Cloudflare Pages: cloudflare_pages/index.md
+  - Discord Domain Verification: discord_verification/index.md
+  - Delete Your Domain: delete_domain/index.md 
+  - Edit Your Domain: edit_domain/index.md 
   - Replit: replit/index.md
   - Railway: railway/index.md
   - Other Services: other/index.md