Skip to content

Commit 3cb4889

Browse files
authored
updates to json structure
1 parent 1715eb1 commit 3cb4889

File tree

10 files changed

+18
-47
lines changed

10 files changed

+18
-47
lines changed

src/docs/cloudflare-pages/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ In the `domains` directory, create a new JSON file for your subdomain (`domains/
1717
```json
1818
{
1919
"owner": {
20-
"username": "your-github-username",
21-
"email": "[email protected]"
20+
"username": "your-github-username"
2221
},
2322
"record": {
2423
"CNAME": "your-sitename.pages.dev"

src/docs/dbh/index.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,8 @@ If you are on free plan, choose any US proxy or you can use the Donator Proxy If
2020
Create a JSON file inside `domains` directory (`domains/<subdomain>.json`) with the following content and submit a pull request:
2121
```json
2222
{
23-
"description": "Describe the use of this subdomain",
24-
"repo": "https://github.com/<github-username>/<github-repository>",
2523
"owner": {
26-
"username": "<github-username>",
27-
"email": "<email@address>",
28-
"twitter": "<twitter-username>"
24+
"username": "github-username"
2925
},
3026
"record": {
3127
"A": [

src/docs/discord-verification/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ Create a JSON file inside the `domains/` directory called `domains/_discord.exam
2727
```json
2828
{
2929
"owner": {
30-
"username": "github-username",
31-
"email": "email@address"
30+
"username": "github-username"
3231
},
3332
"record": {
3433
"TXT": ["discord-verification-string"]

src/docs/domain-structure/index.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,15 @@ All the filenames below meet all the criteria. The reason in parentheses is just
3434
`domains/docs.json`
3535
```json
3636
{
37-
"description": "Documentation for is-a-dev",
37+
"description": "Documentation website for is-a.dev",
3838
"repo": "https://github.com/is-a-dev/docs",
3939
"owner": {
4040
"username": "is-a-dev",
41-
"email": "hello@is-a.dev"
41+
"email": "admin@is-a.dev"
4242
},
4343
"record": {
44-
"URL": "https://www.is-a.dev/docs"
45-
},
46-
"proxied": false
44+
"URL": "https://is-a.dev/docs"
45+
}
4746
}
4847
```
4948

@@ -55,8 +54,7 @@ In the owner object, the fields username and email are required. You can add mor
5554
```json
5655
{
5756
"owner": {
58-
"username": "<github-username>",
59-
"email": "<email@address>"
57+
"username": "github-username"
6058
}
6159
}
6260
```
@@ -86,7 +84,7 @@ Below are some examples for the given record types:
8684
```json
8785
{
8886
"record": {
89-
"CNAME": "<github-username>.github.io"
87+
"CNAME": "github-username.github.io"
9088
}
9189
}
9290
```

src/docs/github-pages-verification/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ Create a JSON file inside the `domains/` directory called `domains/hostname.json
2929
```json
3030
{
3131
"owner": {
32-
"username": "<github-username>",
33-
"email": "<email@address>"
32+
"username": "github-username"
3433
},
3534
"record": {
3635
"TXT": ["<github-verification-string>"]

src/docs/github-pages/index.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,11 @@ First, you'll need to create a site on GitHub Pages. Follow the instructions in
1010
Create a JSON file inside `domains` directory (`domains/<subdomain>.json`) with the following content and submit a pull request:
1111
```json
1212
{
13-
"description": "Describe the use of this subdomain",
14-
"repo": "https://github.com/<github-username>/<github-repository>",
1513
"owner": {
16-
"username": "<github-username>",
17-
"email": "<email@address>",
18-
"twitter": "<twitter-username>"
14+
"username": "github-username"
1915
},
2016
"record": {
21-
"CNAME": "<github-username>.github.io"
17+
"CNAME": "github-username.github.io"
2218
}
2319
}
2420
```

src/docs/netlify/index.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,8 @@ First, you'll need to create a site on Netlify. Follow the instructions in the [
99
Create a JSON file inside the `domains` directory (`domains/<subdomain>.json`) with the following content and submit a pull request:
1010
```json
1111
{
12-
"description": "Describe the use of this subdomain",
13-
"repo": "https://github.com/<github-username>/<github-repository>",
1412
"owner": {
15-
"username": "<github-username>",
16-
"email": "<email@address>",
17-
"twitter": "<twitter-username>"
13+
"username": "github-username"
1814
},
1915
"record": {
2016
"A": [

src/docs/render/index.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,8 @@ First, you'll need to create a service on Render. Follow the instructions in the
99
Create a JSON file inside the `domains` directory (`domains/<subdomain>.json`) with the following content and submit a pull request:
1010
```json
1111
{
12-
"description": "Describe the use of this subdomain",
13-
"repo": "https://github.com/<github-username>/<github-repository>",
1412
"owner": {
15-
"username": "<github-username>",
16-
"email": "<email@address>",
17-
"twitter": "<twitter-username>"
13+
"username": "github-username"
1814
},
1915
"record": {
2016
"A": [

src/docs/replit/index.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,7 @@ Create a JSON file inside `domains` directory (`domains/<subdomain>.json`) and s
1818
```json
1919
{
2020
"owner": {
21-
"username": "<github-username>",
22-
"email": "<email@address>",
23-
"twitter": "<twitter-username>"
21+
"username": "github-username"
2422
},
2523
"record": {
2624
"A": ["<IP here, listed on the A Record>"],

src/docs/vercel/index.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,7 @@ When connecting the domain, you will be greeted with a TXT verification string.
1515
```json
1616
{
1717
"owner": {
18-
"username": "insert-github-username-here",
19-
"email": "",
20-
"discord": "insert-discord-user-ID-here"
18+
"username": "insert-github-username-here"
2119
},
2220
"record": {
2321
"TXT": ["insert-TXT-string-you-got-from-vercel-here"]
@@ -35,9 +33,7 @@ Make `subdomain.json` in the **domains directory** (replace subdomain with the d
3533
```json
3634
{
3735
"owner": {
38-
"username": "insert-github-username-here",
39-
"email": "",
40-
"discord": "insert-discord-user-ID-here"
36+
"username": "insert-github-username-here"
4137
},
4238
"record": {
4339
"CNAME": "domainname.vercel.app"
@@ -48,9 +44,7 @@ Make `subdomain.json` in the **domains directory** (replace subdomain with the d
4844
```json
4945
{
5046
"owner": {
51-
"username": "insert-github-username-here",
52-
"email": "",
53-
"discord": "insert-discord-user-ID-here"
47+
"username": "insert-github-username-here"
5448
},
5549
"record": {
5650
"A": ["76.76.21.21"]

0 commit comments

Comments
 (0)