ifycode / git-github-training-resource Goto Github PK

The video captions under the learning videos on the github contributions show what the videos cover. This is good, but we also want readers/users to see the lessons covered by the videos in the learning videos section before they start watching the videos.

Task description and expected result

• Create a list (use the video captions of videos found under the learning videos section as a guide).
• You are to add the list just after the introductory paragraph under the learning videos section.
• You can start with You will learn the following from the learning videos on this page:

Note
Interested contributors should read up How to submit your changes to this training resource for guidelines on how to make contributions to this repository

We want our contributors to benefit from taking the training too!

Task description

• Add a hint just before the Learning resource repo: How to submit your changes section of the making and submitting changes page.
• The hint should tell interested contributors that taking the Git and Github training can help them better contribute to the Git and Github training project (and any other Github projects they will be taking on in the future).

New learning videos have been added to our youtube playlist, but have not been added to our Part 1 set 2 page of the Gitbook learning resource.

Task description and expected result

Go to the Learning videos section, and replace the text there with the videos below (i.e. embed the videos):

• https://youtu.be/hRFBG3lMq9k
• https://youtu.be/Ej396Vra1oQ

Additional information

• You are not just embedding only. Each video should be in a section. The section title for each video should be determined by the video title on youtube. For example, on youtube, if a video has the title - Git and Github training # 3: Github UI - Forking a repo, and how to know which branch you are in. The section title for this video should therefore be Forking a repo, and how to know which branch you are in. Use the same idea for the youtube videos you are embedding.
• Just use "youtube video" as the caption for the 2 videos

Two new learning videos have been added to our youtube playlist, but have not been added to our Part 1 set 1 page of the Gitbook learning resource.

Task description and expected result

Go to the Learning videos section, embed these videos in certain positions:

• First youtube video: https://youtu.be/A2gqOvGpH_0. Embed this video before the Managing files and folders (create, edit and delete) section
• Second youtube video: https://youtu.be/gGpH3kdbQns. Embed this video after the When to delete a branch connected to pull request or a fork section.

Additional information

• You are not just embedding only. Each video should be in a section. The section title for each video should be determined by the video title on youtube. For example, on youtube, if a video has the title - Git and Github training # 3: Github UI - Forking a repo, and how to know which branch you are in. The section title for this video should therefore be Forking a repo, and how to know which branch you are in. Use the same idea for the youtube videos you are embedding.
• Just use "youtube video" as the caption for the 2 videos

Task description

Changes have happened the the set 1 page learning video section that has not yet occurred in set 2 page learning video section. The changes include:

• Videos no longer have headings. Instead what was in the headings are now the video captions.
• Introductory paragraph has been added for set 1 page learning video section, but set 2 page learning video section doesn't have yet. Let the reader know that the learning videos in there will talk about workflows and best practices when working with git and Github.
• Extra: There are 2 task sections in the set 2 page. Remove the task section that does not have video embed completely

Task description

• Go to the readme file of the training repo
• Convert the list item text "Set 1 - Github UI Learning videos and tasks" to a link that leads to: https://obiagba-mary.gitbook.io/git-and-github-training/part-1-github-ui/set-1-github-ui-learning-videos-and-tasks
• Convert the list item text "Set 2 - Github UI Learning videos and tasks" to a link that leads to: https://obiagba-mary.gitbook.io/git-and-github-training/part-1-github-ui/set-2-github-ui-learning-videos-and-tasks

Our Part 1 set 1 page of the Gitbook learning resource currently does not contain any video.

Task description and expected result

Replace the "Work in progress page" text with youtube videos. Embed the new video resources below on Part 1 set 1 page:

• https://youtu.be/W8TIY7mbvXo
• https://youtu.be/DWAgcmMEiXE
• https://youtu.be/IqJWDTZdQG4
• https://youtu.be/Gt0ORe5aIx4

Additional information

• You are not just embedding only. Each video should be in a section. The section title for each video should be determined by the video title on youtube. For example, on youtube, the first video in the list above has the title - Git and Github training # 3: Github UI - Forking a repo, and how to know which branch you are in. The section title for this video should therefore be Forking a repo, and how to know which branch you are in. Use the same idea for other youtube videos.
• Just use "youtube video" as the caption for all 4 videos

New learning videos have been added to our youtube playlist, but have not been added to our Part 1 set 2 page of the Gitbook learning resource.

