Origami

Documentation site

New Origami starter guide

Welcome to Origami!

Things to do

The checklist assumes that you have done the following:

  1. Visited IT Service Desk (ITSD) to get your computer account up and running.
  2. Logged on your own work machine and email account.

Admin privileges on your machine

ITSD should have done admin privileges for you and your machine when they did the setup. If not, then search for the “Account Amendment/Administration” form at selfservice.ft.com.

Include your desk number (which is usually a label on your desk) and the machine number with the email. You also will need to say why you need admin privileges, or copy the template below and edit to suit the situation.

Dear IT Service Desk,

I am a new starter within the Origami team, as a <your job title>. I would like to have admin privileges on <machine number> which is at <desk number>.

I need to be able to install software like node.js, <your preferred text editor> & <add more if you like>.

I look forward to hearing back from you on this matter.

Thanks

<your name>

This should hurry your request for admin privileges on your machine. You may email ITSD directly at itservicedesk@ft.com with any queries.

Slack

  1. Install Slack (You can do this without admin privileges).

    To install software without having admin privileges. You can access the Self Service application by finding it on your machine. Log in with your network details, and do a search for the Slack app and install. This is the same with browsers like Google Chrome or Mozilla Firefox. You will need to be on the FT LAN for this to work.

  2. The Slack domain for FT is financialtimes. Log into the domain with your FT email address.

  3. Join the #ft-origami channel, then ask the team to add you to the internal channels.

  4. Ask to be added to the @origami-team notifications handle.

A notice about @channel and @here Slack has a feature whereby you can alert everyone in the channel about something you want them to read. This can be very useful where something is incredibly important and needs an immediate response. In a lot of channels, there are more than 100 people in the channel, and notifying all of them about something is a bit inconsiderate unless it’s an emergency. Please bear this in mind when using this feature. In emergencies, you can use this feature by typing @here (for everyone who is logged in) or @channel (is for even people who are not logged in).

Code repositories

  1. Origami repositories are at GitHub/Financial-Times on GitHub. They should be public if at all possible. Further repositories can be found on BitBucket, these are private and archived.

  2. Ask the Origami team for access to the following:
    • The GitHub organisation Financial-Times.
    • The origami-core & origami-colloborators on the GitHub organisation’s teams.
    • Granted admin access to BitBucket. (optional)
  3. If you haven’t done so already, please set up 2-factor authentication for GitHub.

  4. If you are using SSH, then don’t forget to generate new keys, and add to your GitHub account.

LastPass

The FT uses LastPass for managing passwords etc. Follow the security guide to setup your Enterprise LastPass account (ask itservicedesk@ft.com if you have any problems). Then ask a member of the team to add you to the Shared-origami folder as an administrator.

Other tools

Ask the Origami team for access to:

  • Sentry
  • Pingdom (optional)
  • Heroku
    • Set up a Heroku account with your FT.com email address (Please enable 2FA).

Two Factor Authentication

You will need to add 2FA for the following:

  • Work email
  • GitHub
  • Heroku
  • LastPass

It is a good idea to add an app on your phone for 2FA or configure it to send SMS messages with codes. There are options for apps like Authy (App Store / Google Play) or Google Authenticator. (App Store / Google Play)

FT.com

Check your email to see if you’ve registered for the free subscription to ft.com. If not, sign-up for an account on ft.com and ask corporate.support@ft.com to upgrade it.

Development tools

Environment setup

Before anything gets installed on your machine. It is a good idea to ensure that npm has permissions to install globally.

chown -R $USER /usr/local

Almost all Origami applications rely on the following tools to be installed globally on development machines. Please ensure that you install the software in your development environment first.

Install the following:

Work with our ecosystem of components

You will need to point Bower at the Origami registry. Running the following in a CLI will do this for you.

[ -e ~/.bowerrc ] || echo '{ "registry": { "search": [ "http://registry.origami.ft.com", "https://bower.herokuapp.com" ] } }' > ~/.bowerrc

You can join all the Origami applications on Heroku by checking out this shared Google Sheets. You will need one other person from the Origami team to add you.

Issues with installing/getting access

If you experience any problems, then please take a look at Next’s troubleshooting guide. If your problem is not included in the troubleshooting guide and you manage to solve it, then add it to the list.

Peer review and pull requests

All contributors to Origami must use Pull Requests. These should be peer-reviewed by one or more people before merging.

Here’s how it works

  1. Branch off of master: git branch my-great-feature
  2. [some coding / committing happens in the my-great-feature branch]
  3. Push those changes to GitHub / Stash: git push origin my-great-feature-branch
  4. Repeat 2 and 3 as much as you like
  5. When you’re ready, open a pull request. Tag people you’d like to review the request.
  6. Respond to review comments
  7. Either a reviewer will merge your request, or they will give you a thumbs-up for you to merge.

Using Origami

All documentation on how to use Origami is here: the tutorials and the documentation.