Workflow to update content locally

Full steps to get everything set up to run the site locally can be found here: https://github.com/IBM/design-system-website/wiki/Updating-content-on-carbondesignsystem.com

This is just the workflow once things are set up to let you update and view content changes locally with optional instructions if you need to work from a branch other than master as the base.

View site locally

• Open up VSCode
• Open up the website project
• [OPTIONAL] Switch to a11y-updates branch



• Open terminal
• Run yarn dev



• Open localhost:3000 to view website in browser

Make site updates locally

• Open VSCode
• Create new branch and name something that makes sense :)



• Make changes in content folder
• Reload browser to see changes

Commit Changes

Click on GitHub icon on side nav Add comments and click checkmark



Click “Yes”



Push Changes

Run git push from terminal
The first time you do this is will give you and error, just copy what it says and do it again. You should only have to do this the first time you push a change  


Open new pull request

• Go to GitHub in a browser
https://github.com/IBM/design-system-website/
• “New Pull Request” button
• Click “Compare across forks”
• Leave base fork default, and set the branch if needed
• Choose your fork to compare from and the new branch you created

• Add any comments you want describing the PR
• Click green “Create Pull Request” button