Task description and expected result

Go to the Learning videos section, and embed these videos before the text:

• https://youtu.be/Rx14ka5M3cc
• https://youtu.be/bnlvtzsL7sY

Additional information

• You are not just embedding only. Each video should be in a section. The section title for each video should be determined by the video title on youtube. For example, on youtube, if a video has the title - Git and Github training # 3: Github UI - Forking a repo, and how to know which branch you are in. The section title for this video should therefore be Forking a repo, and how to know which branch you are in. Use the same idea for the youtube videos you are embedding.
• Just use "youtube video" as the caption for the 2 videos

Problem

We currently do not have our workflow written out for the training repo. So right now, contributors don't have much help on how they can interact with the training and documentation repos when they make contributions. We want to change that.

Task description and expected result

On the Making and submitting changes page of the documentation:

• Add a new section just before the "Add your changes using the command line" section. The name of the new section should be Training repo: Add your changes using the GitHub UI
• Under this new section you created, add the following information in form of a list:
  • Fork the training repo (Additional information: The default branch of the training repo is the main branch. So on the "Create a new fork" page, make sure to uncheck the "Copy the main branch only" checkbox before clicking on the "create fork" button. This will allow you to also have the develop branch, since you will need the develop branch for the next steps).
  • Go to the develop branch of your fork.
  • Create a new branch from the develop branch and make your changes in the new branch you created.
  • Send a pull request pointing to the develop branch of the original training repo.
  • Wait for review of your changes from the repo admin(s).

Feel free to add any other helpful information to the list that I may have missed out on, but your submission must contain everything in the list above.

Note
Find file to update in the doc folder of this repository

Problem

Reload any one page from this documentation (whenever you come back to continue this training) so that newly added content can show up (if any new content has been added).

The above text/sentence appears towards the bottom of some pages of the documentation. But only the one on the introduction page is properly formatted as a hint. On every other page, it appears as ordinary text.

Task description and expected result

Make the sentence above show up properly formatted as a hint, on every page where the text/sentence exists.

Note
Find files to update in the doc folder of this repository

The video captions under the learning videos on the Workflows and best practices page show what the videos cover. This is good, but we also want readers/users to see the lessons covered by the videos in the learning videos section before they start watching the videos.

Task description and expected result

• Create a list (use the video captions of videos found under the learning videos section as a guide).
• You are to add the list just after the introductory paragraph under the learning videos section.
• You can start with You will learn the following from the learning videos on this page:

Note
Interested contributors should read up How to submit your changes to this training resource for guidelines on how to make contributions to this repository

Task description

• Go to the readme file of the training repo
• Convert the list item text "Video: Introduction" to a link that leads to: https://obiagba-mary.gitbook.io/git-and-github-training/#watch-video-introduction

Problem

• Videos under the learning videos section of Part 1 set 1 page have "Youtube Video" as youtube caption, this does not show what the videos are about.

Tasks description and expected output

Not really sure what the video captions should say. Should the video captions be the same as the header above each of them? This looks like repetition.

• What is your opinion? (drop your opinion in the comment below)
• Be willing to send a pull request to fix this issue once your opinion is accepted

If you take a look at the side bar of the gitbook resource, You will find that pages of the resource are grouped under 3 sections - PART 1: GITHUB UI, PART 2: COMMAND LINE GIT, and CONTRIBUTORS GUIDE.

Problem

We want the group/section that a page falls under, to be the page description directly under the title of the page in capital letters. The problem is that only the Github contributions page shows the correct thing. Other pages (under the above-mentioned 3 sections) either have the description as hint with style success or don't even have the description at all.

Task description and expected output

• For pages where the description is written as a hint with style success, remove the hint completely and add the description in the correct place as instructed above.
• For pages that do not have the description as a hint, just also add the description in the correct place as instructed above.

Note
Interested contributors should read up How to submit your changes to this training resource for guidelines on how to make contributions to this repository

We want our contributors to know that they can share that they are contributors to the Git and GitHub gitbook training resource on their portfolio!

Task description

• Add a hint just before the Learning resource repo: How to submit your changes section of the making and submitting changes page.
• The hint should tell interested contributors that they can indicate share they are contributors to the Git and GitHub gitbook training resource on their portfolio, as long as they are among contributors listed in the contributors section. Anyone who has contributed and has not been added to the contributors list should notify repo admins through the learning resource repo's discussion.

