From c320a5e29c4bec44138492ee2543e2b3c59da30e Mon Sep 17 00:00:00 2001 From: William Harrison <87287585+wdhdev@users.noreply.github.com> Date: Mon, 13 Jan 2025 11:30:53 +0800 Subject: [PATCH] small updates + fixes --- src/guides/cloudflare-pages.md | 3 +-- src/guides/discord-verification.md | 3 +-- src/guides/github-pages.md | 3 +-- src/guides/hashnode.md | 3 +-- src/guides/improvmx.md | 3 +-- src/guides/netlify.md | 3 +-- src/guides/other.md | 2 +- src/guides/railway.md | 3 +-- src/guides/render.md | 3 +-- src/guides/replit.md | 3 +-- src/guides/vercel.md | 3 +-- src/index.md | 8 ++++---- src/useful/domain-structure.md | 10 ++++++---- src/useful/faq.md | 3 ++- src/useful/resources.md | 4 ++-- 15 files changed, 25 insertions(+), 32 deletions(-) diff --git a/src/guides/cloudflare-pages.md b/src/guides/cloudflare-pages.md index d7515c93..3bf17a99 100644 --- a/src/guides/cloudflare-pages.md +++ b/src/guides/cloudflare-pages.md @@ -1,8 +1,7 @@ --- label: Cloudflare Pages icon: /media/cloudflare.svg -tags: - - guides +tags: guides --- # Setting up Cloudflare Pages with is-a-dev subdomain diff --git a/src/guides/discord-verification.md b/src/guides/discord-verification.md index 505fc827..9b9ed4e5 100644 --- a/src/guides/discord-verification.md +++ b/src/guides/discord-verification.md @@ -1,8 +1,7 @@ --- icon: /media/discord.svg label: Discord Domain Connection -tags: - - guides +tags: guides --- # Setting up Discord domain connection with your is-a.dev domain diff --git a/src/guides/github-pages.md b/src/guides/github-pages.md index 3a78806e..63750dcb 100644 --- a/src/guides/github-pages.md +++ b/src/guides/github-pages.md @@ -1,8 +1,7 @@ --- label: GitHub Pages icon: mark-github -tags: - - guides +tags: guides --- ## Setting up GitHub pages with is-a.dev subdomain diff --git a/src/guides/hashnode.md b/src/guides/hashnode.md index 4cfa7456..6571a516 100644 --- a/src/guides/hashnode.md +++ b/src/guides/hashnode.md @@ -1,8 +1,7 @@ --- icon: /media/hashnode.svg label: Hashnode -tags: - - guides +tags: guides --- # Hashnode Blog diff --git a/src/guides/improvmx.md b/src/guides/improvmx.md index 178f0319..7964d238 100644 --- a/src/guides/improvmx.md +++ b/src/guides/improvmx.md @@ -1,8 +1,7 @@ --- label: ImprovMX icon: /media/improvmx.svg -tags: - - guides +tags: guides --- # Setting up ImprovMX with is-a.dev subdomain diff --git a/src/guides/netlify.md b/src/guides/netlify.md index 01a4e1c1..289734d3 100644 --- a/src/guides/netlify.md +++ b/src/guides/netlify.md @@ -1,8 +1,7 @@ --- icon: /media/netlify.svg label: Netlify -tags: - - guides +tags: guides --- # Setting up Netlify with is-a.dev Subdomain diff --git a/src/guides/other.md b/src/guides/other.md index dab12130..daa01626 100644 --- a/src/guides/other.md +++ b/src/guides/other.md @@ -8,7 +8,7 @@ tags: guides ## Setting up records -Read the [domain file structure](/domain-structure) and setup the records accordingly. +Read the [domain file structure](../useful/domain-structure) and setup the records accordingly. ## Configuring your server diff --git a/src/guides/railway.md b/src/guides/railway.md index eb061cd5..91f7a1b7 100644 --- a/src/guides/railway.md +++ b/src/guides/railway.md @@ -1,8 +1,7 @@ --- icon: /media/railway.png label: Railway -tags: - - guides +tags: guides --- # Setting up is-a.dev with Railway diff --git a/src/guides/render.md b/src/guides/render.md index fd6e7742..38574806 100644 --- a/src/guides/render.md +++ b/src/guides/render.md @@ -1,8 +1,7 @@ --- icon: /media/render.svg label: Render -tags: - - guides +tags: guides --- # Setting up Render with is-a.dev Subdomain diff --git a/src/guides/replit.md b/src/guides/replit.md index b9a0ca51..deb8009c 100644 --- a/src/guides/replit.md +++ b/src/guides/replit.md @@ -1,8 +1,7 @@ --- icon: /media/replit.svg label: Replit -tags: - - guides +tags: guides --- # Setting up Replit with your is-a.dev subdomain diff --git a/src/guides/vercel.md b/src/guides/vercel.md index e18b56d3..ff64c7b9 100644 --- a/src/guides/vercel.md +++ b/src/guides/vercel.md @@ -1,8 +1,7 @@ --- icon: /media/vercel.svg label: Vercel -tags: - - guides +tags: guides --- # Setting up Vercel with is-a.dev subdomain diff --git a/src/index.md b/src/index.md index a9b20f37..79e3a1d7 100644 --- a/src/index.md +++ b/src/index.md @@ -8,7 +8,7 @@ icon: home Here you will find guides, our JSON file structure and more. If you want to help contribute to our documentation, you can visit [our docs repository](https://github.com/is-a-dev/docs). ## How to Register -You can read about the domains JSON file structure [here](domain-structure). +You can read about the domains JSON file structure [here](useful/domain-structure). ## Guides - [Cloudflare Pages](guides/cloudflare-pages) @@ -25,9 +25,9 @@ You can read about the domains JSON file structure [here](domain-structure). - [Vercel](guides/vercel) ## Useful - - [Domain Structure](domain-structure) - - [FAQ](faq) - - [Resources](resources) + - [Domain Structure](useful/domain-structure) + - [FAQ](useful/faq) + - [Resources](useful/resources) ## Official Subdomains These are the subdomains run by the is-a.dev staff team. diff --git a/src/useful/domain-structure.md b/src/useful/domain-structure.md index 0093d1c6..abc00261 100644 --- a/src/useful/domain-structure.md +++ b/src/useful/domain-structure.md @@ -1,7 +1,7 @@ --- -tags: useful icon: file-code route: /domain-structure +tags: useful --- # Domain Structure To register a subdomain, you need to create a new JSON file in the `domains` directory through a pull request. For example, to register `example.is-a.dev`, you would create a file named `example.json` in the `domains` directory. The full path would be `domains/example.json`. @@ -38,6 +38,7 @@ All the filenames below meet all the criteria. The reason in parentheses is just ### Example JSON File `domains/docs.json` + ```json { "description": "Documentation website for is-a.dev", @@ -47,8 +48,9 @@ All the filenames below meet all the criteria. The reason in parentheses is just "email": "admin@is-a.dev" }, "record": { - "CNAME": "is-a.dev" - } + "CNAME": "is-a-dev-docs.pages.dev" + }, + "proxied": true } ``` @@ -74,7 +76,7 @@ This is a link to your website repository or your github account. This is purely ### record (required) This section is where you specify the DNS records. -You can see a list of supported types [here](/faq/#which-records-are-supported). +You can see a list of supported types [here](./faq#which-records-are-supported). Below are some examples for the given record types: diff --git a/src/useful/faq.md b/src/useful/faq.md index b7e559ee..7fb11226 100644 --- a/src/useful/faq.md +++ b/src/useful/faq.md @@ -1,7 +1,8 @@ --- -tags: useful icon: question +label: FAQ route: /faq +tags: useful --- # Frequently Asked Questions (FAQ) diff --git a/src/useful/resources.md b/src/useful/resources.md index 7aa0cec7..bd8f8f90 100644 --- a/src/useful/resources.md +++ b/src/useful/resources.md @@ -1,7 +1,7 @@ --- -tags: useful -icon: info +icon: browser route: /resources +tags: useful --- # Resources