Skip to content
Provides the data consumed via Origami Navigation Service
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github
data
src
test
.eslintignore
.eslintrc.js
.gitignore
Makefile
README.md
origami.json
package-lock.json
package.json

README.md

Origami Navigation Service Data

Provides the data consumed via origami-navigation-service.

Build status MIT licensed

Table Of Contents

How to edit navigation data

The navigation data is written in YAML and can be edited via the Github edit tool.

Steps to edit navigation data:

  • Open the navigation data file in the Github edit tool
  • Make the necessary changes
  • Press the "Commit changes" button
  • Add a comment which explains what you are changing and why
  • Press the "Create pull request" button
  • Someone from Origami will review your changes before merging them into production

Requirements

Running Origami Navigation Service Data requires Node.js 6.x and npm.

Running Locally

Configuration

Operational Documentation

The source documentation for the runbook is stored in the operational-documentation folder. This is pushed to CMDB upon every promotion to production. You can push them to CMDB manually by running the following command:

make update-cmdb

Testing

The tests are split into unit tests and integration tests. To run tests on your machine you'll need to install Node.js and run make install. Then you can run the following commands:

make test              # run all the tests
make test-unit         # run the unit tests
make test-integration  # run the integration tests

You can run the unit tests with coverage reporting, which expects 90% coverage or more:

make test-unit-coverage verify-coverage

The code will also need to pass linting on CI, you can run the linter locally with:

make verify

We run the tests and linter on CI, you can view results on CircleCI. make test and make lint must pass before we merge a pull request.

Deployment

The production (EU/US) data is stored on AWS S3. We deploy continuously to production via CircleCI, you should never need to deploy manually.

Monitoring

Trouble-Shooting

License

The Financial Times has published this software under the MIT license.

You can’t perform that action at this time.