Issue Background

In open source, the contributing guide for a project is usually expected to be in the CONTRIBUTING.md file at the root of the project repository.
The git and Github training resource has a contributing guide, but we do not have it at the root of the project and inside a CONTRIBUTING.md file. The reason is that we want the contributing guidelines to show up in our Gitbook resource.

Task description and expected output

Just in case an interested contributor prefers to look for a CONTRIBUTING.md file since it's like an open-source norm, you will help redirect them to the gitbook contributing guidelines. The task is simple:

• Create a CONTRIBUTING.md file at the root of the repo.
• In this file, let the reader know that the contributing guidelines can be found on the contributing guidelines page of the git and Github training gitbook learning resource.

We want our contributors to know the following are important while making contributions to the training resources:

• Interested contributors are to show interest by commenting on the issue they want to work on, in other to get assigned to the issue. Submitting a pull request for an issue you are not assigned to will only be counted as spam. You will be unassigned from an issue if you do not submit a pull request for that issue after 2 days of showing interest.
• Contributions should be done as instructed in Learning resource repo: How to submit your changes or Training repo: How to submit your changes, depending on the repository you are working on.
• Pull request title must reflect the Issue title you are working on, and it should start with "Fix: ". For example, If the issue title is "Add contribution rules section to help contributions know the important things to do while making changes", the pull request title should be "Fix: Add contribution rules section to help contributions know the important things to do while making changes".
• Pull request should be linked issue it aims to fix.
• Feel free to ask questions if you are not clear about something in the issue you are working on.

Task description

• Create a section called Contribution guidelines to follow just before the Learning resource repo: How to submit your changes section.
• Add the guidelines above in form of a list under this new section you have created.

We want to make changes to the workflows and best practices page only. At the moment we only have videos in the tasks section of the Workflows and best practices page.

Task description and expected results

Add more content to the tasks section (use the tasks section in the github contributions page as a guide). Specific details given below:

• Use the introductory paragraph as it is, don't change anything in there.
• About the part that states the task: In this case, we only have one task. So instead of Task 1: and Task 2: , just use Task:. The task, in this case, is to follow the instructions in the issue created from the template in the tasks section of the github contributions page. This time, the learner is to interact with the develop branch as shown in the learning videos.
• Use the hint as it is, don't change anything in there.

Note
Interested contributors should read up How to submit your changes to this training resource for guidelines on how to make contributions to this repository

If you take a look at the side bar of the gitbook resource, You will find that pages of the resource are grouped under 3 sections - PART 1: GITHUB UI, PART 2: COMMAND LINE GIT, and CONTRIBUTORS GUIDE.

Problem

We want the group/section that a page falls under, to be the page description directly under the title of the page in capital letters. The problem is that only the Github contributions page shows the correct thing. Other pages (under the above-mentioned 3 sections) either have the description as hint with style success or don't even have the description at all.

Task description and expected output

• For pages where the description is written as a hint with style success, remove the hint completely and add the description in the correct place as instructed above.
• For pages that do not have the description as a hint, just also add the description in the correct place as instructed above.

Note
Interested contributors should read up How to submit your changes to this training resource for guidelines on how to make contributions to this repository

There is currently nothing that tells learners about the prerequisites for taking the git and github training.

Task description & expected output

• Add a hint just under the title of the git & github training introduction page.
• The hint should have the text: Prerequisite: No knowledge of git and github required.
• The hint should have style success.

Task description and expected output

There are 2 links on the contributing guidelines page - i.e. links to the code of conduct .md file and how to submit your changes to this training resource page.

• Add a hint just before the links.
• The content of the hint: You can start with "Hi there 👋 Thank you for your interest to contribute to the Git and Github training resource". Tell the reader to find the guidelines for contributing to the training resource in the links below.

Note
Interested contributors should read up How to submit your changes to this training resource for guidelines on how to make contributions to this repository

Problem

We currently do not have our workflow written out for the documentation repo. So right now, contributors don't have much help on how they can interact with the training and documentation repos when they make contributions. We want to change that.

Task description and expected result

