Merge pull request #1 from RENCI-NRIG/vcs

Updates to PE103 VCS section
RENCI-NRIG · May 6, 2024 · 221640e · 221640e
2 parents 0ac3a20 + 3040f73
commit 221640e
Show file tree

Hide file tree

Showing 25 changed files with 1,051 additions and 224 deletions.
diff --git a/theme1/PE100/python-and-jupyter.ipynb b/theme1/PE100/python-and-jupyter.ipynb
diff --git a/theme1/PE103/README.txt b/theme1/PE103/README.txt
@@ -0,0 +1,15 @@
+A note about the diagrams:
+
+Quarto supports embedding both mermaid and graphviz diagrams:
+
+https://quarto.org/docs/authoring/diagrams.html
+
+
+The .mmd files in this directory are input for mermaid, and the .dot
+files are input for graphviz.  The .ditaa files are input for ditaa:
+
+https://github.com/stathissideris/ditaa
+
+Since I wanted a little more control over the layout of the nodes in
+the diagram, I eventually chose ditaa.  The .mmd files and .dot files
+are left here, just in case they are found to be eventually useful.
diff --git a/theme1/PE103/branching.ditaa b/theme1/PE103/branching.ditaa
@@ -0,0 +1,7 @@
+       main / master branch
+-*-*---*----*-----*------*--*---*--*--->
+   |                            ^
+   |                            |
+   |   feature branch           | 
+   +-*----*-----*----*----*-----*
+
diff --git a/theme1/PE103/branching.png b/theme1/PE103/branching.png
diff --git a/theme1/PE103/git.png b/theme1/PE103/git.png
diff --git a/theme1/PE103/git_commit.png b/theme1/PE103/git_commit.png
diff --git a/theme1/PE103/remote-repository.ditaa b/theme1/PE103/remote-repository.ditaa
@@ -0,0 +1,11 @@
+         +-----------------------+
+         |   remote repository   |
+         +-----------------------+
+            ^         ^         ^ 
+            |         |         |
+    +-------+         |         +------+
+    |                 |                |
+    V                 v                V
++------------+   +------------+    +------------+    
+| you        |   |colleague #1|    |colleague #2|    
++------------+   +------------+    +------------+
diff --git a/theme1/PE103/remote-repository.png b/theme1/PE103/remote-repository.png
diff --git a/theme1/PE103/staging.ditaa b/theme1/PE103/staging.ditaa
@@ -0,0 +1,11 @@
++-----------+     +-----------+     +-----------+     
+| working   |     | staging   |     | repository|
+| tree      |     | area      |     | (.git)    |
++-----------+     +-----------+     +-----------+     
+     |                  |                |
+     |                  |                |
+     |<-------------checkout-------------|
+     |                  |                |
+     |-----stage------->|                |
+     |                  |----commit----->|
+     |                  |                |
diff --git a/theme1/PE103/staging.png b/theme1/PE103/staging.png
diff --git a/theme1/PE103/vcs-testing-debugging.md b/theme1/PE103/vcs-testing-debugging.md
@@ -1,5 +1,5 @@
 # Version Control, Testing and Debugging
 
-- [Version Control](./vcs.md)
+- [Version Control](./vcs.qmd)
 - [Testing](./testing.md)
 - [Debugging](./debugging.md)
diff --git a/theme1/PE103/vcs.md b/theme1/PE103/vcs.md