From 2c4157b62fb921ee77e0079fae372d1e94643a08 Mon Sep 17 00:00:00 2001 From: Trevor Moy <51927676+trevmoy@users.noreply.github.com> Date: Tue, 24 Oct 2023 14:30:25 -0400 Subject: [PATCH 1/8] Update faq/syllabus.md --- faq/syllabus.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/faq/syllabus.md b/faq/syllabus.md index 4398208..b1c4de9 100644 --- a/faq/syllabus.md +++ b/faq/syllabus.md @@ -66,3 +66,17 @@ excerpts or screenshots embedded in it. They should be markdown files in your KWL repo. I recommend myst markdown. ``` +## Why won't my experience badge workflow contain the new changes after I edit the workflow? +```{toggle} +If you find that a workflow you may have made changes to are not properly reflecting your workflow changes is because you may not be running the workflow correctly. + +To correctly execute an action in GitHub you should: + +1. Make sure you are in the actions tab in your repository +2. On the left side of the screen the specific workflows should be available to select. +3. Select the desired workflow. +4. At the top of the workflow runs there should be an option to run the workflow. +5. Select Run Workflow to run the most recent and up to date workflow. + +This should help correct the workflow if it was causing issues. +``` \ No newline at end of file From 36c4eb5fa5351cd7dd127cee55dc1e131c85c73b Mon Sep 17 00:00:00 2001 From: Trevor Moy <51927676+trevmoy@users.noreply.github.com> Date: Tue, 24 Oct 2023 14:34:28 -0400 Subject: [PATCH 2/8] Update faq/syllabus.md --- faq/syllabus.md | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/faq/syllabus.md b/faq/syllabus.md index b1c4de9..4398208 100644 --- a/faq/syllabus.md +++ b/faq/syllabus.md @@ -66,17 +66,3 @@ excerpts or screenshots embedded in it. They should be markdown files in your KWL repo. I recommend myst markdown. ``` -## Why won't my experience badge workflow contain the new changes after I edit the workflow? -```{toggle} -If you find that a workflow you may have made changes to are not properly reflecting your workflow changes is because you may not be running the workflow correctly. - -To correctly execute an action in GitHub you should: - -1. Make sure you are in the actions tab in your repository -2. On the left side of the screen the specific workflows should be available to select. -3. Select the desired workflow. -4. At the top of the workflow runs there should be an option to run the workflow. -5. Select Run Workflow to run the most recent and up to date workflow. - -This should help correct the workflow if it was causing issues. -``` \ No newline at end of file From 3025ab77f142883556740e727168f95c2a69a0ca Mon Sep 17 00:00:00 2001 From: Trevor Moy <51927676+trevmoy@users.noreply.github.com> Date: Tue, 24 Oct 2023 14:36:37 -0400 Subject: [PATCH 3/8] Update faq/syllabus.md --- faq/syllabus.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/faq/syllabus.md b/faq/syllabus.md index 4398208..b1c4de9 100644 --- a/faq/syllabus.md +++ b/faq/syllabus.md @@ -66,3 +66,17 @@ excerpts or screenshots embedded in it. They should be markdown files in your KWL repo. I recommend myst markdown. ``` +## Why won't my experience badge workflow contain the new changes after I edit the workflow? +```{toggle} +If you find that a workflow you may have made changes to are not properly reflecting your workflow changes is because you may not be running the workflow correctly. + +To correctly execute an action in GitHub you should: + +1. Make sure you are in the actions tab in your repository +2. On the left side of the screen the specific workflows should be available to select. +3. Select the desired workflow. +4. At the top of the workflow runs there should be an option to run the workflow. +5. Select Run Workflow to run the most recent and up to date workflow. + +This should help correct the workflow if it was causing issues. +``` \ No newline at end of file From d1f5b914879165dae16c23945af709b0c642bb11 Mon Sep 17 00:00:00 2001 From: Trevor Moy <51927676+trevmoy@users.noreply.github.com> Date: Tue, 24 Oct 2023 14:47:04 -0400 Subject: [PATCH 4/8] Update faq/github.md, faq/syllabus.md --- faq/github.md | 15 +++++++++++++++ faq/syllabus.md | 15 --------------- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/faq/github.md b/faq/github.md index 04095c8..1c40972 100644 --- a/faq/github.md +++ b/faq/github.md @@ -199,3 +199,18 @@ If you have trouble, create an issue and tag `@@rhodyprog4ds/fall20instructors` ```` Doing each new assignment in its own branch is best practice. In a typical software development flow once the codebase is stable a new branch would be created for each new feature or patch. This analogy should help you build intuition for this GitHub flow and using branches. Also, pull requests are the best way for us to give you feedback. Also, if you create a branch when you do not need it, you can easily merge them after you are done, but it is hard to isolate things onto a branch if it's on main already. ```` + +## Why won't my experience badge workflow contain the new changes after I edit the workflow? +```{toggle} +If you find that a workflow you may have made changes to are not properly reflecting your workflow changes is because you may not be running the workflow correctly. + +To correctly execute an action in GitHub you should: + +1. Make sure you are in the actions tab in your repository +2. On the left side of the screen the specific workflows should be available to select. +3. Select the desired workflow. +4. At the top of the workflow runs there should be an option to run the workflow. +5. Select Run Workflow to run the most recent and up to date workflow. + +This should help correct the workflow if it was causing issues. +``` \ No newline at end of file diff --git a/faq/syllabus.md b/faq/syllabus.md index b1c4de9..f628d2b 100644 --- a/faq/syllabus.md +++ b/faq/syllabus.md @@ -65,18 +65,3 @@ excerpts or screenshots embedded in it. They should be markdown files in your KWL repo. I recommend myst markdown. ``` - -## Why won't my experience badge workflow contain the new changes after I edit the workflow? -```{toggle} -If you find that a workflow you may have made changes to are not properly reflecting your workflow changes is because you may not be running the workflow correctly. - -To correctly execute an action in GitHub you should: - -1. Make sure you are in the actions tab in your repository -2. On the left side of the screen the specific workflows should be available to select. -3. Select the desired workflow. -4. At the top of the workflow runs there should be an option to run the workflow. -5. Select Run Workflow to run the most recent and up to date workflow. - -This should help correct the workflow if it was causing issues. -``` \ No newline at end of file From c70c54e6e4687724fcb200e01b22fdc9f9c5239f Mon Sep 17 00:00:00 2001 From: Trevor Moy <51927676+trevmoy@users.noreply.github.com> Date: Thu, 26 Oct 2023 00:30:06 -0400 Subject: [PATCH 5/8] Update faq/github.md --- faq/github.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/faq/github.md b/faq/github.md index 1c40972..6b4e052 100644 --- a/faq/github.md +++ b/faq/github.md @@ -200,9 +200,9 @@ If you have trouble, create an issue and tag `@@rhodyprog4ds/fall20instructors` Doing each new assignment in its own branch is best practice. In a typical software development flow once the codebase is stable a new branch would be created for each new feature or patch. This analogy should help you build intuition for this GitHub flow and using branches. Also, pull requests are the best way for us to give you feedback. Also, if you create a branch when you do not need it, you can easily merge them after you are done, but it is hard to isolate things onto a branch if it's on main already. ```` -## Why won't my experience badge workflow contain the new changes after I edit the workflow? +## Why did my workflow not run correctly? ```{toggle} -If you find that a workflow you may have made changes to are not properly reflecting your workflow changes is because you may not be running the workflow correctly. +If you find that changes you made to a workflow are not taking effect, or you run a workflow and it seems to not work, you may not be running the workflow correctly. To correctly execute an action in GitHub you should: @@ -213,4 +213,6 @@ To correctly execute an action in GitHub you should: 5. Select Run Workflow to run the most recent and up to date workflow. This should help correct the workflow if it was causing issues. + +**note that clicking "re-run" on a previous run does *not* work** ``` \ No newline at end of file From 20d40aecc40942421da3722f08573817a97ffa33 Mon Sep 17 00:00:00 2001 From: Trevor Moy <51927676+trevmoy@users.noreply.github.com> Date: Thu, 26 Oct 2023 09:13:01 -0400 Subject: [PATCH 6/8] Updated faq/mermaid.md --- faq/mermaid_tutorial.md | 46 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 faq/mermaid_tutorial.md diff --git a/faq/mermaid_tutorial.md b/faq/mermaid_tutorial.md new file mode 100644 index 0000000..342a7c5 --- /dev/null +++ b/faq/mermaid_tutorial.md @@ -0,0 +1,46 @@ +# Mermaid Overview + +## What is Mermaid? + +[Mermaid](https://mermaid.js.org/intro/) is a flowchart and diagram visualization tool based on JavaScript and uses Markdown syntax to create flowcharts that are extremely dynamic and high quality. [Mermaid](https://mermaid.js.org/intro/) is especially useful because you are able to display your beautiful flowcharts using backticks to create a code block. + +## Tutorial for Using Mermaid + +Either on the [Mermaid](https://mermaid.js.org/intro/) website or within the **GitHub** markdown file that you're making edits to you can make complex flowcharts seamlessly. + +### Using Code Blocks + +A code block should look like the following: +```` +```mermaid +blah blah blah +``` +```` + +####Example Mermaid Code Block + +```mermaid +flowchart TD + A[Christmas] -->|Get money| B(Go shopping) + B --> C{Let me think} + C -->|One| D[Laptop] + C -->|Two| E[iPhone] + C -->|Three| F[fa:fa-car Car] +``` + +In Mermaid there are different styles for boxes with either square or round edges and the option to give a description of each item in its pipe. + +So the code above actually looks like this in it's code block: + +```` +```mermaid +flowchart TD + A[Christmas] -->|Get money| B(Go shopping) + B --> C{Let me think} + C -->|One| D[Laptop] + C -->|Two| E[iPhone] + C -->|Three| F[fa:fa-car Car] +``` +```` + +There's lots of cool and unique things that can be created using Mermaid and the best way to understand it better is to continue to practice. From 46b70afaa298b6387b8fcee0ae0ca7d1dc0da5f4 Mon Sep 17 00:00:00 2001 From: Trevor Moy <51927676+trevmoy@users.noreply.github.com> Date: Thu, 26 Oct 2023 12:28:39 -0400 Subject: [PATCH 7/8] Updated faq/mermaid_tutorial.md --- faq/mermaid_tutorial.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/faq/mermaid_tutorial.md b/faq/mermaid_tutorial.md index 342a7c5..71e7491 100644 --- a/faq/mermaid_tutorial.md +++ b/faq/mermaid_tutorial.md @@ -6,7 +6,7 @@ ## Tutorial for Using Mermaid -Either on the [Mermaid](https://mermaid.js.org/intro/) website or within the **GitHub** markdown file that you're making edits to you can make complex flowcharts seamlessly. +Either on the [Mermaid](https://mermaid.live/) website or within the **GitHub** markdown file that you're making edits to you can make complex flowcharts seamlessly. ### Using Code Blocks From a399d0fc3f42f5aa0b12d77caadf805d63ea975a Mon Sep 17 00:00:00 2001 From: Trevor Moy <51927676+trevmoy@users.noreply.github.com> Date: Thu, 26 Oct 2023 12:32:47 -0400 Subject: [PATCH 8/8] deleted faq/mermaid_tutorial.md --- faq/mermaid_tutorial.md | 46 ----------------------------------------- 1 file changed, 46 deletions(-) delete mode 100644 faq/mermaid_tutorial.md diff --git a/faq/mermaid_tutorial.md b/faq/mermaid_tutorial.md deleted file mode 100644 index 71e7491..0000000 --- a/faq/mermaid_tutorial.md +++ /dev/null @@ -1,46 +0,0 @@ -# Mermaid Overview - -## What is Mermaid? - -[Mermaid](https://mermaid.js.org/intro/) is a flowchart and diagram visualization tool based on JavaScript and uses Markdown syntax to create flowcharts that are extremely dynamic and high quality. [Mermaid](https://mermaid.js.org/intro/) is especially useful because you are able to display your beautiful flowcharts using backticks to create a code block. - -## Tutorial for Using Mermaid - -Either on the [Mermaid](https://mermaid.live/) website or within the **GitHub** markdown file that you're making edits to you can make complex flowcharts seamlessly. - -### Using Code Blocks - -A code block should look like the following: -```` -```mermaid -blah blah blah -``` -```` - -####Example Mermaid Code Block - -```mermaid -flowchart TD - A[Christmas] -->|Get money| B(Go shopping) - B --> C{Let me think} - C -->|One| D[Laptop] - C -->|Two| E[iPhone] - C -->|Three| F[fa:fa-car Car] -``` - -In Mermaid there are different styles for boxes with either square or round edges and the option to give a description of each item in its pipe. - -So the code above actually looks like this in it's code block: - -```` -```mermaid -flowchart TD - A[Christmas] -->|Get money| B(Go shopping) - B --> C{Let me think} - C -->|One| D[Laptop] - C -->|Two| E[iPhone] - C -->|Three| F[fa:fa-car Car] -``` -```` - -There's lots of cool and unique things that can be created using Mermaid and the best way to understand it better is to continue to practice.