-
Notifications
You must be signed in to change notification settings - Fork 4
Home
davewilks edited this page Mar 10, 2017
·
17 revisions
Welcome to the Devportal wiki!
- 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.
- Talk to the reader, don't refer to them as a third party to the docs. Go ahead and say "you can..."
- Use active voice. It's harder to read and understand. make it clear who is acting on what.
- Do write: "Cloud Elements designed the APIs to have predictable, straightforward URLs and to use HTTP response codes to indicate API errors."
- Do not write: "The APIs are designed to have predictable, straightforward URLs and to use HTTP response codes to indicate API errors."
- Be concise. Use short words and sentences. Avoid unnecessary modifiers.
- Be specific. Avoid vague language. Cut the fluff.
- Be consistent. We'll get there, but look around the topic you're writing or related topics and refer to the things the same way.
If you're new to Git or just want a referesher, 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 usegit 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.