Skip to content

Commit

Permalink
Update 2.0_introduction.md
Browse files Browse the repository at this point in the history 
updating with steps from training, yet to finish
  • Loading branch information
@ljmoody
ljmoody authored Nov 14, 2023
1 parent 08713bb commit 0c462dc
Showing 1 changed file with 72 additions and 10 deletions.
82 changes: 72 additions & 10 deletions 2.0_introduction.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,82 @@ Welcome to the *Modeling to Learn* for learners, facilitators, and administrator

![](https://user-images.githubusercontent.com/59668647/117360089-35126b80-ae6d-11eb-8472-f4ea154f4401.png)

## Improve the Modeling to Learn Repo via a Pull Request and Quality Assurance
## Improve the _Modeling to Learn_ Repo by Using GitHub

- **Value Stream:** Operations
- **Workstream:** PeopleOps
- **Workflow:** facilitate_workflow
- **MTL 2.4** [Video: improve_mtl.how_pull_request_qa](https://dvagov.sharepoint.com/sites/mtl_facilitators/Shared%20Documents/General/Recordings/improve_mtl.how_pull_request_qa-20220520_100755-Meeting%20Recording.mp4?web=1)

### Summary

**This video reviews how to update [mtl.how](https://mtl.how) via a GitHub pull request**
Dr. Zimmerman and Mushiana review and post the updated _MTL 3.0_ Facilitator Fidelity Guides for the PARTNER phase to the _MTL Blue_ s01-s04 faciliator folders.

### Improve mtl.how including quality assurance (QA)

- [**Video**](https://dvagov.sharepoint.com/:v:/r/sites/mtl_facilitators/Shared%20Documents/General/Recordings/improve_mtl.how_pull_request_qa-20220520_100755-Meeting%20Recording.mp4?csf=1&web=1&e=ytTGsb) - watch to learn how to improve the _Modeling to Learn_ 3.0 manual resources at mtl.how. Dr. Zimmerman and Mushiana review and post the updated _MTL 3.0_ Facilitator Fidelity guides for the PARTNER phase to the _MTL Blue_ s01-s04 facilitator folders. Recorded 5/2022.
- [**Video: Essential Team PSD GitHub Skills**](https://dvagov.sharepoint.com/:v:/r/sites/teampsd_vha/Shared%20Documents/training_workgroup/Recordings/Essential%20Team%20PSD%20GitHub%20Skills.mp4?csf=1&web=1&e=OxarJe) - To navigate to specific points within this video, click the Chapters button on the right-hand side of the playback screen. Different subject start times are bookmarked so you can go directly to the content of interest. Recorded 11/2023.
- [**Video: Back out a merged branch (revert)**](https://dvagov.sharepoint.com/:v:/r/sites/teampsd_vha/Shared%20Documents/training_workgroup/Recordings/Back%20out%20a%20merged%20branch%20(revert).mp4?csf=1&web=1&e=Tycq8t) - Recorded 11/2023.

[Teams Channel Link](https://teams.microsoft.com/l/message/19:d15133fbfb4d4c3a8c81701292b1890d@thread.skype/1698981795459?tenantId=e95f1b23-abaf-45ee-821d-b7ab251ab3bf&groupId=1db500d5-0d01-4254-af42-ad3f78bafacd&parentMessageId=1649964786347&teamName=teampsd_vha&channelName=training_workflow&createdTime=1698981795459&allowXTenantAccess=false) - from training_workflow, 11/2/23.

[Teams Channel Link](https://teams.microsoft.com/l/message/19:d15133fbfb4d4c3a8c81701292b1890d@thread.skype/1653587134006?tenantId=e95f1b23-abaf-45ee-821d-b7ab251ab3bf&groupId=1db500d5-0d01-4254-af42-ad3f78bafacd&parentMessageId=1653587134006&teamName=teampsd_vha&channelName=training_workflow&createdTime=1653587134006&allowXTenantAccess=false) - from training_workflow, 5/26/22.

[Teams Channel Link](https://teams.microsoft.com/l/message/19:GfgKfM5quJ4bImMfd0UTxe_7ybS0s6snw0H_obeutPU1@thread.tacv2/1653060621160?tenantId=e95f1b23-abaf-45ee-821d-b7ab251ab3bf&groupId=0c7e85d9-b526-4276-8b29-c7f15c9b2613&parentMessageId=1653060621160&teamName=mtl_facilitate&channelName=General&createdTime=1653060621160) - from mtl_facilitate > general, 5/20/22.

### Contribute to the _MTL_ Repo and Manual

**Note:** You must have an activated GitHub account before making contributions. If you do not have a GitHub account, follow these instructions:

1. Use [this YourIT link](https://yourit.va.gov/va?sys_kb_id=ac83cb5d1be87d14018220a5624bcb41&id=kb_article_view&sysparm_rank=1&sysparm_tsqueryId=420cec1687823914e99f77f5cebb35bd) for comprehensive GitHub account access instructions.
2. When you receive a GitHub organization or repo invitation, [accept it](https://yourit.va.gov/va?sys_kb_id=ed13eadf1b41b19467556242604bcbcb&id=kb_article_view&sysparm_rank=3&sysparm_tsqueryId=420cec1687823914e99f77f5cebb35bd).
3. Lindsey must invite you to be a collaborator and you must accept the invitation (via the same email account you’ve linked to GitHub) before any contributions can be made.

Once you have an activated GitHub account, you can contribute to the _MTL_ Repo and Manual.

1. Navigate to mtl.how.
2. Click the master branch drop-down menu.
3. In the “Find or create a branch…” field, type in the name of this new branch using this naming convention: feature-(meaningful_name).
- Example: feature-s02_partner_fidelity
- **Note:** Typing “feature-“ at the beginning of the branch name will cause linter actions to fire when committing the file (including checks for Markdown editorial rules, broken links, APA style adherence, and spelling).
- Congratulations! You’ve just made your own feature branch, where you can make your modifications, additions, and deletions.
4. Navigate to and click on the file you want to modify within the feature branch you just created.
5. Select the pencil icon (hover text: Edit this file) button.
6. Modify the file content.
- Edit file tab (pencil icon): this is where you need to be to actively edit the code, play with formatting, etc.
- Preview tab: displays what code will look like when published.
- Manual files are written in Markdown, a light (i.e., simple) formatting language. Below are some examples of the syntax used for basic formatting in the manual. For more markdown formatting information, go to: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax or Google it.

| Element | Markdown Syntax |
| ------- | ------- |
| Headings | #, ##, ###, ####, #####, ###### |
| Bold | ** before and after text you want boldfaced |
| Italic | _ before and after text you want italicized |
| Bold + Italic | **_ before and after text you want boldfaced and italitized |
| Blockquote | > |
| Ordered List | begin line with "1.", then a space, then your numbered item text, continue list by pressing Enter |
| Unordered List | begin line with "-", then a space, then your bullet item text, continue list by pressing Enter |
| Code | ` before and after text you want to appear as code |
| Horizontal Rule | --- |

7. Commit your file when you are done working on it by clicking the green Commit changes… button.
- In the Commit message field, give a brief description of your modifications (e.g., “Copied the X file into Y.” or “Added information about…something or other.”).
- Use the Extended description field if needed to provide further or detailed information about your modifications.
- **Notes:**
- When you “commit” a file, you are recording changes to one or more files in your branch. Each commit is assigned a unique ID that identifies the specific changes that were made, when they were made, and who created the changes.
- Don’t be afraid! You’ve just committed the new file to your newly created branch. Also, nobody can "break" things in GitHub; changes can always be reverted.
- Do not leave your uncommitted modified markdown file overnight. Until you have committed it, there is no cloud saving and no backup. If your VPN/VA connection is lost and you have not saved, you will lose all your work in this file.

### Create a Pull Request

1. Navigate to the Pull requests tab within GitHub.
2. Click the green New pull request button.
3. In the compare: drop-down menu, select the branch you have been modifying.
4. In the base: drop-down menu, select master.
- **Note:** While this may seem strange, you are “pulling” the changes from the right to the left. The arrow between the two fields is a good reminder of this..
- This means you are requesting information to be pulled into the master branch from the feature branch you created.
- As you scroll down, you can see red and green highlighted information; red = deletions, green = additions.

5. Click the green Create pull request button.
6. A review page will appear where you can:
- Add a short summary of the changes between your feature branch and the repo’s base branch.
- Review the changes made by commits.
- Add Pipelines, Reviewe/rs, Assignee/s (usually you, the one making changes), Label/s, Project/s, Milestone/s, and Estimate (story points).


---
1. Navigate to https://mtl.how via your browser.
2. *Switch from the Master branch to the QA branch - *Need a free GitHub account to contribute
3. Create a feature branch via a pull request from the qa branch
Expand Down

0 comments on commit 0c462dc

Please sign in to comment.