Folder Structure Conventions & New "subdomain.json" Format

[fransallen]

This issue describes thedev.id's folder structure and contents in the "subdomain.json" file.

.
├── .github/
├── .gitignore
├── README.md
├── _headers
├── index.html
├── package.json
└── subdomains/
        ├── david.json
        ├── hadyan.json
        └── wildan.json

Content for david.json:

{
  "name*": "The name of the personal site",
  "description*": "Short description for the site.",
  "owner*": {
    "username*": "lakuapik",
    "email*": "[email protected]",
    "bio": "David is Lorem, ipsum dolor sit amet consectetur adipisicing elit. Tempora, qui beatae dicta vel, eaque, harum ex cumque quo dolore quam placeat asperiores. Ab quos laudantium in, reprehenderit facilis numquam consectetur.",
    "social": {
      "twitter": "lakuapik"
    }
  },
  "repo*": "https://github.com/lakuapik/david.thedev.id",
  "records*": {
    "CNAME*": "lakuapik.github.io"
  }
}

Note: keys marked with * are required.

[lakuapik]

@fransallen is the json key all required? what if there are some people who dont put their portfolio in a public repo? could you please mark the required key with a * symbol?

{
  "name*": "Bla bla bla"
}

[fransallen]

Not all are required, but we can write documentation for which keys are required. I'm still not sure if using * (the wildcard sign) is common practice as we'll also be using it for DNS Synchronization. We should keep the JSON file clean.

[lakuapik]

i mean, the * will not be added to the key, just note for us 😅

[fransallen]

Oops, updated! 😆

[wdhdev]

I was thinking maybe the folder is called domains and this would be the format:

{
  "repo": "https://github.com/lakuapik/david.thedev.id",
  "description": "Short description for the site.",
  "owner": {
    "username": "lakuapik",
    "email": "[email protected]"
  },
  "records": {
    "CNAME": "lakuapik.github.io"
  }
}

And also offer A and TXT records.