Site

This is the upcoming Hanakai website. It’s still a work in progress.

Organizing development

We track our development entirely using issues on this repo. Orgnize your issues according to these main issue labels: area/backend, area/design and area/content.

For the site’s initial launch, we’re tracking our work in this project board.

Setup

Make sure you have Ruby and Node.js installed. See .tool-versions for expected versions. Feel free to use your own preferred version manager.

Then, to set up the site:

$ bin/setup

To see common commands for operating the site:

$ bin/setup help

Working on guides

Creating an unlisted version

An unlisted guide version is published at its own URL, but the site does not show it in guide lists or version pickers. It is also not used as the latest version. Use this to prepare a new guide version before you announce it.

How you unlist a version depends on how its guides are versioned.

Org-versioned guides

Hanami and Rom version all their guides together, in folders like content/guides/hanami/v3.0/. To unlist all the guides for a version, add unlisted: true to inside that version's guides.yml:

# content/guides/hanami/v3.0/guides.yml
unlisted: true
guides:
  - slug: getting-started
    # ...

Self-versioned guides

The Dry guides are versioned on their own, in folders like content/guides/dry/dry-schema/v1.17/. To unlist one version of one guide, add a guide.yml file to that version's folder:

# content/guides/dry/dry-schema/v1.17/guide.yml
unlisted: true

If you unlist every version of a guide, that guide does not show in the org's guide list.

Unversioned guides

Guides with no version folders (such as content/guides/dry/getting-started/) cannot be unlisted.