diff --git a/.github/ISSUE_TEMPLATE/completed-lists.md b/.github/ISSUE_TEMPLATE/completed-lists.md deleted file mode 100644 index c5cea21c..00000000 --- a/.github/ISSUE_TEMPLATE/completed-lists.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Completed Lists -about: This is for your master pull request to merge your master into this repo. -title: Put your UCID as the title (replace this text) -labels: Compiled List -assignees: '' - ---- - -You need to make a pull request and add the link to the pull request to this issue when you submit. - -PULL REQUEST LINK: - -UCID: diff --git a/.github/ISSUE_TEMPLATE/master-pull-request.md b/.github/ISSUE_TEMPLATE/master-pull-request.md new file mode 100644 index 00000000..86285d3b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/master-pull-request.md @@ -0,0 +1,36 @@ +--- +<<<<<<< HEAD + +name: Master Pull request +about: This is for your master pull request to merge your master into mine into this + repo. +======= +name: Master Pull Request +about: This is for your master pull request to merge your master into this repo. + +title: Put your UCID as the title (replace this text) +labels: '' +======= +name: Master Pull Request +about: This is for your master pull request to merge your master into mine into this + repo +title: Put your UCID as the title (replace this text) +labels: Submitting my master branch +>>>>>>> main +assignees: '' + +--- + +<<<<<<< HEAD + +You need to make a pull request and add the link to the pull request to this issue when you submit. +======= +You need to make a pull request and add the link to the pull request to this issue when you submit. + +PULL REQUEST LINK: + +UCID: + +======= +You need to make a pull request and add the link to the pull request to this issue when you submit. +>>>>>>> main diff --git a/.github/ISSUE_TEMPLATE/things-i-don-t-understand.md b/.github/ISSUE_TEMPLATE/things-i-don-t-understand.md index 472a5362..d2d3e499 100644 --- a/.github/ISSUE_TEMPLATE/things-i-don-t-understand.md +++ b/.github/ISSUE_TEMPLATE/things-i-don-t-understand.md @@ -1,10 +1,20 @@ --- name: Things I Don't Understand about: This is for adding issues that you don't understand -title: '' +<<<<<<< HEAD + +title: 'Thing I want to know: [Thing I want to know]' labels: Things I Don't Understand +======= +title: '' +labels: I Don't Know + +======= +title: '' +labels: I don't know +>>>>>>> main assignees: '' --- -I don't understand +Please describe what you want to know in less than 255 characters. diff --git a/.github/ISSUE_TEMPLATE/things-i-learned.md b/.github/ISSUE_TEMPLATE/things-i-learned.md index ff68fa38..c81abe3e 100644 --- a/.github/ISSUE_TEMPLATE/things-i-learned.md +++ b/.github/ISSUE_TEMPLATE/things-i-learned.md @@ -2,7 +2,15 @@ name: Things I learned about: Add one item for each thing you learned keep to max of 255 characters title: "[Things I Learned]" -labels: Things I learned +<<<<<<< HEAD + +labels: '' +======= +labels: I Know + +======= +labels: I know +>>>>>>> main assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/things-i-want-to-know.md b/.github/ISSUE_TEMPLATE/things-i-want-to-know.md index 025fa8f1..d733fb68 100644 --- a/.github/ISSUE_TEMPLATE/things-i-want-to-know.md +++ b/.github/ISSUE_TEMPLATE/things-i-want-to-know.md @@ -2,7 +2,15 @@ name: Things I want to know about: Describe this issue template's purpose here. title: 'Thing I want to know: [Thing I want to Knows]' -labels: Things I learned +<<<<<<< HEAD + +labels: '' +======= +labels: I Want To Know + +======= +labels: I want to know +>>>>>>> main assignees: '' --- diff --git a/README.md b/README.md index 0b49fb1d..5c85fd88 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ -# MyWebClass Collaboration and Brainstorming Assignment +# MyWebClass collaboration and brainstorming activity to identify required content for mywebclass -## Overview +The purpose of this assignment is to practice collaborating using GIT/GitHub and to do this you need to create a list of things that you have learned in this class, things that you don't understand , and things that you want to learn. + +## Instructions +======= The purpose of this assignment is to practice collaborating using GIT/GitHub and develop the requirements for the mywebclass.org website's tutorials and courses. To accomplish this task we are going to create three lists(What I Know, What I Don't Know, and What I Want To Learn) and consolidate the items from everyone in the class into a master list that counts the number of repeated issues. You need at least **3 items for each list for a total of 9 items** and you should plan that these items are going to be used for project 1 as the basis for the possible topics that people can choose to build online tutorials about. ## Learning Objectives: @@ -13,17 +16,55 @@ The purpose of this assignment is to practice collaborating using GIT/GitHub and ### Your list should look like this: #### Things we understand** + +1. Python print[1] +2. Git Pull[2] +3. Linux Commands[1] + + 1. Python Print[1] -2. Linux Directory listing[2] +2. Linux Directory listing[2] 3. Docker Installation[1] + #### Things we don't understand -1. Git Stash[1] + +1. Git stash[1] +2. Git status[2] +3. Proper Documentation[1] +#### Things we want to know next** +1. Vim[1] +2. Cloud deployment w/ Kubernetes[2] +3. Ruby[1] +======= +1. Git stash[1] +======= +2. Linux Directory listing[2] +3. Docker Installation +#### Things we don't understand +1. Pull Requests +>>>>>>> main 2. GIt pull[2] -3. GIT status[1] +3. Proper Documentation[1] +======= +1. I know how to create and track projects +2. I know how to commit changes +3. I have learnt how to fork repos and work on projects +#### Things we don't understand +1. I don't understand how to do the submissions on canvas after completing the tasks on GitHub +2. I don't understand how to fix errors in Pycharm +3. I don't understand how to use docker hub and for what purpose + #### Things we want to know next** -1. Elastic Search Indexing [1] -2. Cloud deployment with Kubernetes[2] -3. Teraform[1] + +1. Vim[1] +2. Cloud deployment with Kubernetes[2] +3. Ruby[1] +======= +1. I want to learn the softwares being taught in this class properly without falling back +2. I want to learn the softwares being taught in this class properly without falling back +3. I do feel kind of feel lost in class, I want to know what exactly to learn and how to go about it + + ## Prerequisite - YOU. MUST SETUP PRIVATE PUBLIC KEY AUTH WITH GITHUB OR YOU WILL GET ACCESS DENIED ERRORS WHEN YOU PUSH FROM THE TERMINAL Add your ssh public key to github - See video @@ -60,35 +101,41 @@ This person should then merge the pull requests and resolve the merge conflict t To submit this assignment you need to submit the result of step #5 to canvas. When you look at the commits for your project you should see a total of 3 different users have contributed items to the list **including yourself** . If you don't have at least 3 people's commits on the project you will lose 33 points for each person not found. ## Project Setup Instructions + Collaborating on GitHub: 1. Fork the repository: Each person should fork the repository to their own GitHub account. To do this, click the "Fork" button in the top-right corner of the repository page. -2. Enable issues: If you don't see the "Issues" tab in the main menu, you should enable it in the repository settings. -3. Go to the "Issues" tab, and click "Milestones" to add a 0.1.0 milestone and describe it as a consolidated list of issues from your team. -4. Go to the issues tab you should also create labels for "I Know", "Want to Know", "Don't Understand", and "Master List". -5. Once you create these labels then go to settings and look for the "Issues Template" and create/edit 4 issue templates that will provide the starting text for each issue filed of that type. At the bottom of each issue you will see that you can automaticly assign a label to that issue type, so connect the respective labels you created with the 4 issue types. You need an issue for "I Know", "Want to Know", "Don't Understand", and "Master List". -4. Goto the project tab and create a new project (you have to click the down arrow next to "link project" to change it to new project). When you create a project you need to select "board" and name it "Documentation Tasks". -5. Once this is completed then clone this to your computer using the SSH link **NOT THE HTTP LINK** you need the ssh link to use the key you added to your account, so you don't get an error when pushing. - - -### Project management and Collaboration workflow Steps -1. create an issue -2. assign issue to project task -* Assign to yourself -* Assign to correct project board -* Assign to "todo" project status -* Assign to the correct milestone -* create issue branch -3. Go to the project board and move the task you created to in progress -4. git fetch origin to see new branch -5. checkout issue branch locally -6. git status to make sure you don't have any changed files in the branch before you work -7. Resolve the issue by adding the list item or incrementing the count of the item -8. commit -a -m "message text" to do the commit -9. git push origin head <- pushes current branch to github -10. Do a pull request for the branch and make sure you pick the correct source and destination. Click compare forks because by default it will go to the upstream repository i.e. mine -11. merge the pull request and add "closes # i.e. closes #4 to close the issue -12. Check that your task is moved from in progress to done -13. update your local main branch with the changes from the merge by doing git pull origin main -14. Repeat again, and again, and again - +2. Enable issues: If you don't see the "Issues" tab in the main menu, you should enable it in the repository settings. Go to the "Issues" tab, and click "Milestones" to add a 0.1.0 milestone and describe it as a consolidated list of issues from your team. On the issues tab you should also create labels for "I Know", "Want to Know", and "Don't Understand". Once you create these labels then go to settings and look for the "Issues Template" and create 3 issue templates that will provide the starting text for each issue filed of that type. At the bottom of each issue you will see that you can automaticly assign a label to that issue type, so connect the respective labels you created with the 3 issue types. +3. Create one issue per item in your list and assign it to the correct issue template. +4. Create a new project tab and create a new project (you have to click the down arrow next to "link project" to change it to new project). When you create a project you need to select "board" and name it "Documentation Tasks". +5. Go back to your issues, click on each issue, and assign the issue to the following: assignee i.e. you, miletone i.e. the one you created 0.1.0, project documentation (set the status to todo) and create the branch for the issue. +4. Go to the "Project" board, and if you see any tasks without a status move them to the todo column. +5. Pick one task and move it to the in progress column to indicate you are going to work on it. +6. If you have not done so already clone the repository to your local and type "git fetch" to see the branch(s) for the issues you created. +7. Do a "git checkout " i.e. "git checkout 1-some-issue". +8. Complete the issue by adding one item to one of the 3 categories. Do a git status and make sure that only the readme is changed. If the readme just has the change then you can do a git commit -a -m "PUT A DESCRIPTIVE MESSAGE HERE". git commit with the -a flag adds all the new and modified files to the commit. +9. Push the branch back by doing a git push origin head or use the push command from the drop down in Pycharm. +10. Make a pull request (MAKE SURE YOU DO IT FOR YOUR OWN IT WILL DEFAULT TO MAKING A PULL REQUEST TO THE UPSTREAM REPOSITORY" for the branch and when you come to the part where you have to need the commit message you have to add "closes #?" the ? is whatever issue number that the pull request resolves. +11. Check the documentation board and you should see that the task has moved from in progress to done. +12. Once you have resolved an issue you should go to your partners' fork and make a pull request that to merge your issue branch. +13. Your partner will then need to create an issue to merge the pull request. You first need to save an issue and after you save it will make the right side controls active and you can select the repository / pull request you want to link and fill out the other fields like assigning the task to the milestone, assigning a developer, assiginging it to the right project with the todo status. +14. Once your partner creates the issue they need to merge the pull request and close it with the "closes #?" in the merge message. +15. On your own fork, you will want to make a pull request to yourself to merge their updated master into yours. + + +# Complete the Assignment By adding your issues to these 3 lists. + +## Put your items here +### Things you understand so far +1. I know how to make an ssh key and add it to GitHub So I don't need to login with password +2. I learend GITHUB Issues +3. Merging +4. pull requests +### Things you don't understand about what we are doing / web development. +1. Add items to the list +2. Terminal commands +3. docker +### Things you want to know next +1. How to connect viewjs to elastic search +2. fdsadfas +3. Java \ No newline at end of file