diff --git a/src/index.md b/src/index.md index 235da294..a294e1c4 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 -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). +For our Quick Start guide you can click [here](quickstart) to read it. You can also read about the domains' JSON file structure [here](useful/domain-structure). ## Guides - [GitHub Pages](guides/github-pages) @@ -17,9 +17,10 @@ For our Quick Start guide you can click [here](useful/quickstart) to read it. Yo - [Vercel](guides/vercel) - [Codeberg Pages](guides/codeberg-pages) - [Netlify](guides/netlify) -- [ImprovMX](guides/improvmx) - [Zoho Mail](guides/zoho-mail) +- [ImprovMX](guides/improvmx) - [DanBot Hosting](guides/dbh) +- [Firebase Hosting](guides/firebase) - [Hashnode Blogs](guides/hashnode) - [Railway](guides/railway) - [Render](guides/render) diff --git a/src/useful/quickstart.md b/src/quickstart.md similarity index 85% rename from src/useful/quickstart.md rename to src/quickstart.md index e55319df..4296282d 100644 --- a/src/useful/quickstart.md +++ b/src/quickstart.md @@ -2,19 +2,22 @@ icon: rocket label: Quick Start route: /quickstart -tags: useful +tags: [useful, guides] --- -# Requirements before starting +# Quickstart Guide + +## 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 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 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). - + +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 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. -# Making the 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 do so. @@ -41,7 +44,7 @@ You should replace the placeholder username with your own GitHub username and th 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 +### 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. @@ -54,6 +57,6 @@ Please don't replace the pull request template with something else, since that c 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? +## 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 of the common questions answered 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.