Add pitchme_to_readme make target (#17)

denstorti · web-flow · commit d994d76ac2b7 · 2020-02-07T08:54:40.000+11:00
* Add pitchme_to_readme make target * Extract exercises from Git content. Create new folder for Git exercises as c01-git-<ex number> * Refactor scripts from Makefile to scripts/ * Update README.md (#18) * Rename folders, exercises, and exercise answer files
diff --git a/Makefile b/Makefile
@@ -1,11 +1,17 @@
-ORG_NAME?=devopsacademyau
-REPO_NAME?=academy
-FOLDER_NAME?=
+export ORG_NAME?=devopsacademyau
+export REPO_NAME?=academy
+export BRANCH_NAME?=
+export FOLDER_NAME?=
 
 presentation:
 	docker-compose up -d
 	sleep 5
 	open "http://localhost:9000/${ORG_NAME}/${REPO_NAME}?p=${FOLDER_NAME}"
 
 stop:
-	docker-compose down
+	docker-compose down
+
+pitchme_to_readme:
+  #Example: FOLDER_NAME=classes/01class/git/ make pitchme_to_readme
+	#Example: FOLDER_NAME=classes/01class/git/ BRANCH_NAME=MY_BRANCH make pitchme_to_readme
+	bash scripts/pitchme_to_readme.sh
diff --git a/classes/01class/aws101/README.md b/classes/01class/aws101/README.md
@@ -8,7 +8,7 @@
 - Cloud Benefits
 - AWS Foundations
 - AWS Services
-- Labs and Exerciss
+- Labs and Exercises
 
 ### General Cloud Concepts
 
@@ -18,7 +18,7 @@
     - Elastic services
         - Services can scale up and down so you can only pay what you need
     - Easy and cheap to test new technologies
-        - Because you only pay for what you use, and during the time you use, you can run tests with new technologies for a weeka nd only pay for the resources onsumed during that week.
+        - Because you only pay for what you use, and during the time you use, you can run tests with new technologies for a week and only pay for the resources consumed during that week.
     - Fast innovation pace
         - Being able to test without big investments, the feedback on tests are quicker and you can continuosly innovate
 
@@ -30,7 +30,7 @@
     - Ephemeral Environments
         - Components are not changed/upgraded. They are fully replaced and nothing is expected to be lost
     - Automation
-        - Automation is an important factor to be able to recreate environments faster and whitout human errors
+        - Automation is an important factor to be able to recreate environments faster and without human errors
 
 ### Cloud Benefits
 
@@ -105,7 +105,7 @@ Image from this [link](https://aws.amazon.com/about-aws/global-infrastructure/).
     - Block storage
     - https://aws.amazon.com/ebs/faqs/
 - EFS
-    - Managed Elastic Filesystem(NFS)
+    - Managed Elastic File System(NFS)
     - https://aws.amazon.com/efs/faq/
 #### Networking
 - VPC
diff --git a/classes/01class/exercises/README.md b/classes/01class/exercises/README.md
@@ -6,3 +6,8 @@ For instructions on how to submit your work, [please check the main repository R
 - [Account billing alarm (C01-E02)](/classes/01class/exercises/c01-e02/README.md)
 - [First EC2 instance (C01-E03)](/classes/01class/exercises/c01-e03/README.md)
 - [S3 (C01-E04)](/classes/01class/exercises/c01-e04/README.md)
+
+- [Merging and Rebasing (c01-git01)](/classes/01class/exercises/c01-git01/README.md)
+- [Everyday questions (c01-git02)](/classes/01class/exercises/c01-git02/README.md)
+- [Big file (c01-git03)](/classes/01class/exercises/c01-git03/README.md)
+- [Secrets (c01-git04)](/classes/01class/exercises/c01-git04/README.md)
diff --git a/classes/01class/exercises/c01-git01/README.md b/classes/01class/exercises/c01-git01/README.md
@@ -0,0 +1,12 @@
+## Merging and Rebasing (c01-git01)
+
+1. Access https://learngitbranching.js.org/ (TIP: if you want to start over, just type `reset`)
+2. Merging exercise:
+   1. type `level intro3`
+   2. Submission: Include your commands on a file **c01-git01-1.txt**
+3. Rebasing exercise:
+   1. type `level intro4`
+   2. Submission: Include your commands on a file **c01-git01-2.txt**
+4. Revert and reset: 
+   1. type `level rampup4`
+   2. Submission: Include your commands on a file **c01-git01-3.txt**
diff --git a/classes/01class/exercises/c01-git02/README.md b/classes/01class/exercises/c01-git02/README.md
@@ -0,0 +1,5 @@
+## Everyday questions (c01-git02)
+
+1. **file c01-git02-1.txt** - Is it possible to see the inner commit of squashed commit with `git rebase`?
+2. **file c01-git02-2.txt** - How to compare two different local repositories using `git diff`? How about remote ones, can you do the same?
+3. (Optional) Install [`ohmyzsh`](https://github.com/ohmyzsh/ohmyzsh) and activate the git plugin
diff --git a/classes/01class/exercises/c01-git03/README.md b/classes/01class/exercises/c01-git03/README.md
@@ -0,0 +1,25 @@
+## Big file (c01-git03)
+
+Perform the following commands:
+1. Initialize a new git repository **locally** (you don't need to push it)
+2. Add a simple README.md text file (`touch README.md`) and commit it
+3. Check the commit with `git log`
+4. Check the size of the repository directory
+    - On the parent, `du -sh .`
+5. Add a fairly big file `file.txt` (around 100MB)
+    - `dd if=/dev/random of=file.txt count=1024 bs=10257`
+6. Add and commit it locally
+    - `git add file.txt; git commit -m "Add big file"`
+7. Check the size of the repository directory again (take note of this)
+    - On the parent, `du -sh .`
+8. Revert the commit that added the big file
+    - use `git revert`, `git reset` or `git rebase`
+9. Check the size of the repository directory again (take note of this)
+    - On the parent, `du -h`
+
+**Questions**
+
+Create a file **c01-git03-1.txt** answering the questions below. Include details and commands used.
+1. Did you notice any difference in the size of the repo before and after adding the big file?
+1. What is the reason for this problem?
+1. How do you remove something from Git history? Which commands would you use? What are the consequences?
diff --git a/classes/01class/exercises/c01-git04/README.md b/classes/01class/exercises/c01-git04/README.md
@@ -0,0 +1,21 @@
+## Secrets (c01-git04)
+
+Perform the following commands:
+1. In the same repository of the previous exercise:
+2. Add a file called `my_env.txt` that contains
+    ```
+    SERVICE_NAME=account-management
+    ENVIRONMENT=prod
+    PASSWORD=pass1234
+    ```
+1. Commit it
+3. Check the commit with `git log`
+
+**Questions**
+
+Create a file **c01-git04-1.txt** answering the questions below. Include details and commands used.
+1. Let's suppose you remotely pushed your `my_env.txt` file. A colleague asks you to remove this information from Git. What's your colleague worried about? 
+2. If you modify the file in your workspace, then push it, will it be enough? (It's not). Why?
+3. If you delete the file and push it, then create a new one with the rest of the information, is it enough? (It's not). Why?
+4. How to fix this? How do you remove something from Git history?
+5. Which commands would you use? What are the consequences for other developers?
diff --git a/classes/01class/git/PITCHME.md b/classes/01class/git/PITCHME.md
@@ -176,7 +176,7 @@ https://trunkbaseddevelopment.com/
 @snapend
 
 @snap[south-west text-04]
-See also GitFlow (https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
+[See also GitFlow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
 @snapend
 ---
 
@@ -204,72 +204,23 @@ See also GitFlow (https://www.atlassian.com/git/tutorials/comparing-workflows/gi
 
 ---
 
-@snap[north-west text-07]
-### Let's do it together
-@snapend
-
-@snap[west text-06]
-
-1. Access https://learngitbranching.js.org/
-1. merge - `level intro3`
-1. rebase - `level intro4`
-
-@snapend
-
----
-
 @snap[middlepoint text-07]
 ## What is the problem of re-writing the history with **git rebase**?
 @snapend
 
 ---
 
-@snap[north-west span-25 text-07]
-**Exercises**
-@snapend
-
-@snap[west text-06]
-1. file ex_git01.txt - Is it possible to see the inner commit of squashed commit with `git rebase`?
-2. file ex_git02.txt - How to compare two different local repositories using `git diff`? How about remote ones, can you do the same?
-3. Install [`ohmyzsh`](https://github.com/ohmyzsh/ohmyzsh) and git plugin
-@snapend
----
-
-@snap[north-west text-07]
-**Exercise ex_git03** - Big file and secrets
-@snapend
-
-@snap[west text-06]
-1. Initialize a new git repository locally
-2. Add a simple text file and commit 
-    - `echo "mypassword" > pwd.txt; git add pwd.txt; git commit -m "Add secret key file. I should not do it."`
-3. Check the commit with `git log`
-4. Check the size of the repository directory
-    - On the parent, `du -sh .`
-5. Add a fairly big file `file.txt` (around 100MB)
-    - `dd if=/dev/random of=file.txt count=1024 bs=10257`
-6. Add and commit it locally
-    - `git add file.txt; git commit -m "Add big file"`
-7. Check the size of the repository directory again (take note of this)
-    - On the parent, `du -sh .`
-8. Revert the commit that added the big file
-    - use `git revert`, `git reset` or `git rebase`
-9. Check the size of the repository directory again (take note of this)
-    - On the parent, `du -h`
-@snapend
-
----
-
 @snap[north-west text-07]
-**Exercise ex_git03** - Big file and secrets
+### Let's do it together - Exercise
 @snapend
 
 @snap[west text-06]
-- Did you notice any difference in the size of the repo before and after adding the big file
-- What is causing this problem?
-- Let's suppose you remotely pushed your `pwd.txt` file. If you delete it and push it, is it enough? (It's not). Why?
-- How do you solve it, i.e. how do you remove something from Git history? What are the consequences?
-
+**Merging and Rebasing**
+1. Access https://learngitbranching.js.org/
+2. Merging exercise:
+   1. type `level intro3`
+3. Rebasing exercise:
+   1. type `level intro4`
 @snapend
 
 ---
diff --git a/classes/01class/git/README.md b/classes/01class/git/README.md
@@ -1,2 +1,165 @@
-## Presentation
-https://gitpitch.com/devopsacademyau/academy?p=/classes/01class/git#/
+#### Presentation URL: https://gitpitch.com/devopsacademyau/academy?p=classes/01class/git/
+
+# Let's Get **Started** with Git
+
+---
+### Versioning: The "old way"
+
+- Pessimistic locking, code duplication
+    - Local versioning -> Copy and paste (Let's duplicate!)
+    - Version overwriting (Who deleted my version!?)
+    - Locked file (Can you please release file customers.xls, please!?)
+- Are there other problems?
+
+
+---
+### What is Git?
+
+- Created by Linus Torvalds in 2005 for development of the Linux kernel
+- Git is a distributed VCS
+- Centralized vs Distributed VCS?
+- Optimistic vs Pessimistic locking?
+
+
+![IMAGE](assets/git.0.jpg)
+
+---
+
+### Centralised vs Distributed VCS
+
+- Centralised:
+    - Centralised master version
+    - Code Check outs (one developer is allowed to work on that part of the code at any one time.)
+    - Locking controlled by the server
+    - Release records version numbers of all elements
+- Distributed:
+    - Entire history of changes cloned by developers
+    - No locking
+    - Changes modify history (append or rewrite)
+    - Release is a history of changes
+
+---
+
+### Optimistic Locking
+
+![IMAGE](assets/OptimisticSketch.gif)
+
+
+---
+
+So, how git achieves optimistic locking so developers can work in parallel in the same file?
+
+---
+
+### Git Storage
+![IMAGE](assets/git_storage.png)
+
+
+---
+
+### Git Main Commands 
+
+- start a working area (see also: git help tutorial)
+   - **clone**      Clone a repository into a new directory
+   - **init**       Create an empty Git repository or reinitialize an existing one
+
+- work on the current change (see also: git help everyday)
+   - **add**        Add file contents to the index
+   - **mv**         Move or rename a file, a directory, or a symlink
+   - **reset**      Reset current HEAD to the specified state
+   - **rm**         Remove files from the working tree and from the index
+
+- examine the history and state (see also: git help revisions)
+   - **bisect**     Use binary search to find the commit that introduced a bug
+   - **grep**       Print lines matching a pattern
+   - **log**        Show commit logs
+   - **show**       Show various types of objects
+   - **status**     Show the working tree status
+
+---
+
+### Git Main Commands (more)
+
+- grow, mark and tweak your common history
+   - **branch**     List, create, or delete branches
+   - **checkout**   Switch branches or restore working tree files
+   - **commit**     Record changes to the repository
+   - **diff**       Show changes between commits, commit and working tree, etc
+   - **merge**      Join two or more development histories together
+   - **rebase**     Reapply commits on top of another base tip
+   - **tag**        Create, list, delete or verify a tag object signed with GPG
+
+- collaborate (see also: git help workflows)
+   - **fetch**      Download objects and refs from another repository
+   - **pull**       Fetch from and integrate with another repository or a local branch
+   - **push**       Update remote refs along with associated objects
+
+
+---
+
+### Let's do it together
+Let's add a folder to hold exercises for classes
+
+1. Check README.md in the root for instructions.
+2. Add, commit and push it to your remote dev branch :tada:
+3. Create a Pull Request (PR)
+
+
+---
+
+### Checking in code can get complex (quickly!)
+![IMAGE](assets/merge_hell.png)
+
+How can we have a standard approach to work as one team?
+
+---
+### A solution: Trunk based development 
+
+Short lived branches simplify a lot of things!
+https://trunkbaseddevelopment.com/
+
+[See also GitFlow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
+---
+
+![IMAGE](assets/merge_vs_rebase.jpg)
+
+---
+
+### Merging vs Rebasing
+
+`git checkout feature`
+`git merge master`
+![IMAGE](assets/merge.png)
+
+`git checkout feature`
+`git rebase master`
+![IMAGE](assets/rebase.png)
+
+---
+
+## What is the problem of re-writing the history with **git rebase**?
+
+---
+
+### Let's do it together - Exercise
+
+**Merging and Rebasing**
+1. Access https://learngitbranching.js.org/
+2. Merging exercise:
+   1. type `level intro3`
+3. Rebasing exercise:
+   1. type `level intro4`
+
+---
+
+**OMG, I don't know what I did!**
+
+https://ohshitgit.com/
+
+---
+
+### References
+
+1. https://martinfowler.com/eaaCatalog/optimisticOfflineLock.html
+1. https://www.teamstudio.com/blog/distributed-vs-centralized-version-control-systems-for-lotus-notes
+1. https://www.atlassian.com/git/tutorials/merging-vs-rebasing
diff --git a/scripts/pitchme_to_readme.sh b/scripts/pitchme_to_readme.sh
