Edit Cashmere locally and publish to Github | Scribe

    Edit Cashmere locally and publish to Github

    • Heather Bloyer |
    • 28 steps |
    • 7 minutes

      Sync with the Cashmere project (the dev branch) on Github

      1

      First, let's set the Cashmere project dev branch as your "upstream" branch. Your "origin" branch will be your forked dev branch (the one that you cloned).

      2

      In VS Code, click the plus sign to open a terminal (in addition to the one you opened to run "npm start").

      3

      Next, we'll copy the url to the main Cashmere project. Navigate to [https://github.com/HealthCatalyst/Fabric.Cashmere](https://github.com/HealthCatalyst/Fabric.Cashmere) Click "Code" Click the copy icon to copy the url for the code.

      Next, we'll copy the url to the main Cashmere project. Navigate to [https://github.com/HealthCatalyst/Fabric.Cashmere](https://github.com/HealthCatalyst/Fabric.Cashmere) Click "Code" Click the copy icon to copy the url for the code.
      4

      Back in VS Code, click into the new terminal you just added.

      5

      Type "git remote add upstream". Then press [[ctrl]] + [[v]] to paste the url you just copied from the Cashmere GitHub project. Press [[enter]].

      6

      Type "git remote -v [[enter]]" to verify that your upstream and origin branches are correct. Your upstream branch should be the dev branch in the main Cashmere project and your origin branch should be the dev branch in your fork.

      7

      Type "git fetch upstream [[enter]]". This will pull down the current upstream branch with any changes that you need to sync.

      8

      Type "git merge upstream/dev [[enter]]". This will merge changes from the upstream branch into your local branch.

      9

      Check if there are any changes to push to your origin branch. If the number beside the up arrow is greater than zero, click it to push the changes to your fork on Github.

      10

      Click OK to approve the push.

      Edit content files

      11

      Now you can make your content edits. Let's a edit a markdown file in guides for example. Click to expand /guides.

      12

      Open a content file (e.g., a markdown file). Here we'll add the word "items" in /references.md. Then click File > Save or press [[ctrl]] + [[s]] to save your changes.

      Open a content file (e.g., a markdown file). Here we'll add the word "items" in /references.md. Then click File > Save or press [[ctrl]] + [[s]] to save your changes.
      13

      When you're done making your changes and saving them, you can commit them to your local branch. Click the version control icon.

      14

      Click the plus sign to stage your changes (get them ready to commit).

      15

      Click in the Message field to type your commit message. Use the Cashmere format for commit messages or the commit won't work.

      information ordinal icon

      Tip! Follow the Cashmere commit format described here: [https://cashmere.healthcatalyst.net/web/guides/contribution-guide](https://cashmere.healthcatalyst.net/web/guides/contribution-guide)

      16

      For our example, we'll use this commit message to indicate we made a change to the docs (not any components), and the references doc specifically, where we updated the content: "docs(references): update content" Then press [[enter]].

      17

      For our example, we'll use this commit message to indicate we made a change to the docs (not any components), and the references doc specifically, where we updated the content: "docs(references): update content" Press [[enter]]. "update content in reference article".