The-Balance-FFXIV / balance-static

Rendered guide(s) at your fingertips

Home Page:https://www.thebalanceffxiv.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[Calli's records] Shit shouldn't be in exampleSite

zorianak opened this issue · comments

Our configurations should be in a /configurations/ folder, not under exampleSite - exampleSite looks (from a dev perspective) as though it's literally that - an example from creating the initial site.

This will make it much harder for us to onboard new devs. Making a milestone/ticket to track refactoring this once more pressing bugs are figured out.

@zorianak what configuration is under exampleSite currently?

There's some problems with this issue and it probably should be closed:

  1. this is likely referring to glam and not this repo
  2. exampleSite is the convention with hugo themes so you can preview the theme without having to conflate production content and theme in the same repo. You can find plenty of examples on the hugo themes site. Examples:
    1. hugo-pacman-theme
    2. materialize-bp-hugo-theme
    3. strange-case
  3. If you are putting production data in the theme's exampleSite directory, I would encourage you to not do that.

Onboarding devs should be as straightforward as having them read the following documentation and to submit issues for the things which aren't clear (which should be documented in the wiki for glam or this repo, as appropriate):

  1. hugo docs
  2. tailwind docs
  3. netlify's github documentation

Closed per above response.