From 0f793bfca2de6e2b0aeae92990713d8fc101441f Mon Sep 17 00:00:00 2001 From: iostpa Date: Tue, 28 Oct 2025 15:48:13 +0200 Subject: [PATCH 01/12] Add a quick start guide and do some nitpicks --- src/guides/dbh.md | 4 ++++ src/index.md | 4 ++-- src/useful/quickstart.md | 52 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 58 insertions(+), 2 deletions(-) create mode 100644 src/useful/quickstart.md diff --git a/src/guides/dbh.md b/src/guides/dbh.md index 7232ed41..ddb9f2e4 100644 --- a/src/guides/dbh.md +++ b/src/guides/dbh.md @@ -5,6 +5,10 @@ tags: guides icon: /media/dbh.png --- +!!!danger +This hosting service has changed a lot in recent times, so this guide may not be up to date with the current system the hosting provider has. +!!! + # Setting up DanBot Hosting with an is-a.dev subdomain This guide will walk you through the process of setting up a DanBot Hosting website and pointing your is-a.dev subdomain to it. diff --git a/src/index.md b/src/index.md index b1ddbc10..235da294 100644 --- a/src/index.md +++ b/src/index.md @@ -9,7 +9,7 @@ icon: home Here you'll find detailed guides, the JSON file structure, and more. If you'd like to contribute to our documentation, visit [our documentation repository](https://github.com/is-a-dev/docs) on GitHub. ## How to Register -You can read about the domains' JSON file structure [here](useful/domain-structure). +For our Quick Start guide you can click [here](useful/quickstart) to read it. You can also read about the domains' JSON file structure [here](useful/domain-structure). ## Guides - [GitHub Pages](guides/github-pages) @@ -18,7 +18,7 @@ You can read about the domains' JSON file structure [here](useful/domain-structu - [Codeberg Pages](guides/codeberg-pages) - [Netlify](guides/netlify) - [ImprovMX](guides/improvmx) -- [Zoho Mail](guides/zoho-mail.md) +- [Zoho Mail](guides/zoho-mail) - [DanBot Hosting](guides/dbh) - [Hashnode Blogs](guides/hashnode) - [Railway](guides/railway) diff --git a/src/useful/quickstart.md b/src/useful/quickstart.md new file mode 100644 index 00000000..b25b8acf --- /dev/null +++ b/src/useful/quickstart.md @@ -0,0 +1,52 @@ +--- +icon: rocket +label: Quick Start +route: /quickstart +tags: useful +--- + +# Requirements before starting + +Before you start the process of making a is-a.dev domain, make sure you have the following: + 1. You have a website that is at least complete and not a incomplete website with either barely anything on it or has incomplete sections. + 2. Make sure the website is a personal website (like a portfolio or a blog that's software developer related) or a non-commercial project that's software developer related. + 3. Make sure the website isn't for commercial purposes, if we see that the website is for commercial purposes we have the right to close the pull request. You can read more of our Terms of Conditions [here](https://is-a.dev/terms). + +After you've made sure that you meet these requirements, we can continue with the process of making a is-a.dev domain. + +# Making the is-a.dev domain + +Now, to make the file in the first place before making a pull request, you have to fork [our repository](https://github.com/is-a-dev/register). You can click the link [here](https://github.com/is-a-dev/register/fork) to fork our repository. + +After you've forked our repository, you can start making the file for your domain. To make the file, enter your fork of our repository (which you should already be there), enter the `domains` directory, also known as a folder, and create the file from there. + +You may be wondering, "How should I name the file?". The filename should be the domain name you want in lowercase and then the JSON extension (.json) at the end of the filename, so basically it would be something like this: `subdomain.json`. (Replace `subdomain` with the name you want to register of course) + +After you've finished with the filename, you can start making the file format of the JSON file. Now depending on your hosting provider, we have guides for most hosting providers (like GitHub Pages, Cloudflare Pages and Vercel, just to name a few) accessible in our documentation, but for hosting providers that don't have a guide, you should pay attention to what records they provide. An example of a valid file format is the one listed below, though you can also check out the [Domain Structure](useful/domain-structure) section to see what records we support. + +```json +{ + "owner": { + "username": "your-github-username" + }, + "records": { + "CNAME": "example.org" + } +} +``` + +!!! +You should replace the placeholder username with your own GitHub username and the placeholder records with the valid records your hosting provider gave while trying to connect the domain. +!!! + +When you've made sure that you have the valid file format and the correct filename, you can now start making a pull request. If you aren't sure if the JSON format is valid, you can check with [jsonlint](https://jsonlint.com/). + +## Making the pull request + +Assuming you know how GitHub works, it should be easy for you to make a pull request to our repository. For those who don't know how to make one, you can check [this guide from GitHub's documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on how to do it. + +Before you create the pull request, make sure that you've read the pull request template and have completed it with the right information so that it saves both your time and our (maintainers) time. When you've completed it, you can create the pull request and wait for the maintainers to review the pull request. Make sure to also check the pull request from time to time to see if there's any chances that need to be made. + +# What do I do now? + +When your pull request has been merged by a maintainer, you have to make sure that you've connected the domain with your website, or else it won't work. Go to your website's settings and add the domain from there to make sure you've added it. After you've connected the domain, you are good to go! Now you can enjoy your is-a.dev domain. If you have any questions then you can either make a GitHub issue on our main repository or [join our Discord server](https://discord.gg/is-a-dev-830872854677422150) and ask there. You can also read our [FAQ](useful/faq) since we should have most common questions there. \ No newline at end of file From 53b0f1d00e47cf74b5e7099ac65925c9e7e808b5 Mon Sep 17 00:00:00 2001 From: iostpa Date: Tue, 28 Oct 2025 16:07:35 +0200 Subject: [PATCH 02/12] Change the wording a bit --- src/guides/dbh.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/guides/dbh.md b/src/guides/dbh.md index ddb9f2e4..3c28e5ad 100644 --- a/src/guides/dbh.md +++ b/src/guides/dbh.md @@ -6,7 +6,7 @@ icon: /media/dbh.png --- !!!danger -This hosting service has changed a lot in recent times, so this guide may not be up to date with the current system the hosting provider has. +This hosting provider has changed a lot in recent times, so this guide may not be up to date with the current system the hosting provider has. !!! # Setting up DanBot Hosting with an is-a.dev subdomain From 7652c55e9e42a4d3541ac6df3e9f149cf48ce67c Mon Sep 17 00:00:00 2001 From: iostpa Date: Tue, 28 Oct 2025 17:08:18 +0200 Subject: [PATCH 03/12] Do the fixes which stick pointed out --- src/useful/quickstart.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/src/useful/quickstart.md b/src/useful/quickstart.md index b25b8acf..1e8d73de 100644 --- a/src/useful/quickstart.md +++ b/src/useful/quickstart.md @@ -20,7 +20,7 @@ Now, to make the file in the first place before making a pull request, you have After you've forked our repository, you can start making the file for your domain. To make the file, enter your fork of our repository (which you should already be there), enter the `domains` directory, also known as a folder, and create the file from there. -You may be wondering, "How should I name the file?". The filename should be the domain name you want in lowercase and then the JSON extension (.json) at the end of the filename, so basically it would be something like this: `subdomain.json`. (Replace `subdomain` with the name you want to register of course) +You may be wondering, "How should I name the file?". The filename should be the domain name you want in lowercase and then the JSON extension (.json) at the end of the filename, so basically it would be something like this: `subdomain.json` (Replace `subdomain` with the name you want to register of course). For more information about what filenames are valid or invalid, click [here](https://docs.is-a.dev/domain-structure/#-filename-guidelines). After you've finished with the filename, you can start making the file format of the JSON file. Now depending on your hosting provider, we have guides for most hosting providers (like GitHub Pages, Cloudflare Pages and Vercel, just to name a few) accessible in our documentation, but for hosting providers that don't have a guide, you should pay attention to what records they provide. An example of a valid file format is the one listed below, though you can also check out the [Domain Structure](useful/domain-structure) section to see what records we support. @@ -45,7 +45,14 @@ When you've made sure that you have the valid file format and the correct filena Assuming you know how GitHub works, it should be easy for you to make a pull request to our repository. For those who don't know how to make one, you can check [this guide from GitHub's documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on how to do it. -Before you create the pull request, make sure that you've read the pull request template and have completed it with the right information so that it saves both your time and our (maintainers) time. When you've completed it, you can create the pull request and wait for the maintainers to review the pull request. Make sure to also check the pull request from time to time to see if there's any chances that need to be made. +Before you create the pull request, make sure that you've read the pull request template and have completed it with the right information so that it saves both your time and our (maintainers) time. + +!!!danger +Please don't replace the pull request template with something else, since that could result in your pull request being closed instantly when a maintainer sees it. Please also add a preview of your website with both the link to your website and a screenshot of your website in the pull request description. +!!! + +When you've completed it, you can create the pull request and wait for the maintainers to review the pull request. Make sure to also check the pull request from time to time to see if there's any chances that need to be made. + # What do I do now? From ee9a5a58008334ba3aae26e8fcbb8527d0191632 Mon Sep 17 00:00:00 2001 From: iostpa Date: Tue, 28 Oct 2025 17:29:07 +0200 Subject: [PATCH 04/12] Update src/useful/quickstart.md Co-authored-by: William Harrison <87287585+wdhdev@users.noreply.github.com> --- src/useful/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/useful/quickstart.md b/src/useful/quickstart.md index 1e8d73de..d9553a65 100644 --- a/src/useful/quickstart.md +++ b/src/useful/quickstart.md @@ -8,7 +8,7 @@ tags: useful # Requirements before starting Before you start the process of making a is-a.dev domain, make sure you have the following: - 1. You have a website that is at least complete and not a incomplete website with either barely anything on it or has incomplete sections. + 1. You have a website that is at least somewhat complete. It should not be blank or have very little information. 2. Make sure the website is a personal website (like a portfolio or a blog that's software developer related) or a non-commercial project that's software developer related. 3. Make sure the website isn't for commercial purposes, if we see that the website is for commercial purposes we have the right to close the pull request. You can read more of our Terms of Conditions [here](https://is-a.dev/terms). From 03bc16e51f167d883443a19bb78d19c99b27c3a1 Mon Sep 17 00:00:00 2001 From: iostpa Date: Tue, 28 Oct 2025 17:29:16 +0200 Subject: [PATCH 05/12] Update src/useful/quickstart.md Co-authored-by: William Harrison <87287585+wdhdev@users.noreply.github.com> --- src/useful/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/useful/quickstart.md b/src/useful/quickstart.md index d9553a65..9ff1c1e8 100644 --- a/src/useful/quickstart.md +++ b/src/useful/quickstart.md @@ -9,7 +9,7 @@ tags: useful Before you start the process of making a is-a.dev domain, make sure you have the following: 1. You have a website that is at least somewhat complete. It should not be blank or have very little information. - 2. Make sure the website is a personal website (like a portfolio or a blog that's software developer related) or a non-commercial project that's software developer related. + 2. Make sure the website is a personal website (like a portfolio or a blog that's software development related) or a non-commercial project that's software development related. 3. Make sure the website isn't for commercial purposes, if we see that the website is for commercial purposes we have the right to close the pull request. You can read more of our Terms of Conditions [here](https://is-a.dev/terms). After you've made sure that you meet these requirements, we can continue with the process of making a is-a.dev domain. From 68e4ac848638677ef4eb2afd807f4b9a3dca299d Mon Sep 17 00:00:00 2001 From: iostpa Date: Tue, 28 Oct 2025 19:50:01 +0200 Subject: [PATCH 06/12] Update src/useful/quickstart.md Co-authored-by: orangci --- src/useful/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/useful/quickstart.md b/src/useful/quickstart.md index 9ff1c1e8..edeaa582 100644 --- a/src/useful/quickstart.md +++ b/src/useful/quickstart.md @@ -16,7 +16,7 @@ After you've made sure that you meet these requirements, we can continue with th # Making the is-a.dev domain -Now, to make the file in the first place before making a pull request, you have to fork [our repository](https://github.com/is-a-dev/register). You can click the link [here](https://github.com/is-a-dev/register/fork) to fork our repository. +Now, to make the file in the first place before making a pull request, you have to fork [our repository](https://github.com/is-a-dev/register). You can click the link [here](https://github.com/is-a-dev/register/fork) to do so. After you've forked our repository, you can start making the file for your domain. To make the file, enter your fork of our repository (which you should already be there), enter the `domains` directory, also known as a folder, and create the file from there. From f4b0ef7c6a98103a13022031201d0b6b65d81f19 Mon Sep 17 00:00:00 2001 From: iostpa Date: Tue, 28 Oct 2025 19:50:51 +0200 Subject: [PATCH 07/12] Update src/useful/quickstart.md Co-authored-by: orangci --- src/useful/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/useful/quickstart.md b/src/useful/quickstart.md index edeaa582..2a91bc78 100644 --- a/src/useful/quickstart.md +++ b/src/useful/quickstart.md @@ -20,7 +20,7 @@ Now, to make the file in the first place before making a pull request, you have After you've forked our repository, you can start making the file for your domain. To make the file, enter your fork of our repository (which you should already be there), enter the `domains` directory, also known as a folder, and create the file from there. -You may be wondering, "How should I name the file?". The filename should be the domain name you want in lowercase and then the JSON extension (.json) at the end of the filename, so basically it would be something like this: `subdomain.json` (Replace `subdomain` with the name you want to register of course). For more information about what filenames are valid or invalid, click [here](https://docs.is-a.dev/domain-structure/#-filename-guidelines). +You may be wondering, "How should I name the file?" The filename should be the domain name you want in lowercase followed by the JSON extension (.json) at the end of the filename, so it would be something like this: `subdomain.json` (Replace `subdomain` with the name you want to register, of course). For more information about what filenames are valid or invalid, click [here](https://docs.is-a.dev/domain-structure/#-filename-guidelines). After you've finished with the filename, you can start making the file format of the JSON file. Now depending on your hosting provider, we have guides for most hosting providers (like GitHub Pages, Cloudflare Pages and Vercel, just to name a few) accessible in our documentation, but for hosting providers that don't have a guide, you should pay attention to what records they provide. An example of a valid file format is the one listed below, though you can also check out the [Domain Structure](useful/domain-structure) section to see what records we support. From 86de0cb5d8a2a69fdbec8a3a33396cb9f29df2cf Mon Sep 17 00:00:00 2001 From: iostpa Date: Tue, 28 Oct 2025 19:52:16 +0200 Subject: [PATCH 08/12] Update src/useful/quickstart.md Co-authored-by: orangci --- src/useful/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/useful/quickstart.md b/src/useful/quickstart.md index 2a91bc78..e508294a 100644 --- a/src/useful/quickstart.md +++ b/src/useful/quickstart.md @@ -51,7 +51,7 @@ Before you create the pull request, make sure that you've read the pull request Please don't replace the pull request template with something else, since that could result in your pull request being closed instantly when a maintainer sees it. Please also add a preview of your website with both the link to your website and a screenshot of your website in the pull request description. !!! -When you've completed it, you can create the pull request and wait for the maintainers to review the pull request. Make sure to also check the pull request from time to time to see if there's any chances that need to be made. +When you've completed it, you can create the pull request and wait for the maintainers to review it. Make sure to also check the pull request from time to time to see if there's any chances that need to be made. # What do I do now? From de6b481da0c39710c528811ce7eb721c706d4c44 Mon Sep 17 00:00:00 2001 From: iostpa Date: Tue, 28 Oct 2025 19:52:35 +0200 Subject: [PATCH 09/12] Update src/useful/quickstart.md Co-authored-by: orangci --- src/useful/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/useful/quickstart.md b/src/useful/quickstart.md index e508294a..c54bb781 100644 --- a/src/useful/quickstart.md +++ b/src/useful/quickstart.md @@ -56,4 +56,4 @@ When you've completed it, you can create the pull request and wait for the maint # What do I do now? -When your pull request has been merged by a maintainer, you have to make sure that you've connected the domain with your website, or else it won't work. Go to your website's settings and add the domain from there to make sure you've added it. After you've connected the domain, you are good to go! Now you can enjoy your is-a.dev domain. If you have any questions then you can either make a GitHub issue on our main repository or [join our Discord server](https://discord.gg/is-a-dev-830872854677422150) and ask there. You can also read our [FAQ](useful/faq) since we should have most common questions there. \ No newline at end of file +When your pull request has been merged by a maintainer, you have to make sure that you've connected the domain with your website, or else it won't work. Go to your website's settings and add the domain from there to make sure you've added it. After you've connected the domain, you are good to go! Now you can enjoy your is-a.dev domain. If you have any questions then you can either make a GitHub issue on our main repository or [join our Discord server](https://discord.gg/is-a-dev-830872854677422150) and ask there. You can also read our [FAQ](useful/faq) since we should have most of the common questions answered there. \ No newline at end of file From d2ee8d0cb6725819e5902c11077d7a4eea51621e Mon Sep 17 00:00:00 2001 From: iostpa Date: Tue, 28 Oct 2025 19:52:50 +0200 Subject: [PATCH 10/12] Update src/useful/quickstart.md Co-authored-by: orangci --- src/useful/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/useful/quickstart.md b/src/useful/quickstart.md index c54bb781..16b371c4 100644 --- a/src/useful/quickstart.md +++ b/src/useful/quickstart.md @@ -10,7 +10,7 @@ tags: useful Before you start the process of making a is-a.dev domain, make sure you have the following: 1. You have a website that is at least somewhat complete. It should not be blank or have very little information. 2. Make sure the website is a personal website (like a portfolio or a blog that's software development related) or a non-commercial project that's software development related. - 3. Make sure the website isn't for commercial purposes, if we see that the website is for commercial purposes we have the right to close the pull request. You can read more of our Terms of Conditions [here](https://is-a.dev/terms). + 3. Make sure the website isn't for commercial purposes; if the website is for commercial purposes, we have the right to close the pull request. You can read our Terms of Conditions [here](https://is-a.dev/terms). After you've made sure that you meet these requirements, we can continue with the process of making a is-a.dev domain. From d5229bfc2be2596b4f761e924867bf56472006c9 Mon Sep 17 00:00:00 2001 From: iostpa Date: Tue, 28 Oct 2025 19:55:12 +0200 Subject: [PATCH 11/12] orangc nitpick --- src/useful/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/useful/quickstart.md b/src/useful/quickstart.md index 16b371c4..61eb6822 100644 --- a/src/useful/quickstart.md +++ b/src/useful/quickstart.md @@ -22,7 +22,7 @@ After you've forked our repository, you can start making the file for your domai You may be wondering, "How should I name the file?" The filename should be the domain name you want in lowercase followed by the JSON extension (.json) at the end of the filename, so it would be something like this: `subdomain.json` (Replace `subdomain` with the name you want to register, of course). For more information about what filenames are valid or invalid, click [here](https://docs.is-a.dev/domain-structure/#-filename-guidelines). -After you've finished with the filename, you can start making the file format of the JSON file. Now depending on your hosting provider, we have guides for most hosting providers (like GitHub Pages, Cloudflare Pages and Vercel, just to name a few) accessible in our documentation, but for hosting providers that don't have a guide, you should pay attention to what records they provide. An example of a valid file format is the one listed below, though you can also check out the [Domain Structure](useful/domain-structure) section to see what records we support. +After you've finished with the filename, you can start making the file format of the JSON file. Depending on your hosting provider, we have guides for most hosting providers (like GitHub Pages, Cloudflare Pages and Vercel, just to name a few) accessible in our documentation, but for hosting providers that don't have a guide, you should pay attention to what records they provide. An example of a valid file format is the one listed below, though you can also check out the [Domain Structure](useful/domain-structure) section to see what records we support. ```json { From fed99700e47eefbd33fa7bd2bf33974911a49165 Mon Sep 17 00:00:00 2001 From: iostpa Date: Tue, 28 Oct 2025 19:56:16 +0200 Subject: [PATCH 12/12] Update src/useful/quickstart.md Co-authored-by: orangci --- src/useful/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/useful/quickstart.md b/src/useful/quickstart.md index 61eb6822..e55319df 100644 --- a/src/useful/quickstart.md +++ b/src/useful/quickstart.md @@ -45,7 +45,7 @@ When you've made sure that you have the valid file format and the correct filena Assuming you know how GitHub works, it should be easy for you to make a pull request to our repository. For those who don't know how to make one, you can check [this guide from GitHub's documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on how to do it. -Before you create the pull request, make sure that you've read the pull request template and have completed it with the right information so that it saves both your time and our (maintainers) time. +Before you create the pull request, make sure that you've read the pull request template and have completed it with the right information in order to save both your time and our (the maintainers') time. !!!danger Please don't replace the pull request template with something else, since that could result in your pull request being closed instantly when a maintainer sees it. Please also add a preview of your website with both the link to your website and a screenshot of your website in the pull request description.