Home

Each of the branches doc, bashful, dopey, grumpy, happy, sneezy, and sleepy get automatically (re-)deployed to a corresponding test site at <branch-name>.docs.materialsproject.org so that the updates of that branch can be visually reviewed.

Secure one of these auto-deployed branches by adding your name to a table row below. If you no longer need one of these branches (e.g. your work has been merged to master), remove your name. If there are no empty slots, ask someone if they can give up their branch to you.

Once you've socially secured a branch (your name is in the table below),

git remote add mp [email protected]:materialsproject/docs.git

from the root directory of your fork of this repository. At this point, the result of the command

git remote -v

should include the lines (in any order)

mp	[email protected]:materialsproject/docs.git (fetch)
mp	[email protected]:materialsproject/docs.git (push)
origin	[email protected]:<your-username>/docs.git (fetch)
origin	[email protected]:<your-username>/docs.git (push)

Once this is done, you can

git fetch --all

to fetch the latest versions of every branch of each tracked repository ("remote") -- mp and your fork, origin. Finally, what you want to do is check out a local branch with your chosen name and set it's remote to be mp:

git checkout -b <dwarf-name>
# The below may fail (if `mp/<dwarf-name>` does not exist yet) but should give helpful hints.
git branch --set-upstream-to mp/<dwarf-name>

Ensure your local branch is consistent with mp/master

git merge mp/master

and, when you are ready to push and inspect changes at ..docs.materialsproject.org,

git push

(only members of the docs team can push to mp branches) and me sure to create a Pull Request against this branch when you'd like feedback. Put "WIP: " at the beginning of the Pull Request subject if you don't think it's ready to be merged yet ("WIP" -> "work in progress").

branch	preview	user
doc	doc.docs.materialsproject.org	Donny
bashful	bashful.docs.materialsproject.org
dopey	dopey.docs.materialsproject.org	Kyle
grumpy	grumpy.docs.materialsproject.org
happy	happy.docs.materialsproject.org	Jordan
sneezy	sneezy.docs.materialsproject.org	Alex
sleepy	sleepy.docs.materialsproject.org	Oxana