README.md

DNSimple Help Site

This is the DNSimple Help site built with nanoc

Setup

1. Clone this repository
2. Run asdf install
3. Run bundle install
4. Start your local instance with rake run

The site will be visible at localhost:3000.

Development

Use rake run to start the site. The server will automatically re-compiles changed files.

Deployment

Each commit to main is deployed automatically via Netlify.

Managing categories

You can add/remove/edit categories by editing the file priorities/categories.yaml.

Once you are done, run rake run to see your changes

Sub-categories

You can group and order articles in sub-categories by editing the corresponding YAML file in the categories folder. Articles that are not added to a YAML file, will be automatically grouped in a "Other" sub-category.

Once you are done, run rake run to see your changes.

Contributing

Follow the SOP for Support Article Creation & Updates. Draft all new articles and any substantial updates in Google docs prior to creating a PR.

When submitting a pull request, apply the label articles and set yourself as assignee.

Once all approvals are given and the pipeline is green, merge the PR yourself and delete the source branch.

Support writing guidelines

Reference our support writing guidelines, here.