Documentation for the resin.io platform.
CSS HTML JavaScript CoffeeScript Shell Makefile
Switch branches/tags
Clone or download
resin-io-versionbot[bot] Auto-merge for PR #850 via VersionBot
Update supported cellular modem list
Latest commit 3cce043 Jul 18, 2018

README.md

Resin.io Documentation

Build status

Join our forums, or online chat at Gitter chat

Documentation for the resin.io platform.

Role

The intention of this repo is to provide our public-facing documentation.

Running locally

To run the docs web application locally you should do the following:

git clone https://github.com/resin-io/docs
cd docs
npm install
npm start

And then open http://localhost:3000.

How to Contribute

If you think something is not documented, or can be improved, don't hesitate in sending a PR!

Deploying

After a PR has been created, a member of the resin team will review and merge into master.

Shortly after merging to master it'll automatically be deployed to our staging environment (This should only take a few minutes).

Once deployed to staging, we will preview your changes. If everything looks good, a member of the resin team will make another PR from master into the production branch. When this is merged, the changes will automatically deploy to production

Style manual

Default style manual: (TBD)

Resin-specific words

For all, lower-case capitalization unless beginning a sentence (Ex. I like resin.io. Resin.io is great.)

  • resin.io
  • etcher
  • resinOS (note the capitalization of OS)
  • resin (used to refer to the company as a whole, not in place of resin.io or resinOS)

Conventions

  • Notes/Warnings are formatted using CSS. Use the following syntax to make sure it's rendered correctly: __Note:__

Get Setup

git clone https://github.com/resin-io/docs.git
cd docs
npm install

Now to check that everything is working correctly, start the local server with:

npm start

You should now see the docs served from localhost:3000

To add you changes to the docs, create a new local branch of master:

git checkout -b my-docs-patch

Now you can make changes in this branch. Since our docs are static pages generated from markdown using metalsmith.io, each time you change some of the .md files you will need to run rebuild of the docs to generate the static pages. This is done by running:

./tools/prepare.sh

However there is a handy watch functionality that will watch for changes in /pages, /shared, and /templates and rebuild each time you save your changes. To use this, open a new tab in you terminal and run:

npm run watch-pages

Once you are happy with your changes, submit a pull request for you branch against master.

Note that you have to restart the development server if you edit other things like redirects.txt.

Using Partials

When creating new content or altering current pages, its recommended that you try keep things D.R.Y (Don’t Repeat Yourself). This is made easy by using “partials”. If you look in the /shared folder you will see a number of folders, these keep snippets or partials of the docs that can be reused all over the place. They also allow you to cleverly override a partial for a particular board type and language type. So in general you will see most of them just contain a _default.md which means that this partial will be used for all board and language types, but for partials like getDeviceOnDash we have device specific overrides.

├── getDeviceOnDash
│   ├── _default.md
│   ├── artik10.md
│   ├── artik5.md
│   ├── raspberrypi.md
│   ├── raspberrypi2.md
│   └── raspberrypi3.md

To use these partials in a markdown page all you need to do is add the following in the page:

{{ import “getDeviceOnDash” }}

and the engine will pull that partial into this location in the page.

Some other important bits

Its important to note that h1 and h2 headings will automatically be included in the left hand side navigation bar, so make sure to use these appropriately.

In the dynamically generated pages ( the ones with he device-type and language dropdown) it is possible to use templates to dynamically change the device name and language name in your text. Here is an example:

Getting started with {{ $device_details.name }} using {{ $language_details.name }}

To add additional dynamic properties, see the files in /config/dictionaries.

If you remove a page that may be linked to externally to the docs, remember to add it to the redirects.txt in the root of the docs, if you don’t, then links will break and people will have a bad time, m’kay.

If you need to add image assets, add them to the /static/img folder, either under common if these images are general to all of the devices or resin, otherwise add them to the specific device folder.

License

The project is licensed under the Apache 2.0 license.