01 Getting started on GitHub and Federalist - 18F/federalist-jekyll-netlify-cms-guides GitHub Wiki
You’ll need access to two systems — GitHub and Federalist — before you can manage ChildCare.gov content on the Federalist platform.
GitHub access
- Create a GitHub account if you don’t already have one.
- Enable two-factor authentication on your GitHub account.
- Send your GitHub username to [email of ChildCare.gov contact] and request access to the [name of GitHub repository] if you don’t already have access, and request access to the ChildCare.gov repository.
- Note for content managers: Make sure you have
write access
to the repository. A developer with admin access can add you to the repository once you are added to the GitHub HHS organization. - Note for developers: You must have
push access
to merge changes to the site, which means you need at leastwrite access
. When you encounter an action you need to do but can't do with write access, you may need to bump up your role to have more privileges (such as toadmin access
). - You will receive an invitation email from GitHub. Once you accept, you can be added to Federalist.
Managing GitHub access for members
- You can manage permissions at https://github.com/HHS/childcare-gov/settings/access
- See https://github.com/HHS/childcare-gov/settings/role_details for role descriptions.
- Here's a GitHub resource on how to manage teams and people with access to your repository.
Federalist and Netlify CMS access
Once you have GitHub access, send an email to the Federalist support team ([email protected]) with the following information:
Subject: Requesting Federalist access to childcare-gov Name: Your name Email: Your email GitHub: Your GitHub username Requested group: federalist-users
Once you receive the invitation email from Federalist and accept it, you should be able to log in to Netlify Content Management System (CMS), which is the built-in CMS for the Federalist platform: beta.childcare.gov/admin
GitHub oAuth process
To avoid having trouble logging in to Netlify CMS, you must also complete the GitHub oAuth process which authorizes Federalist.
- Go to https://federalistapp.18f.gov/
- Click the button Agree and continue with GitHub.
- This will redirect you to GitHub to sign in and authorize Federalist. You can then sign into Federalist as well as the Netlify CMS system.