search

microbiomedata / docs

User-facing, web-based documentation about the NMDC
https://docs.microbiomedata.org
0 stars 0 forks source link

Testing - Intermediate Workflow to edit 1+ file(s) #43

Closed ssarrafan closed 1 day ago

ssarrafan commented 1 day ago

This is the issue I'm creating to be able to test the instructions at https://github.com/microbiomedata/docs?tab=readme-ov-file#maintenance.

This issue is to test the intermediate workflow:

Intermediate workflow (to edit 1+ files) Create a GitHub Issue describing what you want to change (e.g. "Fix Foo in Bar") Visit https://github.dev/microbiomedata/docs/ Click the branch name (e.g. main) at the lower left Click "Create a new branch..." at the top Enter a name for the branch, beginning with an issue number (e.g. 123-fix-foo-in-bar) (If prompted) Click "Switch to Branch" Make changes in ./content/nmdc/src Click the "Source Control" icon in the left sidebar (3rd from the top) Hover over the "Changes" heading and click the + icon that appears Enter a commit message to tell others what you did (e.g. "Fix typo in link") Click the "Commit & Push" button Visit https://github.com/microbiomedata/docs/ and create a Pull Request for that branch You will end up with a Pull Request (PR) containing the changes. Once the PR gets merged into main, the documentation website will automatically be updated to reflect the changes.

ssarrafan commented 1 day ago

I was able to complete all the steps in this workflow successfully. See PR ttps://github.com/microbiomedata/docs/pull/44