Skip to content
This repository has been archived by the owner on Apr 26, 2019. It is now read-only.

Workflow to update content locally

Alison Joseph edited this page Sep 18, 2018 · 4 revisions

Note: Full steps to fork the repo and install what you need to run the site locally can be found here: https://github.com/IBM/design-system-website/wiki/Updating-content-on-carbondesignsystem.com

View site locally

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

image

  • Open terminal
  • Run yarn dev

image

  • Open localhost:3000 to view website in browser

Make site updates locally

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

image

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

Commit Changes

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

image

Click “Yes”

image

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 image

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

image

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