• On the Making and submitting changes page of the documentation, there is a section in there with title Add your changes using the GitHub UI, change this title to Documentation repo: Add your changes using the GitHub UI
• Replace "Add text content" with the following information in form of a list:
  • Fork the documentation repo (Additional information: The default branch of the documentation repo has been set to develop branch. So on the "Create a new fork" page, you can leave the "Copy the develop branch only" checkbox as checked since you will need the develop branch for the next steps).
  • Confirm that you are in the develop branch of your fork.
  • Create a new branch from the develop branch and make your changes in the new branch you created.
  • Send a pull request pointing to the develop branch of the original documentation repo.
  • Wait for review of your changes from the repo admin(s).

Feel free to add any other helpful information to the list that I may have missed out on, but your submission must contain everything in the list above.

Note
Find file to update in the doc folder of this repository

The Task video for Part 1 set 1 has been added to our youtube playlist but has not been embedded yet in the gitbook resource.

Task description and expected result

• On the Part 1 set 1 page , under the Task section replace the text Task video goes here. Videos not available yet. Check back on the 9th of October 2022. with an embedded youtube video.
• This is the youtube video to embed: https://youtu.be/SNfWwGD7UuI
• The video caption should be "Tasks 1 and 2 for Part 1 set 1"

Two new learning videos have been added to our youtube playlist, but have not been added to our Part 1 set 1 page of the Gitbook learning resource.

Task description and expected result

Under the Learning videos section, you will find this text:
Some other set 1 learning videos are not available yet. Check back on the 9th of October 2022.
Remove this text, and add these 2 videos at that position:

• https://youtu.be/lqSdpFmT3y4
• https://youtu.be/K8PmM6mRLIo

Additional information

• You are not just embedding only. Each video should be in a section. The section title for each video should be determined by the video title on youtube. For example, on youtube, if a video has the title - Git and Github training # 3: Github UI - Forking a repo, and how to know which branch you are in. The section title for this video should therefore be Forking a repo, and how to know which branch you are in. Use the same idea for the youtube videos you are embedding.
• Just use "youtube video" as the caption for the 2 videos

Problem

The purpose of the training written on the introduction page of the gitbook learning resource says: "The purpose of the Git & Github training videos and exercises added here is to help with interacting with a repository that is not yours".
But this is just one of the many purposes the training came into existence.

Task description and Expected result

That part of the page should highlight all purposes in form of a description and a list as shown below.

The purpose of the Git & Github training videos and exercises added here is to provide an interactive platform, that will help prepare learners for internships and jobs that require the use of git and GitHub. There will be no code-related content, the only type of files the training will use are files with .md extensions. The content of the training will help to understand and practice:

• GitHub contributions
• Use of the Github UI
• Use of command line
• Git workflow
• Using Git and github for collaboration

Problem

The purpose of the training written in the readme file found at the root of the training repo, and in the readme file found in the doc folder of the documentation repo says: "Git & Github training videos and exercises added here is to help with interacting with a repository that is not yours".
But this is just one of the many purposes the training came into existence.

Task description and Expected result

That part of both readme files should highlight all purposes in form of a description and a list as shown below.

The purpose of the Git & Github training videos and exercises added here is to provide an interactive platform, that will help prepare learners for internships and jobs that require the use of git and GitHub. There will be no code-related content, the only type of files the training will use are files with .md extensions. The content of the training will help to understand and practice:

• GitHub contributions
• Use of the Github UI
• Use of command line
• Git workflow

Note 1: This means you are to work on and send pull requests to the 2 repos concerned.
Note 2: Show interest that you want to work on this issue by typing a comment under this issue.

Extra note: Once your changes have been merged into the one for the documentation repo, the changes you submitted will automatically show up on this page of the live documentation: https://obiagba-mary.gitbook.io/git-and-github-training.

The Task video for Part 1 set 2 has been added to our youtube playlist but has not been embedded yet in the gitbook resource.

Task description and expected result

• On the Part 1 set 2 page , under the Tasks section replace the text with an embedded youtube video.
• This is the youtube video to embed: https://youtu.be/IhpzEYTue34
• The video caption should be "Task for Part 1 set 2"

Problem

The file(s) to update are in the doc folder of this repository. But our contributors don't know that yet. Help contributors know where they can find files to update when contributing to the learning resource.

Task description

• Add a hint just after the last list item under the Learning resource repo: How to submit your changes section of the making and submitting changes page.
• The hint should tell contributors interested in improving the content of the learning resource to find files to update in the doc folder of the Learning resource repo.