tiennm99/is-a-dev
1
0
Fork 0
mirror of https://github.com/tiennm99/is-a-dev.git synced 2026-05-24 15:36:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactors documentation into sections

Browse Source
This commit is contained in:
Akshay Nair
2020-11-19 01:20:39 +05:30
parent c2158a110c
commit 71c58400b4
6 changed files with 180 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files
API.md
+1 -133
View File
@@ -1,133 +1 @@
# How to register
* First you need to create a pull request with your `domains/my-domain.json` file
* This PR will be reviewed
* The changes will take effect soon after the PR gets merged
* And that's it
### Simple cname record
* A github pages json file will look something like this -
```json
{
"description": "Add some description",
"repo": "https://github.com/github-username",
"owner": {
"username": "github-username",
"email": "any@email"
},
"record": {
"CNAME": "the-domain-you-own.com"
}
}
```
* After the pull request is merged, configure your server (apache, nginx, whatever) to work with `subdomain.is-a.dev`
### For github pages users
* You can take a look at the [github pages guide](https://guides.github.com/features/pages/) if you need help with setting up a website with github pages.
* Your json file will look something like this -
```json
{
"description": "Add some description",
"repo": "https://github.com/github-username/github-username.github.io",
"owner": {
"username": "github-username",
"email": "any@email"
},
"record": {
"CNAME": "github-username.github.io"
}
}
```
* After the pull request is merged, you will see a 404 error on `your-domain.is-a.dev`. To fix this go to your github page repo's `Settings > Github pages > Custom domain` and add `your-domain.is-a.dev` in the given field
* Check the `Enforce HTTPS` checkbox below the custom domain input
# Domains json file
The way you register your own domain name is through a pull request.
To register `my-domain.is-a.dev`, you need to create a `domains/my-domain.json` file
### Filename
The file name must pass the following criteria -
* Must be alpha-numeric in lowercase with dashes as seperators
* Must be more than 2 characters long
* Must have a `.json` file extension
The file needs to have the following fields -
### owner (required)
You need to specify some information about yourself here.
This is so that you can be contacted if required.
In the owner object, the fields `username` and `email` are required. You can however add more information in this object if you need.
```json
{
"owner": {
"username": "github-username",
"email": "any@email"
},
}
```
If you don't wish to share your email address here, please share your twitter or any other social media account.
```json
{
"owner": {
"username": "github-username",
"email": "",
"twitter": "twitter-handle"
},
}
```
### description
Describe your domain name and your usage. This is purely for documentation purpose and is optional.
### repo
This is a link to your website repository or your github account. This is purely for documentation purpose and is optional.
### record (required)
This is where you specify how you want to link to your server/webpage.
Currently, only `CNAME`, `A`, `URL` record types are supported.
Here's a few different use cases for the given record types -
* **CNAME**
CNAME must be a host name (Eg - `something.tld`)
```json
{
"record": {
"CNAME": "username.github.io"
}
}
```
* **A record**
A record must be a list of ips
```json
{
"record": {
"A": [
"999.999.991.999",
"999.999.992.999",
"999.999.993.999",
"999.999.994.999"
]
}
}
```
* **URL redirection**
```json
{
"record": {
"URL": "https://my-other-website.com"
}
}
```
Moved to [./docs](./docs)