Skip to content

Commit

Permalink
docs(CONTRIBUTING): add pr and contributing docs (#7)
Browse files Browse the repository at this point in the history
* docs(CONTRIBUTING): add pr and contributing docs

* no u
  • Loading branch information
sinkaroid authored Apr 24, 2023
1 parent 9db47f0 commit b3f0159
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 34 deletions.
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
## How to get one?

Pretty simple.

### Step 1 - Create and statically host a website

Find a static site hosting service **GitHub Pages**, **Vercel**, **Netlify**, or etc and create your site.

### Step 2 - Choose your subdomain

According to the existing GitHub Pages URL (for http://foo.github.io/bar, either "foo.merahputih.moe" or "bar.merahputih.moe" would be
possible).

### Step 3 - Add a CNAME to your repo

Add a file named "CNAME" to your root directory of your repository (or in the
"gh-pages" branch, if you use that) with a single line matching the domain you
have chosen (e.g. "foo.merahputih.moe" without quotes). For more info about this step
you can follow the [Custom URLs](https://docs.github.com/en/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site) section at GitHub Pages Help.

```diff
+ foo.merahputih.moe
```

### Step 4 - Claim your subdomain

To finish the procedure, make a pull request in our [GitHub repository][https://github.com/ScathachGrip/merahputih.moe]
that adds your subdomain to the list of existing merahputih.moe domains. Your new URL
should go live within 24 hours (keep an eye on your pull request in case of a
naming conflict or a question from our side).

```ts
import { ICnames } from "./interfaces";

export const data: ICnames = {
active: {
"bar": "scathachgrip.github.io/bar",
"foo": "scathachgrip.github.io/foo", // noProxied
// add here as alphabetical order
}
};
```
If your site throwing an error such as `ERR_TOO_MANY_REDIRECTS` kindly disable proxied by marking your cnames with `//noProxied` comment.

## For advanced users

Our subdomain are `CNAME` records which map one domain name to another. You can
actually point your merahputih.moe to many different services that allow custom domain.

## Important

As the owner of the repository, you keep complete control over your published
content. That also means that all rights and duties that come along with
publishing a GitHub Page (e.g. GDPR) remain in your responsibility.
63 changes: 29 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,19 @@
## How to get one?

Pretty simple.

### Step 1 - Create and statically host a website

Find a static site hosting service **GitHub Pages**, **Vercel**, **Netlify**, and create your site.
[![merahputihmoe](https://cdn.discordapp.com/attachments/1046495201176334467/1100040309485883452/aku_petrus.jpg)](https://merahputih.moe/)
## Merahputih.moe

### Step 2 - Choose your subdomain
Taking inspiration from the generous [JS.ORG](https://github.com/js-org/js.org) project and [Merahputih.id](https://merahputih.id/)'s vibes we at [@ScathachGrip](https://github.com/ScathachGrip) thought of giving something back to the weeb developers: a free, sleek, and the most important is "moh-ay" URL where you can host a free website or documentation for your project UwU

According to the existing GitHub Pages URL (for http://foo.github.io/bar, either "foo.merahputih.moe" or "bar.merahputih.moe" would be
possible).

### Step 3 - Add a CNAME to your repo

Add a file named "CNAME" to your root directory of your repository (or in the
"gh-pages" branch, if you use that) with a single line matching the domain you
have chosen (e.g. "foo.merahputih.moe" without quotes). For more info about this step
you can follow the [Custom URLs](gh-custom-urls) section at GitHub Pages Help.

```diff
+ foo.merahputih.moe
```
- [Merahputih.moe](https://merahputih.moe)
- [How to get one](#how-to-get-one)
- [Add a CNAME to your repo](#add-a-cname-to-your-repo)
- [For advanced users](#for-advanced-users)
- [No proxied rules](#no-proxied-rules)
- [Closing Remarks](#closing-remarks)

### Step 4 - Claim your subdomain
----

To finish the procedure, make a pull request in our [GitHub repository][repo]
that adds your subdomain to the list of existing merahputih.moe domains. Your new URL
should go live within 24 hours (keep an eye on your pull request in case of a
naming conflict or a question from our side).
## How to get one?
Make a pull request in this repository, go to [src/cnames.ts](https://github.com/ScathachGrip/merahputih.moe/edit/master/src/cnames.ts) and add your subdomain.

```ts
import { ICnames } from "./interfaces";
Expand All @@ -36,19 +22,28 @@ export const data: ICnames = {
active: {
"bar": "scathachgrip.github.io/bar",
"foo": "scathachgrip.github.io/foo", // noProxied
// add here as alphabetical order keys
// add here as alphabetical order
}
};
```
If your site throwing an error such as `ERR_TOO_MANY_REDIRECTS` kindly disable proxied by marking your cnames with `//noProxied` comment.
Read the [CONTRIBUTING.md](https://github.com/ScathachGrip/merahputih.moe/blob/master/CONTRIBUTING.md) for more details If you haven't Create and statically host a website, once pull request is merged your site will be live immediately.

## For advanced users
## Add a CNAME to your repo
Add a file named "CNAME" to your root directory of your repository (or in the
"gh-pages" branch, if you use that) with a single line matching the domain you
have chosen (e.g. "foo.merahputih.moe" without quotes). For more info about this step
you can follow the [Custom URLs](https://docs.github.com/en/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site) section at GitHub Pages Help.

Our subdomain are _CNAME_ records which map one domain name to another. You can
```diff
+ foo.merahputih.moe
```

## For advanced users
Our subdomain are `CNAME` records which map one domain name to another. You can
actually point your merahputih.moe to many different services that allow custom domain.

## Important
## No proxied rules
If your site throwing an error such as `ERR_TOO_MANY_REDIRECTS` kindly disable proxied by marking your cnames with `//noProxied` comment.

As the owner of the repository, you keep complete control over your published
content. That also means that all rights and duties that come along with
publishing a GitHub Page (e.g. GDPR) remain in your responsibility.
## Closing Remarks
[CLOSING_REMARKS.md](https://github.com/sinkaroid/lustpress/blob/master/CLOSING_REMARKS.md)

0 comments on commit b3f0159

Please sign in to comment.