Home

Welcome to the Devportal wiki!

Get Started with Devportal

• Install Homebrew.
  • Run /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  • See https://brew.sh/.
• Use Homebrew to install Ruby and NodeJS.
  • $ brew install ruby
  • $ brew install node
• Install Jekyll and all of its requirements (see the ReadMe).
• Install Atom .
• Install iTerm. https://www.iterm2.com/
• Set up SSH if you're using command line. https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/
• Clone repo.

Download the devportal repo Clone or download

Git Commands

If you're new to Git or just want a refresher, here are a few common and useful Git commands you'll use while working in the devportal repo.

• git branch to see what branches you have on your machine.
• git status to check the status of your current branch.
• git checkout <branchname> use to access your different branch. For example, you'll use git checkout master all the time to access the master branch.
• git pull origin master fetches changes in the repository and merges them.
• git branch <branchname> creates a new branch. Do this for every change you make and associate the branch name with the changes. For example, call it the name of the issue you're working (dev-446) or the area you're working in (formulas).
• git add -A adds your changes to the staging area of your branch. You still need to commit them, though.
• git commit -m "<message>" commits your changes to the branch.
• git push origin <branchname> sends your changes to repository where you can review and then create a pull request.
• git branch <branchname> -D deletes the branch.

Information Types Standards

Element Docs

Endpoint Setup

In general, follow this structure:

• Concept paragraph: To set up the BLAH endpoint, you need a developer account and an app.
• Note re: API docs. We need to point them to the vendor's API docs. Do that here: Vendor provides the most up-to-date setup instructions at hyperlink.
• Steps. Start with a stem sentence like "To set up the endpoint..." and then jump to the steps.

Use images lightly and make sure they tell a story.