harshkapadia2 / git_basics Goto Github PK

• The meta tags will have to be inserted by adding them in the head of a Docinfo file.
• The meta tags to be inserted

<meta name="keywords" content="git, github, git_basics, git bash, basics of git, basics of github">
<meta name="description" content="A web site for the basics of Git and GitHub!">

• Current PWA icons have transparent backgrounds.
• Change the transparent background to a black (#000000) background.
• Icons:
  • https://github.com/HarshKapadia2/git_basics/blob/main/src/static/img/icon-192x192.png
  • https://github.com/HarshKapadia2/git_basics/blob/main/src/static/img/icon-512x512.png

• Check if it is possible to make the dummy commands like git add dir/dir1_file.txt to have black/distinctive background, so that it's easy to spot them if one is in hurry or already know the concept but just want to be sure to get the syntax right. (LinkedIn post comment)

If/when files are split out info sections, then Asciidoctor can be used to build a website and/or PDF and can also deploy to GitHub Pages

• Add a line at the end of the git push sub-section in the Commands section.
• File path: ./src/commands/git_push.adoc
• Syntax: ''' (Please leave a blank line above this line.)

A line like the one below will be created, indicating the end of the sub-section.

• The links in the README.md and CONTRIBUTING.md files that point to files in the repo are absolute links rather than being relative links. Please correct them to relative links, taking care of directory levels.
• This issue is not related to external links (ie, links that go to external web sites) in those two files.
• Example of relative links:
  CONTRIBUTING.md.
  [CONTRIBUTING.md](CONTRIBUTING.md) ✔️
• Example of absolute links:
  CONTRIBUTING.md.
  [CONTRIBUTING.md](https://github.com/HarshKapadia2/git_basics/blob/master/CONTRIBUTING.md) ❌

• Build your own Git
• Git from the inside out
• Unpacking Git packfiles
• git - 1337 edition - I and git - 1337 edition - II

Git cheat sheet (visualiser)

• https://ndpsoftware.com/git-cheatsheet.html

Comprehensive and illustrated article

• https://medium.com/mindorks/what-is-git-commit-push-pull-log-aliases-fetch-config-clone-56bc52a3601c
• https://dev.to/lydiahallie/cs-visualized-useful-git-commands-37p1

Contribution resources

• https://eddiejaoude.github.io/book-open-source-tips/#_explore_open_source_projects
• https://github.com/MunGell/awesome-for-beginners/
• https://www.codetriage.com/
• https://up-for-grabs.net/#/
• http://issuehub.io/

Add Asciidoctor Jet announcement and update structure and files as per the template.

• Add this image.

To the resources section, add the following

• Refined GitHub browser extension
• GitZip for github browser extension
• https://try.github.io

NOTE:

• Add the first two points under a new sub-heading called Browser extensions for GitHub.
• Add the third point under the existing Git Documentation sub-heading.
• Add all points as links that open in external tabs.

• Read up on admonitions from the AsciiDoc Syntax Reference.
• The problem is that these icons are rendered in .adoc (Asciidoctor) files, but not in the rendered HTML file that is hosted.
  Eg:

.adoc file:

Rendered HTML file:

• See if the icons can be rendered.
• If not, a workaround could be to include the image files in ./src/images and then insert them using a style tag in the head of a Docinfo file.

https://harshkapadia2.github.io/git_basics/ says

Git actually compresses files with the zlib library and then hashes them

Which implied when I read it that a git hash is sha1(zlib_compress(data)).

However, the note a few paragraphs down corrects my misunderstanding:

If blob 16\0Git is amazing! is hashed using SHA1, the same hash (1a3851c172420a2198cf8ca6f2b776589d955cc5) will be generated!

Perhaps changing the original statement to something like "Git actually compresses files with the zlib library after hashing them"

• Still have the README, but may be with high level information and examples
• Then have a src folder for the more detailed docs

• Improve the '.gitignore file' sub-section.
  • Add a code block to the 'Syntax' section instead of points.
    • Add the missing syntax from https://riptutorial.com/git/example/885/ignoring-files-and-directories-with-a--gitignore-file
  • Shift the 'Ignore files locally without modifying .gitignore' section to the 'General # 2' section. (TBD)

• The alt tags of images are wrong at quite a few places.
• The image sizes have been taken as the alt attribute values at quite a few places. Correct the image size and add an alt attribute.
• Syntax: image::file_name.ext[..., alt="value"]
• Asciidoctor image syntax documentation

Make use of:

• Gaurav Sen's Git video
• git.md gist (explanation of the above video)

• A GitHub Learning Lab learning path - DevOps with GitHub Actions

• Git is apparently going to migrate to SHA256 from SHA1.
• Why doesn't Git use more modern SHA? - Stackoverflow article
• Any idea about the future or when this is going be implemented or any other tips on this issue?

To be added to the GitHub section (#5)

• Add contributing to Git
  • Git mentoring group
  • GitGitGadget

I came across a few git commands which you could add -

• git reflog
• git branch -vv
• git pull -r
• git stash
• git stash list
• git stash apply
• images of git reset and git rebase

• Section: Contributor Friendly Repository
• Learn about Changelogs and add that information in your own words in changelog.adoc in the https://github.com/HarshKapadia2/git_basics/tree/main/src/content/contributor_friendly_repo directory.
  • Make sure to add a reference to the file in the https://github.com/HarshKapadia2/git_basics/blob/main/src/refs/contributor_friendly_repo.adoc file.
• Make sure to read the https://github.com/HarshKapadia2/git_basics/blob/main/CONTRIBUTING.md file fore more instructions.
• Feel free to reference any resources to add information. It would be better to reference multiple resources.
  • Eg: Keep a Changelog
• Write about a changelog is, the need for a changelog, the format of a changelog, when to update a changelog, etc.

• .gitkeep

• Add a standard size to each picture.
• Format: image::img_name.ext[size, size]
• Size is usually [600, 600], but can be tweaked as per requirements.
• Check if size negatively affects mobile view.

As this website is on git and github so I think there should be one section about various opensource program.

• Plumbing and porcelian commands
• To show commit SHA1 of HEAD git rev-parse HEAD
• git gc --aggressive commands.
• Git LFS (large file system)
  • Conditions for large files on GitHub
  • Storage and Bandwidth Usage
  • Atlassian Git LFS overview (Also, the video at end of this article is a good watch.)
  • Official Git LFS page
  • Migrate history to or from Git LFS
  • Alternative way: Split files into multipart zip archive, then either use a Git Hook or a prebuild step to combine and unzip the files.
• Removing Accidentally Committed Files From Remote History

• This repo uses GitHub Actions and has a CI/CD process that builds the web site from the master branch and pushes all the built files to the gh-pages branch from where GitHub Pages deploys the site.
  • Check ./.github/workflows/build-website.yml for the exact working of the CI/CD process.
• If files are renamed in the master branch and the CI/CD process is run, the original file and the new renamed file are both found in the gh-pages branch.
• The problem to be solved is that the original file should not be present in the gh-pages branch after the CI/CD process runs.
• One solution could be to delete all the files in the gh-pages branch before the newly built files are pushed into the branch.
• Please note that, I do not want the entire gh-pages branch to be deleted and created every time the CI/CD process runs, as I want to have a history of the previous versions of the site.
• Do let me know if you have any other solution in mind.

This section will be placed after the GitHub section.

• Myths of open source. (Video ref)
  • Security issues
  • Monetary issues
  • Difficult to contribute
  • Only for the elite
  • Many more
• Advantages of open source.
  • Indirect value
  • Show case skill
  • Helping community
  • Many more

Please remove the extra hyphen in line no. 3 of CONTRIBUTING.md.

• Correct hyperlinks with text as 'here' or 'this' with meaningful text. (Might have to change the structure of sentence, obviously keeping the meaning and tense the same.)
  Eg:

  • This is the official documentation. ❌
  • Official documentation ✔️

• Remove hyperlinks on pictures.

The name "git" was given by Linus Torvalds when he wrote the very first version. He described the tool as "the stupid content tracker" and the name as (depending on your mood):

• random three-letter combination that is pronounceable, and not actually used by any common UNIX command. The fact that it is a mispronunciation of "get" may or may not be relevant.
• stupid. contemptible and despicable. simple. Take your pick from the dictionary of slang.
• "global information tracker": you're in a good mood, and it actually works for you. Angels sing, and a light suddenly fills the room.
• "goddamn idiotic truckload of sh*t": when it breaks

Source: https://github.com/git/git/blob/master/README.md (bottom of file)

PS: Add about the Git e-mail list (link in the abv README.md file itself.)

git commit --allow-empty -m "Empty commit"

It's like pushing a normal commit, except that you add the --allow-empty flag.

Reference: https://catalins.tech/git-empty-commit

• Add a link (with the timestamp of the appropriate section) of the git_basics livestream to the top of the appropriate section of the web site.
• All the topics and commands covered in the livestream are listed in the description of the video.
• On YouTube, click on 'share' and copy the link after checking the 'start at' checkbox (ensure that the correct timestamp for that section is entered in the input).

Eg: Add 'Watch a short video on git pull.' to the top of the git pull sub-section of the web site.

• Add a search feature on the web site.
• I am open to suggestions on the implementation and design.
• Optional reference article: https://medium.com/dev-channel/how-to-add-full-text-search-to-your-website-4e9c80ce2bf4

• Try to keep the background of the PWA icons transparent.

Add the following features:

• PRs

  • Learn how to make a PR (Can be added to the resources section as well.)
  • 'Allow maintainers to edit' checkbox implies that maintainers of the project can push code to the branch of the fork from which the PR was made to make changes to the PR.
    • (Example: Look at the owners of the two commits in the PR)
    • Making changes in a PR on your repo (Only if 'Allow edits by maintainers' checkbox is checked.)
      
  • Draft PRs
  • How to pull a PR to check it?
    • To update the new PR branch: In the PR branch (Eg: 'pr-123') run git fetch origin pull/123/head and then git merge FETCH_HEAD

• Issues

  • General info
  • Linking a pull request to an issue using a keyword

• CONTRIBUTING.md & contents

• README.md & contents

• Syncing a fork to the original repo.

  • Use this
  • Or use this

Since from now on all repositories have default branch main, I think either all masters on the website should be replaced by main, or a notification on top of the page could be given for now.

• Change pronouns in the Working Tree sub-section of the Terms section from second person ('you') to third person ('one').
  Eg:

  • You should do this. ❌
  • One should do this. ✔️

• File path: ./src/terms/working_tree.adoc

• • Add basic merge conflict handling in the Merge Conflicts section.
• During a merge conflict, git status -s gives output UU (both in red) for files that are conflicted.
  • What is the meaning?
  • • Add it to the -s or --short flag.
• Resolving a Git conflict with binary files
  • • Add --ours and --theirs to git checkout with a reference to https://github.com/HarshKapadia2/git_internals.
  • • Write a small article on this in the General #2 section.
  • • Refer to this in https://github.com/HarshKapadia2/git_internals.

• Add git stash working.

NOTE: Tackle this after issue #23.

• Currently, all external links (ie, links leading to web sites away from the git_basics web site itself) open in the same tab as the web site.
• All the external links should open in a separate tab.
• Implement the first method listed in the 'Links with attributes' sub-section of the Asciidoctor Syntax Reference.

• Add Branches section to the General # 2 section, after the Internal Working of Git sub-section.
• Use Gaurav Sen's Git video and this git for some commands

• The links in example code blocks are overflowing on the right side of the page. (The red borders are for debugging. The picture below is from the git clone sub-section of the web site.)

  

• Behaviour observed in the Android app of MS Edge and in browsers on iPhones (checked on Chrome and Safari iOS apps).

  • Chrome, Brave and Firefox's Android apps render the site properly.
  • NOTE: The Android app of MS Edge is still at Chromium v76 (?). The latest version of Chromium at the time of writing this issue is 93. (Edge mobile still at Chromium v7x)

• Try to break the link text so that it occupies just the viewport and does not overflow.

You could add the following commands

• git reset --soft HEAD~1 - used to revert the last commit and retain the changes when changes aren't pushed
• git reset --hard HEAD~1 - used to revert the last commit and discard the changes when changes aren't pushed