diff --git a/contents/docs/2-git-basics/commands/between-commits/index.mdx b/contents/docs/2-git-basics/commands/between-commits/index.mdx index 9f25fc2b..fb1d8843 100644 --- a/contents/docs/2-git-basics/commands/between-commits/index.mdx +++ b/contents/docs/2-git-basics/commands/between-commits/index.mdx @@ -1,11 +1,8 @@ --- -title: Between Commits description: Learn about Between Commits in Git - +title: Between Commits --- -# Between Commits - To compare two specific commits in your Git history, use git diff followed by the hashes of the commits. This will show you the changes made between those two points, including added, modified, and deleted lines. #### Free Resources diff --git a/contents/docs/2-git-basics/commands/checkout-tags/index.mdx b/contents/docs/2-git-basics/commands/checkout-tags/index.mdx index b6ff1376..a3f2924e 100644 --- a/contents/docs/2-git-basics/commands/checkout-tags/index.mdx +++ b/contents/docs/2-git-basics/commands/checkout-tags/index.mdx @@ -1,10 +1,8 @@ --- -title: Checkout Tags description: Learn about Checkout Tags in Git +title: Checkout Tags --- -# Checkout Tags - Tags in Git are typically used to mark specific points in history, such as a release version. Checking out a tag means switching your working directory to the state of the repository at the point in time when that tag was created. diff --git a/contents/docs/2-git-basics/commands/citation-files/index.mdx b/contents/docs/2-git-basics/commands/citation-files/index.mdx index b0db09aa..c83a873f 100644 --- a/contents/docs/2-git-basics/commands/citation-files/index.mdx +++ b/contents/docs/2-git-basics/commands/citation-files/index.mdx @@ -1,10 +1,8 @@ --- -title: Citation Files description: Learn about Citation Files in Git +title: Citation Files --- -# CITATION files - You can add a CITATION.cff file to the root of a repository to let others know how you would like them to cite your work. The citation file format is plain text with human- and machine-readable citation information. #### Free Resources diff --git a/contents/docs/2-git-basics/commands/collaboration/index.mdx b/contents/docs/2-git-basics/commands/collaboration/index.mdx index 0892a9d7..970d1028 100644 --- a/contents/docs/2-git-basics/commands/collaboration/index.mdx +++ b/contents/docs/2-git-basics/commands/collaboration/index.mdx @@ -1,10 +1,8 @@ --- -title: Collaboration description: Learn about Collaboration in Git +title: Collaboration --- -# Collaboration - When working on projects with others, Git provides tools to facilitate collaboration through forking repositories using `git clone` or `git fork`, cloning them locally with git clone, managing pull requests with `git request-pull`, and resolving merge conflicts. To contribute effectively, follow established contributing guides and respect open-source licenses that govern how contributors' work may be used by others. diff --git a/contents/docs/2-git-basics/commands/commit-messages/index.mdx b/contents/docs/2-git-basics/commands/commit-messages/index.mdx index ddea77fd..166a2143 100644 --- a/contents/docs/2-git-basics/commands/commit-messages/index.mdx +++ b/contents/docs/2-git-basics/commands/commit-messages/index.mdx @@ -1,10 +1,8 @@ --- -title: Commit Messages description: Learn about Commit Messages in Git +title: Commit Messages --- -# Commit Messages - A Git commit message is a brief explanation of the changes introduced in a particular commit. It helps others (and your future self) understand the purpose of the changes and the context behind them. Writing clear and informative commit messages is an important practice for maintaining a well-organized and easily navigable project history. #### Free Resources diff --git a/contents/docs/2-git-basics/commands/git-checkout/index.mdx b/contents/docs/2-git-basics/commands/git-checkout/index.mdx index bd0ad35d..51fe2535 100644 --- a/contents/docs/2-git-basics/commands/git-checkout/index.mdx +++ b/contents/docs/2-git-basics/commands/git-checkout/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Checkout description: Switching branches and restoring files with git checkout +title: Git Checkout --- -# Git Checkout - The `git checkout` command is used to switch between branches and restore files from different commits. ## Switching Branches diff --git a/contents/docs/2-git-basics/commands/git-commit---amend/index.mdx b/contents/docs/2-git-basics/commands/git-commit---amend/index.mdx index 6ebacc71..a7776778 100644 --- a/contents/docs/2-git-basics/commands/git-commit---amend/index.mdx +++ b/contents/docs/2-git-basics/commands/git-commit---amend/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Commit --amend description: How to modify the last commit with git commit --amend +title: Git Commit --amend --- -# Git Commit --amend - The `git commit --amend` command allows you to modify the most recent commit instead of creating a new one. ## When to Use diff --git a/contents/docs/2-git-basics/commands/git-lfs/index.mdx b/contents/docs/2-git-basics/commands/git-lfs/index.mdx index 706479cc..f84b1e36 100644 --- a/contents/docs/2-git-basics/commands/git-lfs/index.mdx +++ b/contents/docs/2-git-basics/commands/git-lfs/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Lfs description: Learn about Git Lfs in Git +title: Git Lfs --- -# Git LFS - Git Large File Storage (LFS) is an extension that helps manage large files by tracking metadata, not storing entire files. It allows storing and tracking binary assets like images, videos, audio files separately from your regular Git repository. By storing only metadata in your Git repository, you improve clone and push times, reducing storage usage. This approach is particularly useful for media repositories, large dataset storage, and binary asset management in game development. Note that Git LFS requires a separate server or storage system to store actual file content. #### Free Resources diff --git a/contents/docs/2-git-basics/commands/git-log-options/index.mdx b/contents/docs/2-git-basics/commands/git-log-options/index.mdx index 3c72629e..e4175aad 100644 --- a/contents/docs/2-git-basics/commands/git-log-options/index.mdx +++ b/contents/docs/2-git-basics/commands/git-log-options/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Log Options description: Common options and flags for the git log command +title: Git Log Options --- -# Git Log Options - The `git log` command comes with many useful options to customize the output and filter commits. ## Common Options diff --git a/contents/docs/2-git-basics/commands/git-reflog/index.mdx b/contents/docs/2-git-basics/commands/git-reflog/index.mdx index cfb4f878..f9bad01a 100644 --- a/contents/docs/2-git-basics/commands/git-reflog/index.mdx +++ b/contents/docs/2-git-basics/commands/git-reflog/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Reflog description: Understanding and using git reflog for recovery +title: Git Reflog --- -# Git Reflog - The `git reflog` command shows a log of where HEAD has been, allowing you to recover lost commits and branches. ## What is Reflog? diff --git a/contents/docs/2-git-basics/commands/git-remotes/index.mdx b/contents/docs/2-git-basics/commands/git-remotes/index.mdx index ad6a3cbd..8ac730e6 100644 --- a/contents/docs/2-git-basics/commands/git-remotes/index.mdx +++ b/contents/docs/2-git-basics/commands/git-remotes/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Remotes description: Learn about Git Remotes in Git +title: Git Remotes --- -# Git Remotes - In Git, a remote is a reference to a repository that exists on another server or system. Remotes allow you to access and interact with a copy of your repository that is stored elsewhere, making it possible to collaborate with others, share your work, and maintain multiple copies of your repository for backup and disaster recovery purposes. When you add a remote to your local repository, Git creates a reference to the remote repository, enabling you to push changes from your local repository to the remote one, pull changes from the remote to your local one, or fetch changes from the remote without updating your local copy. This enables distributed development and helps maintain a centralized version of your project's history, making it easier to track changes, manage conflicts, and ensure that everyone has access to the most up-to-date code. #### Free Resources diff --git a/contents/docs/2-git-basics/commands/git-reset/index.mdx b/contents/docs/2-git-basics/commands/git-reset/index.mdx index 050c2f4e..5ffc6d4e 100644 --- a/contents/docs/2-git-basics/commands/git-reset/index.mdx +++ b/contents/docs/2-git-basics/commands/git-reset/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Reset description: Understanding git reset and its different modes +title: Git Reset --- -# Git Reset - The `git reset` command is used to undo changes and move the HEAD pointer to a different commit. ## Reset Modes diff --git a/contents/docs/2-git-basics/commands/git-revert/index.mdx b/contents/docs/2-git-basics/commands/git-revert/index.mdx index 2b6716a1..348bc87d 100644 --- a/contents/docs/2-git-basics/commands/git-revert/index.mdx +++ b/contents/docs/2-git-basics/commands/git-revert/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Revert description: How to safely undo commits with git revert +title: Git Revert --- -# Git Revert - The `git revert` command creates a new commit that undoes the changes from a previous commit. Unlike `git reset`, it doesn't alter history. ## Why Use Revert? diff --git a/contents/docs/2-git-basics/commands/handling-conflicts/index.mdx b/contents/docs/2-git-basics/commands/handling-conflicts/index.mdx index a9ad7b7e..15a623d8 100644 --- a/contents/docs/2-git-basics/commands/handling-conflicts/index.mdx +++ b/contents/docs/2-git-basics/commands/handling-conflicts/index.mdx @@ -1,10 +1,8 @@ --- -title: Handling Conflicts description: Learn about Handling Conflicts in Git +title: Handling Conflicts --- -# Handling Conflicts - When multiple developers work on the same project simultaneously, conflicts can arise during the merging process. This occurs when changes made by different individuals overlap or contradict each other in a specific code file. In such situations, Git's conflict resolution mechanism comes into play, allowing users to manually resolve these issues and merge the conflicting changes. #### Free Resources diff --git a/contents/docs/2-git-basics/commands/history/index.mdx b/contents/docs/2-git-basics/commands/history/index.mdx index 043a264c..433d0f48 100644 --- a/contents/docs/2-git-basics/commands/history/index.mdx +++ b/contents/docs/2-git-basics/commands/history/index.mdx @@ -1,10 +1,8 @@ --- -title: History description: Learn about History in Git +title: History --- -# History - The history of a Git repository is a record of all commits made over time, including changes to files, commit messages, and metadata. This history is stored as a series of snapshots, with each commit representing a new version of the codebase. #### Free Resources diff --git a/contents/docs/2-git-basics/commands/managing-remotes/index.mdx b/contents/docs/2-git-basics/commands/managing-remotes/index.mdx index 4500fea6..b7679746 100644 --- a/contents/docs/2-git-basics/commands/managing-remotes/index.mdx +++ b/contents/docs/2-git-basics/commands/managing-remotes/index.mdx @@ -1,10 +1,8 @@ --- -title: Managing Remotes description: Learn about Managing Remotes in Git +title: Managing Remotes --- -# Managing Remotes - In Git, a remote repository refers to a copy of a project's source code stored on a server or other machine. - Adding remotes: Use `git remote add [name] [url]` to add a new remote repository. This allows you to track changes and push/pull updates from the remote. diff --git a/contents/docs/2-git-basics/commands/managing-tags/index.mdx b/contents/docs/2-git-basics/commands/managing-tags/index.mdx index bcb9fdae..946c9fea 100644 --- a/contents/docs/2-git-basics/commands/managing-tags/index.mdx +++ b/contents/docs/2-git-basics/commands/managing-tags/index.mdx @@ -1,10 +1,8 @@ --- -title: Managing Tags description: Learn about Managing Tags in Git +title: Managing Tags --- -# Managing Tags - In Git, a tag is a named reference to a specific commit in the project's history. - Creating tags: Use `git tag [name] [commit-hash]` to create a new tag. You can also use `git tag -a [name] -m "[message]" [commit-hash]` for annotated tags. diff --git a/contents/docs/2-git-basics/commands/pushing-tags/index.mdx b/contents/docs/2-git-basics/commands/pushing-tags/index.mdx index 18ff48ee..baa91a8a 100644 --- a/contents/docs/2-git-basics/commands/pushing-tags/index.mdx +++ b/contents/docs/2-git-basics/commands/pushing-tags/index.mdx @@ -1,10 +1,8 @@ --- -title: Pushing Tags description: Learn about Pushing Tags in Git +title: Pushing Tags --- -# Pushing Tags - Pushing tags in Git is the process of sharing your local tags with a remote repository. Tags in Git are used to mark specific points in the repository's history, typically to signify a release or a milestone. #### Free Resources diff --git a/contents/docs/2-git-basics/commands/staged-changes/index.mdx b/contents/docs/2-git-basics/commands/staged-changes/index.mdx index 6bce7921..df4b5910 100644 --- a/contents/docs/2-git-basics/commands/staged-changes/index.mdx +++ b/contents/docs/2-git-basics/commands/staged-changes/index.mdx @@ -1,10 +1,8 @@ --- -title: Staged Changes description: Learn about Staged Changes in Git +title: Staged Changes --- -# Staged Changes - To view the changes you've staged with `git add`, but not yet committed, use `git diff --cached`. This command compares the staged files against their original versions in the repository. It's a quick way to review what you're about to commit before finalizing it. #### Free Resources diff --git a/contents/docs/2-git-basics/commands/staging-area/index.mdx b/contents/docs/2-git-basics/commands/staging-area/index.mdx index f65af9b6..0c9284b7 100644 --- a/contents/docs/2-git-basics/commands/staging-area/index.mdx +++ b/contents/docs/2-git-basics/commands/staging-area/index.mdx @@ -1,10 +1,8 @@ --- -title: Staging Area description: Learn about Staging Area in Git +title: Staging Area --- -# Staging Area - In Git, a staging area serves as an intermediate step between your local repository changes and the actual commit. - Temporary storage: The staging area holds changes that are intended to be part of the next commit. diff --git a/contents/docs/2-git-basics/commands/submodules/index.mdx b/contents/docs/2-git-basics/commands/submodules/index.mdx index bb7c37bd..a755e3ac 100644 --- a/contents/docs/2-git-basics/commands/submodules/index.mdx +++ b/contents/docs/2-git-basics/commands/submodules/index.mdx @@ -1,10 +1,8 @@ --- -title: Submodules description: Learn about Submodules in Git +title: Submodules --- -# Submodules - In Git, submodules allow you to include another repository within a project. This feature enables the management of external dependencies as part of the main project. - Including external repositories: Submodules can be used to include other Git repositories within your project. diff --git a/contents/docs/2-git-basics/commands/tagging/index.mdx b/contents/docs/2-git-basics/commands/tagging/index.mdx index 0f7c93c9..fb37414a 100644 --- a/contents/docs/2-git-basics/commands/tagging/index.mdx +++ b/contents/docs/2-git-basics/commands/tagging/index.mdx @@ -1,10 +1,8 @@ --- -title: Tagging description: Learn about Tagging in Git +title: Tagging --- -# Tagging - In Git, tags are used to identify specific points in a repository's history as being important. This feature allows developers to mark release points or milestones. - Marking release points: Tags are typically used to mark release versions (e.g., v1.0, v2.0) of a project. diff --git a/contents/docs/2-git-basics/working-with-files/adding--updating/index.mdx b/contents/docs/2-git-basics/working-with-files/adding--updating/index.mdx index 32d60ec8..a16b2314 100644 --- a/contents/docs/2-git-basics/working-with-files/adding--updating/index.mdx +++ b/contents/docs/2-git-basics/working-with-files/adding--updating/index.mdx @@ -1,10 +1,8 @@ --- -title: Adding and Updating Files description: How to add new files and update existing files in Git +title: Adding and Updating Files --- -# Adding and Updating Files - Git tracks changes to files through explicit commands. You need to tell Git which files to include in your next commit. ## Adding New Files diff --git a/contents/docs/2-git-basics/working-with-files/git-attributes/index.mdx b/contents/docs/2-git-basics/working-with-files/git-attributes/index.mdx index e6d46b82..1a8e1687 100644 --- a/contents/docs/2-git-basics/working-with-files/git-attributes/index.mdx +++ b/contents/docs/2-git-basics/working-with-files/git-attributes/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Attributes description: Learn about Git Attributes in Git +title: Git Attributes --- -# Git Attributes - Git attributes are settings stored in the .gitattributes file, controlling how Git handles files in your repository. They can influence filtering (e.g., ignoring specific files), conversion (formatting or transforming files during Git operations), and formatting (applying consistent styles). These settings can be applied to specific file types (like *.txt) or filter files based on content patterns. Attributes also define smudge patterns (highlighting differences) and ignore patterns, helping maintain a clean repository by automatically applying intended settings for certain file types. diff --git a/contents/docs/2-git-basics/working-with-files/gitignore/index.mdx b/contents/docs/2-git-basics/working-with-files/gitignore/index.mdx index 2030b2bf..f10911dd 100644 --- a/contents/docs/2-git-basics/working-with-files/gitignore/index.mdx +++ b/contents/docs/2-git-basics/working-with-files/gitignore/index.mdx @@ -1,10 +1,8 @@ --- -title: .gitignore Files description: How to use .gitignore to exclude files from Git tracking +title: .gitignore Files --- -# .gitignore Files - The `.gitignore` file tells Git which files and directories to ignore in your repository. ## Creating .gitignore diff --git a/contents/docs/2-git-basics/working-with-files/gitkeep/index.mdx b/contents/docs/2-git-basics/working-with-files/gitkeep/index.mdx index b0317bf6..8fbbecf6 100644 --- a/contents/docs/2-git-basics/working-with-files/gitkeep/index.mdx +++ b/contents/docs/2-git-basics/working-with-files/gitkeep/index.mdx @@ -1,10 +1,8 @@ --- -title: .gitkeep Files description: How to track empty directories in Git using .gitkeep +title: .gitkeep Files --- -# .gitkeep Files - Git doesn't track empty directories. The `.gitkeep` file is a convention used to force Git to track empty directories. ## The Problem diff --git a/contents/docs/2-git-basics/working-with-files/staged-changes/index.mdx b/contents/docs/2-git-basics/working-with-files/staged-changes/index.mdx index c0e7aaba..ba465b0e 100644 --- a/contents/docs/2-git-basics/working-with-files/staged-changes/index.mdx +++ b/contents/docs/2-git-basics/working-with-files/staged-changes/index.mdx @@ -1,10 +1,8 @@ --- -title: Staged Changes description: Understanding the Git staging area and staged changes +title: Staged Changes --- -# Staged Changes - Staged changes are modifications that have been marked for inclusion in the next commit using `git add`. ## What Are Staged Changes? diff --git a/contents/docs/2-git-basics/working-with-files/unstaged-changes/index.mdx b/contents/docs/2-git-basics/working-with-files/unstaged-changes/index.mdx index 6e8f8c3d..a5f11b52 100644 --- a/contents/docs/2-git-basics/working-with-files/unstaged-changes/index.mdx +++ b/contents/docs/2-git-basics/working-with-files/unstaged-changes/index.mdx @@ -1,10 +1,8 @@ --- -title: Unstaged Changes description: Understanding unstaged changes in Git and how to manage them +title: Unstaged Changes --- -# Unstaged Changes - Unstaged changes are modifications to tracked files that haven't been added to the staging area yet. ## What Are Unstaged Changes? diff --git a/contents/docs/2-git-basics/working-with-files/working-directory/index.mdx b/contents/docs/2-git-basics/working-with-files/working-directory/index.mdx index 08898865..f1226c6e 100644 --- a/contents/docs/2-git-basics/working-with-files/working-directory/index.mdx +++ b/contents/docs/2-git-basics/working-with-files/working-directory/index.mdx @@ -1,10 +1,8 @@ --- -title: Working Directory description: Learn about Working Directory in Git +title: Working Directory --- -# Working Directory - A working directory in Git is the local environment where files are stored and modified as part of a project. It reflects the current state of the project's files, allowing developers to edit, add, or delete files. Changes made in the working directory can be staged for commit, which means they're prepared for inclusion in the next commit. The working directory is connected to the Git repository, and it helps manage the differences between the committed history and the current state of the files. It plays a central role in tracking changes, testing, and developing new features. Learn more from the following resources: diff --git a/contents/docs/3-git-branching/basics/between-branches/index.mdx b/contents/docs/3-git-branching/basics/between-branches/index.mdx index 44cd4f4e..d8e78f0a 100644 --- a/contents/docs/3-git-branching/basics/between-branches/index.mdx +++ b/contents/docs/3-git-branching/basics/between-branches/index.mdx @@ -1,10 +1,8 @@ --- -title: Between Branches description: Learn about Between Branches in Git +title: Between Branches --- -# Between Branches - When comparing the differences between two branches, such as a feature branch and its upstream parent branch, use `git diff ..`. This command displays the changes made on the feature branch relative to the parent branch. It's useful for reviewing the impact of new features or changes before merging them into your mainline. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/branch-naming/index.mdx b/contents/docs/3-git-branching/basics/branch-naming/index.mdx index f1d50176..64dd7b24 100644 --- a/contents/docs/3-git-branching/basics/branch-naming/index.mdx +++ b/contents/docs/3-git-branching/basics/branch-naming/index.mdx @@ -1,10 +1,8 @@ --- -title: Branch Naming description: Learn about Branch Naming in Git +title: Branch Naming --- -# Branch Naming - A well-defined branch naming convention is essential for maintaining a clean and organized Git workflow. It's recommended to use descriptive and meaningful names that clearly indicate the purpose of each branch. For example, using prefixes like `feature/`, `fix/`, or `docs/` can help identify whether a branch is related to new feature development, bug fixes, or documentation updates. Additionally, including the issue or task ID (e.g., `issue/123`) can provide context and make it easier for team members to find relevant information. By following a consistent naming convention, you can improve collaboration, reduce confusion, and increase the overall efficiency of your Git workflow. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/checkout-branch/index.mdx b/contents/docs/3-git-branching/basics/checkout-branch/index.mdx index d6d77c75..975ec517 100644 --- a/contents/docs/3-git-branching/basics/checkout-branch/index.mdx +++ b/contents/docs/3-git-branching/basics/checkout-branch/index.mdx @@ -1,10 +1,8 @@ --- -title: Checkout Branch description: Learn about Checkout Branch in Git +title: Checkout Branch --- -# Checkout Branch - In Git, to "checkout" from a branch means to switch your working directory to that branch, making it the active branch. This updates your files to match the state of that branch and allows you to work on it. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/cherry-picking-commits/index.mdx b/contents/docs/3-git-branching/basics/cherry-picking-commits/index.mdx index 72335754..6e993d33 100644 --- a/contents/docs/3-git-branching/basics/cherry-picking-commits/index.mdx +++ b/contents/docs/3-git-branching/basics/cherry-picking-commits/index.mdx @@ -1,10 +1,8 @@ --- -title: Cherry Picking Commits description: Learn about Cherry Picking Commits in Git +title: Cherry Picking Commits --- -# Cherry Picking Commits - Cherry-picking in Git allows you to apply a specific commit from one branch to another, without merging the entire branch. This is useful when you want to bring in a specific feature or fix from one branch to another without incorporating all the changes from the source branch. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/clean-git-history/index.mdx b/contents/docs/3-git-branching/basics/clean-git-history/index.mdx index 8d9527bc..f7f81ab5 100644 --- a/contents/docs/3-git-branching/basics/clean-git-history/index.mdx +++ b/contents/docs/3-git-branching/basics/clean-git-history/index.mdx @@ -1,10 +1,8 @@ --- -title: Clean Git History description: Learn about Clean Git History in Git +title: Clean Git History --- -# Clean Git History - Cleaning up Git history can make your commit history more readable, concise, and organized. Here are some of the reasons why you'd want to clean your git history: - makes it easy to decipher the order of the commits in your repository diff --git a/contents/docs/3-git-branching/basics/code-reviews/index.mdx b/contents/docs/3-git-branching/basics/code-reviews/index.mdx index 8ed0a5cc..d87cd581 100644 --- a/contents/docs/3-git-branching/basics/code-reviews/index.mdx +++ b/contents/docs/3-git-branching/basics/code-reviews/index.mdx @@ -1,10 +1,8 @@ --- -title: Code Reviews description: Learn about Code Reviews in Git +title: Code Reviews --- -# Code Reviews - The purpose of a code review in software development is to help ensure that the code meets the organization’s standards and requirements, is of high quality, and is maintainable. In addition to identifying errors and bugs, code reviews also promote a culture of learning and collaboration among the development team. Some of the benefits of code reviews include: diff --git a/contents/docs/3-git-branching/basics/collaborators/index.mdx b/contents/docs/3-git-branching/basics/collaborators/index.mdx index 1dda6d04..b1b07efd 100644 --- a/contents/docs/3-git-branching/basics/collaborators/index.mdx +++ b/contents/docs/3-git-branching/basics/collaborators/index.mdx @@ -1,10 +1,8 @@ --- -title: Collaborators description: Learn about Collaborators in Git +title: Collaborators --- -# Collaborators - Collaborators in GitHub are users who have been granted direct access to a repository by the repository owner or organization administrators. Collaborators can perform actions like pushing commits, creating branches, and managing issues or pull requests, depending on the permissions granted to them. They are typically added to private repositories or to public repositories where more control over contributions is needed. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/creating-branch/index.mdx b/contents/docs/3-git-branching/basics/creating-branch/index.mdx index a3d5ab2f..d7b493e2 100644 --- a/contents/docs/3-git-branching/basics/creating-branch/index.mdx +++ b/contents/docs/3-git-branching/basics/creating-branch/index.mdx @@ -1,10 +1,8 @@ --- -title: Creating Branch description: Learn about Creating Branch in Git +title: Creating Branch --- -# Creating Branch - Creating a branch in Git is a fundamental part of working with version control, allowing you to work on different features or fixes without affecting the main codebase. You can create branches either through the terminal or github interface #### Free Resources diff --git a/contents/docs/3-git-branching/basics/deleting-branch/index.mdx b/contents/docs/3-git-branching/basics/deleting-branch/index.mdx index a5641784..e1909d43 100644 --- a/contents/docs/3-git-branching/basics/deleting-branch/index.mdx +++ b/contents/docs/3-git-branching/basics/deleting-branch/index.mdx @@ -1,10 +1,8 @@ --- -title: Deleting Branch description: Learn about Deleting Branch in Git +title: Deleting Branch --- -# Deleting Branch - Deleting a Git branch means removing a line of development from your Git repository. A branch in Git is essentially a pointer to a specific commit, representing an independent line of development. When you delete a branch, you’re removing this pointer, making that line of development no longer accessible through the branch name. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/detached-head/index.mdx b/contents/docs/3-git-branching/basics/detached-head/index.mdx index f638ebdc..b2768c74 100644 --- a/contents/docs/3-git-branching/basics/detached-head/index.mdx +++ b/contents/docs/3-git-branching/basics/detached-head/index.mdx @@ -1,10 +1,8 @@ --- -title: Detached Head description: Learn about Detached Head in Git +title: Detached Head --- -# Detached HEAD - In Git, a detached head occurs when you check out a commit directly using its hash instead of a branch name. This leaves your repository's HEAD pointer pointing directly at that commit, rather than being linked to a specific branch. To view the history and changes made in a detached head, use `git log` or `git show`. If you want to see the differences between the current detached head and another branch, use `git diff `. A detached head can be a useful temporary state for exploring specific commits or features, but it's essential to merge those changes back into a branch before sharing them with others. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/git-log-options/index.mdx b/contents/docs/3-git-branching/basics/git-log-options/index.mdx index 5fc98f15..64d12e63 100644 --- a/contents/docs/3-git-branching/basics/git-log-options/index.mdx +++ b/contents/docs/3-git-branching/basics/git-log-options/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Log Options description: Learn about Git Log Options in Git +title: Git Log Options --- -# git log options - `git log` is a command in Git that shows the commit history of your repository. It provides a detailed view of all commits, including their hashes, authors, dates, and messages. Here are some common git log options: diff --git a/contents/docs/3-git-branching/basics/git-patch/index.mdx b/contents/docs/3-git-branching/basics/git-patch/index.mdx index eb3a2d87..74f0ac82 100644 --- a/contents/docs/3-git-branching/basics/git-patch/index.mdx +++ b/contents/docs/3-git-branching/basics/git-patch/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Patch description: Learn about Git Patch in Git +title: Git Patch --- -# Git Patch - In Git, a patch is a file that contains a set of changes made to a project's codebase. It's essentially a diff (difference) file that shows the modifications between two versions of a commit or a branch. However, despite its usefulness in certain contexts, the use of Git patches has declined somewhat with the advent of more modern and efficient ways to manage code changes. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/git-rebase/index.mdx b/contents/docs/3-git-branching/basics/git-rebase/index.mdx index 276ca8e2..a771f4be 100644 --- a/contents/docs/3-git-branching/basics/git-rebase/index.mdx +++ b/contents/docs/3-git-branching/basics/git-rebase/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Rebase description: Learn about Git Rebase in Git +title: Git Rebase --- -# git rebase - Git rebase is a powerful command in Git that allows you to integrate changes from one branch into another. Unlike git merge, which creates a new commit to combine the histories of two branches, git rebase moves or applies commits from one branch on top of another, effectively re-writing the commit history. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/git-reflog/index.mdx b/contents/docs/3-git-branching/basics/git-reflog/index.mdx index 8db39615..c91ffc1a 100644 --- a/contents/docs/3-git-branching/basics/git-reflog/index.mdx +++ b/contents/docs/3-git-branching/basics/git-reflog/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Reflog description: Learn about Git Reflog in Git +title: Git Reflog --- -# Git Reflog - Git reflog is a powerful tool in Git that keeps a record of all the changes made to the branches and commits in your repository, including actions that are not part of the regular commit history, such as resetting branches or checking out commits. It's particularly useful for recovering lost commits or understanding the history of changes in your repository, even if those changes are not reflected in the normal commit history.Reflog stands for "reference log." It records when the tip of branches or other references (like HEAD) is updated in your repository. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/git-reset/index.mdx b/contents/docs/3-git-branching/basics/git-reset/index.mdx index f5cfc188..46d0aa1e 100644 --- a/contents/docs/3-git-branching/basics/git-reset/index.mdx +++ b/contents/docs/3-git-branching/basics/git-reset/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Reset description: Learn about Git Reset in Git +title: Git Reset --- -# git reset - Git reset is a command that allows you to "undo" or reset your current branch to a previous state by moving its HEAD pointer, effectively discarding changes made since then. When using git reset, it's essential to specify one of the three modes: soft, hard, or mixed. The mode you choose will determine how Git interacts with files in your working directory and staging area. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/git-revert/index.mdx b/contents/docs/3-git-branching/basics/git-revert/index.mdx index ad41dbfc..5bf5e8e6 100644 --- a/contents/docs/3-git-branching/basics/git-revert/index.mdx +++ b/contents/docs/3-git-branching/basics/git-revert/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Revert description: Learn about Git Revert in Git +title: Git Revert --- -# git revert - Git revert is a command that allows you to "undo" or revert specific commits in your Git repository. It creates a new commit that reverses the changes made by the specified commit(s), effectively rolling back your code to a previous state. Here are some key things to know about `git revert`: diff --git a/contents/docs/3-git-branching/basics/git-vs-other-vcs/index.mdx b/contents/docs/3-git-branching/basics/git-vs-other-vcs/index.mdx index 984d0dd3..483ebcb9 100644 --- a/contents/docs/3-git-branching/basics/git-vs-other-vcs/index.mdx +++ b/contents/docs/3-git-branching/basics/git-vs-other-vcs/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Vs Other Vcs description: Learn about Git Vs Other Vcs in Git +title: Git Vs Other Vcs --- -# Git vs Other VCS - Git has become the de facto standard for source control in software development, but it's not the only version control system (VCS) available. Here are some key differences between Git and other popular VCS: - Mercurial: Mercurial is a distributed VCS that uses a similar architecture to Git. However, it has a more centralized approach and doesn't use hashes for tracking changes. diff --git a/contents/docs/3-git-branching/basics/git-worktree/index.mdx b/contents/docs/3-git-branching/basics/git-worktree/index.mdx index 3c412b83..f4cb95de 100644 --- a/contents/docs/3-git-branching/basics/git-worktree/index.mdx +++ b/contents/docs/3-git-branching/basics/git-worktree/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Worktree description: Learn about Git Worktree in Git +title: Git Worktree --- -# Git Worktree - A Git worktree allows you to create multiple working directories for a single repository, each with its own checkout and index. Unlike a regular checkout, which creates a new working directory for a specific branch and updates your IDE's configuration settings, a Git worktree does not require you to switch between branches using git checkout. This means you can have multiple branches checked out at the same time without affecting each other or requiring changes to your IDE configurations. By creating a separate worktree for each branch, you can stage changes independently and maintain distinct working directories without impacting the main repository or its working directory. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/github-essentials/index.mdx b/contents/docs/3-git-branching/basics/github-essentials/index.mdx index 3047c239..1bf469ed 100644 --- a/contents/docs/3-git-branching/basics/github-essentials/index.mdx +++ b/contents/docs/3-git-branching/basics/github-essentials/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Essentials description: Learn about Github Essentials in Git +title: Github Essentials --- -# GitHub Essentials - GitHub Essentials refers to the core features and functionalities that form the foundation of GitHub's version control and collaboration platform. These essentials include repositories for storing and managing code, branches for parallel development, pull requests for code review and merging, issues for tracking tasks and bugs, and collaborative tools like project boards and wikis. Understanding and mastering these fundamental components allows developers to effectively manage their projects, collaborate with team members, and contribute to open-source initiatives, making GitHub an indispensable tool in modern software development workflows. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/head/index.mdx b/contents/docs/3-git-branching/basics/head/index.mdx index 87d6c0ec..929dfa63 100644 --- a/contents/docs/3-git-branching/basics/head/index.mdx +++ b/contents/docs/3-git-branching/basics/head/index.mdx @@ -1,10 +1,8 @@ --- -title: Head description: Learn about Head in Git +title: Head --- -# HEAD - The `HEAD` file is at the core of how Git knows the SHA-1 of the last commit when running commands like `git branch `. It serves as a symbolic reference, pointing to the current branch. However, in rare cases, HEAD can contain the actual SHA-1 value of a Git object, such as when checking out a tag, commit, or remote branch, which puts your repository in a "detached HEAD" state. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/merging-basics/index.mdx b/contents/docs/3-git-branching/basics/merging-basics/index.mdx index 59be4d85..4057f862 100644 --- a/contents/docs/3-git-branching/basics/merging-basics/index.mdx +++ b/contents/docs/3-git-branching/basics/merging-basics/index.mdx @@ -1,10 +1,8 @@ --- -title: Merging Basics description: Learn about Merging Basics in Git +title: Merging Basics --- -# Merging Basics - A merge in Git is the process of combining changes from one branch into another. When you want to integrate updates from one branch (the source) into another branch (the target), you need to perform a merge. This involves resolving conflicts between the two branches, if any exist. The goal of merging is to create a new commit that represents the combined changes from both branches, resulting in a single, cohesive history for your project. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/more-git/index.mdx b/contents/docs/3-git-branching/basics/more-git/index.mdx index d8baee0f..2792ef94 100644 --- a/contents/docs/3-git-branching/basics/more-git/index.mdx +++ b/contents/docs/3-git-branching/basics/more-git/index.mdx @@ -1,10 +1,8 @@ --- -title: More Git description: Learn about More Git in Git +title: More Git --- -# More Git - Git offers several advanced features to manage complex scenarios, including hard resets with `git reset`, reverting changes with `git revert`, reordering commits with `git rebase`, merging in new changes with `git merge`, squashing commits into a single change, temporarily saving uncommitted changes with `git stash` and then applying them with `git stash apply`, and selectively picking specific commits from one branch to apply on another with `git cherry-pick`. Learn more from the the following resources: diff --git a/contents/docs/3-git-branching/basics/rebase/index.mdx b/contents/docs/3-git-branching/basics/rebase/index.mdx index 19220700..2ee4f26d 100644 --- a/contents/docs/3-git-branching/basics/rebase/index.mdx +++ b/contents/docs/3-git-branching/basics/rebase/index.mdx @@ -1,10 +1,8 @@ --- -title: Rebase description: Learn about Rebase in Git +title: Rebase --- -# Rebase - Rebasing in Git is a powerful and potentially complex feature used to reorganize or modify a series of commits. The primary purpose of rebasing is to create a cleaner, more linear project history by moving or combining changes from one branch onto another. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/renaming-branch/index.mdx b/contents/docs/3-git-branching/basics/renaming-branch/index.mdx index 3d37d931..a97df328 100644 --- a/contents/docs/3-git-branching/basics/renaming-branch/index.mdx +++ b/contents/docs/3-git-branching/basics/renaming-branch/index.mdx @@ -1,10 +1,8 @@ --- -title: Renaming Branch description: Learn about Renaming Branch in Git +title: Renaming Branch --- -# Renaming Branch - Renaming a branch in Git means changing the name of a branch to something different while preserving its history and the commits it contains. The branch itself remains the same in terms of the code and history it tracks, but the reference (the name by which you refer to it) is updated #### Free Resources diff --git a/contents/docs/3-git-branching/basics/rewriting-history/index.mdx b/contents/docs/3-git-branching/basics/rewriting-history/index.mdx index 99bbf658..20acdc3d 100644 --- a/contents/docs/3-git-branching/basics/rewriting-history/index.mdx +++ b/contents/docs/3-git-branching/basics/rewriting-history/index.mdx @@ -1,10 +1,8 @@ --- -title: Rewriting History description: Learn about Rewriting History in Git +title: Rewriting History --- -# Rewriting History - In certain situations, you might need to modify or remove commits from your Git repository's history. This can be achieved using various methods: - `git commit --amend`: Allows you to edit the most recent commit. diff --git a/contents/docs/3-git-branching/basics/squash/index.mdx b/contents/docs/3-git-branching/basics/squash/index.mdx index c9c7307b..6f1f1403 100644 --- a/contents/docs/3-git-branching/basics/squash/index.mdx +++ b/contents/docs/3-git-branching/basics/squash/index.mdx @@ -1,10 +1,8 @@ --- -title: Squash description: Learn about Squash in Git +title: Squash --- -# Squash - Squashing in Git, refers to the process of combining multiple commits into a single commit. This is often done to create a cleaner and more concise commit history, especially before merging a feature branch into the main branch. #### Free Resources diff --git a/contents/docs/3-git-branching/basics/undoing-changes/index.mdx b/contents/docs/3-git-branching/basics/undoing-changes/index.mdx index 6c8710da..70c1b5ef 100644 --- a/contents/docs/3-git-branching/basics/undoing-changes/index.mdx +++ b/contents/docs/3-git-branching/basics/undoing-changes/index.mdx @@ -1,10 +1,8 @@ --- -title: Undoing Changes description: Learn about Undoing Changes in Git +title: Undoing Changes --- -# Undoing Changes - If mistakes or unwanted changes have been committed to your Git repository, there are ways to correct them. Two common methods for reverting changes include: - Git Reset: Resets the branch to a previous commit. diff --git a/contents/docs/3-git-branching/basics/working-in-a-team/index.mdx b/contents/docs/3-git-branching/basics/working-in-a-team/index.mdx index 32d4612f..3119b916 100644 --- a/contents/docs/3-git-branching/basics/working-in-a-team/index.mdx +++ b/contents/docs/3-git-branching/basics/working-in-a-team/index.mdx @@ -1,10 +1,8 @@ --- -title: Working In A Team description: Learn about Working In A Team in Git +title: Working In A Team --- -# Working in a Team - Working in a team on GitHub involves collaborative development using Git's distributed version control system. Team members can work on separate branches, create pull requests for code reviews, and merge changes into the main codebase. GitHub's features like issues, projects, and discussions facilitate communication and project management. Effective teamwork on GitHub requires clear communication, adherence to agreed-upon workflows, and proper use of Git commands to manage code changes and resolve conflicts. This collaborative approach enables teams to work efficiently on complex projects, maintain code quality, and track progress effectively. GitHub also offers an organization and team management interface, allowing teams to manage projects, members, and collaboration settings. diff --git a/contents/docs/3-git-branching/merging/merge-strategies/index.mdx b/contents/docs/3-git-branching/merging/merge-strategies/index.mdx index 8c91ff43..06883f79 100644 --- a/contents/docs/3-git-branching/merging/merge-strategies/index.mdx +++ b/contents/docs/3-git-branching/merging/merge-strategies/index.mdx @@ -1,10 +1,8 @@ --- -title: Merge Strategies description: Learn about Merge Strategies in Git +title: Merge Strategies --- -# Merge Strategies - When combining changes from one branch into another, Git provides various merge strategies to choose from. These methods allow for flexibility and customization in integrating code updates into your main branch. The available options include: - Fast Forward (FF) diff --git a/contents/docs/3-git-branching/remote/pull-requests/index.mdx b/contents/docs/3-git-branching/remote/pull-requests/index.mdx index 244e1502..8b15c987 100644 --- a/contents/docs/3-git-branching/remote/pull-requests/index.mdx +++ b/contents/docs/3-git-branching/remote/pull-requests/index.mdx @@ -1,10 +1,8 @@ --- -title: Pull Requests description: Learn about Pull Requests in Git +title: Pull Requests --- -# Pull Requests - You can use GitHub CLI to manage pull requests with the following commands: - `gh pr create`: Create a new pull request. diff --git a/contents/docs/4-git-advanced/recovery/git-reflog/index.mdx b/contents/docs/4-git-advanced/recovery/git-reflog/index.mdx index f6c5d0c0..a795a650 100644 --- a/contents/docs/4-git-advanced/recovery/git-reflog/index.mdx +++ b/contents/docs/4-git-advanced/recovery/git-reflog/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Reflog description: Learn how to recover lost commits using git reflog +title: Git Reflog --- -# Git Reflog - Git reflog records when the tips of branches and other references were updated in your local repository. It's your safety net for recovering lost commits. ## Basic Usage diff --git a/contents/docs/4-git-advanced/recovery/undoing-changes/index.mdx b/contents/docs/4-git-advanced/recovery/undoing-changes/index.mdx index fd6af263..7115a3eb 100644 --- a/contents/docs/4-git-advanced/recovery/undoing-changes/index.mdx +++ b/contents/docs/4-git-advanced/recovery/undoing-changes/index.mdx @@ -1,10 +1,8 @@ --- -title: Undoing Changes description: Learn different ways to undo changes in Git +title: Undoing Changes --- -# Undoing Changes - Git provides multiple ways to undo changes depending on where the changes are and what you want to achieve. ## Undoing Working Directory Changes diff --git a/contents/docs/4-git-advanced/rewriting-history/amending-commits/index.mdx b/contents/docs/4-git-advanced/rewriting-history/amending-commits/index.mdx index fe2e7fa8..21228e5a 100644 --- a/contents/docs/4-git-advanced/rewriting-history/amending-commits/index.mdx +++ b/contents/docs/4-git-advanced/rewriting-history/amending-commits/index.mdx @@ -1,10 +1,8 @@ --- -title: Amending Commits description: Learn how to modify the most recent Git commit efficiently +title: Amending Commits --- -# Amending Commits - Amending commits is one of the most frequently used Git features for quickly correcting mistakes in your most recent commit. It allows you to modify the commit message, add forgotten files, or update the commit content without creating a new commit. ## What is Commit Amending? diff --git a/contents/docs/4-git-advanced/rewriting-history/cherry-picking-commits/index.mdx b/contents/docs/4-git-advanced/rewriting-history/cherry-picking-commits/index.mdx index 47faabe9..728cc109 100644 --- a/contents/docs/4-git-advanced/rewriting-history/cherry-picking-commits/index.mdx +++ b/contents/docs/4-git-advanced/rewriting-history/cherry-picking-commits/index.mdx @@ -1,10 +1,8 @@ --- -title: Cherry-Picking Commits description: Learn how to selectively apply commits from one branch to another +title: Cherry-Picking Commits --- -# Cherry-Picking Commits - Cherry-picking is a Git technique that allows you to apply specific commits from one branch to another without merging the entire branch. This is useful when you need to selectively apply bug fixes, features, or other changes. ## Basic Cherry-Pick diff --git a/contents/docs/4-git-advanced/rewriting-history/clean-git-history/index.mdx b/contents/docs/4-git-advanced/rewriting-history/clean-git-history/index.mdx index 4ee34a8d..5a884ca2 100644 --- a/contents/docs/4-git-advanced/rewriting-history/clean-git-history/index.mdx +++ b/contents/docs/4-git-advanced/rewriting-history/clean-git-history/index.mdx @@ -1,10 +1,8 @@ --- -title: Clean Git History description: Learn best practices for maintaining clean and meaningful Git history +title: Clean Git History --- -# Clean Git History - Maintaining a clean Git history is crucial for project readability, debugging, and collaboration. A well-maintained history tells the story of your project's development in a clear, logical manner. ## What is Clean Git History? diff --git a/contents/docs/4-git-advanced/rewriting-history/git-commit---amend/index.mdx b/contents/docs/4-git-advanced/rewriting-history/git-commit---amend/index.mdx index 6cfaaa2b..2fe0d762 100644 --- a/contents/docs/4-git-advanced/rewriting-history/git-commit---amend/index.mdx +++ b/contents/docs/4-git-advanced/rewriting-history/git-commit---amend/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Commit --amend description: Quick reference for git commit --amend command +title: Git Commit --amend --- -# Git Commit --amend - The `git commit --amend` command allows you to modify the most recent commit. It's the quickest way to fix mistakes in your last commit. ## Basic Usage diff --git a/contents/docs/4-git-advanced/rewriting-history/git-filter-branch/index.mdx b/contents/docs/4-git-advanced/rewriting-history/git-filter-branch/index.mdx index de718363..30076abc 100644 --- a/contents/docs/4-git-advanced/rewriting-history/git-filter-branch/index.mdx +++ b/contents/docs/4-git-advanced/rewriting-history/git-filter-branch/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Filter Branch description: Learn about Git Filter Branch for advanced history rewriting +title: Git Filter Branch --- -# Git Filter Branch - Git filter-branch is a powerful command that allows you to rewrite Git history by filtering and modifying commits across entire branches or repositories. It's useful for large-scale history modifications that can't be easily accomplished with interactive rebase. ## What is Git Filter Branch? diff --git a/contents/docs/4-git-advanced/rewriting-history/git-push---force/index.mdx b/contents/docs/4-git-advanced/rewriting-history/git-push---force/index.mdx index 695729f5..76a82ed1 100644 --- a/contents/docs/4-git-advanced/rewriting-history/git-push---force/index.mdx +++ b/contents/docs/4-git-advanced/rewriting-history/git-push---force/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Push --force description: Learn about force pushing and when to use it safely +title: Git Push --force --- -# Git Push --force - Force pushing overwrites the remote branch with your local changes. Use with extreme caution as it can overwrite other people's work. ## Basic Commands diff --git a/contents/docs/4-git-advanced/rewriting-history/git-rebase/index.mdx b/contents/docs/4-git-advanced/rewriting-history/git-rebase/index.mdx index bcf0103d..24074962 100644 --- a/contents/docs/4-git-advanced/rewriting-history/git-rebase/index.mdx +++ b/contents/docs/4-git-advanced/rewriting-history/git-rebase/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Rebase description: Learn about Git Rebase for rewriting commit history +title: Git Rebase --- -# Git Rebase - Git rebase is a powerful command that allows you to integrate changes from one branch into another by moving or combining commits. Unlike merge, which creates a new commit to join two branches, rebase rewrites the commit history by applying commits from one branch onto another. ## Basic Rebase diff --git a/contents/docs/4-git-advanced/rewriting-history/squashing-commits/index.mdx b/contents/docs/4-git-advanced/rewriting-history/squashing-commits/index.mdx index 4653d2c4..042ce053 100644 --- a/contents/docs/4-git-advanced/rewriting-history/squashing-commits/index.mdx +++ b/contents/docs/4-git-advanced/rewriting-history/squashing-commits/index.mdx @@ -1,10 +1,8 @@ --- -title: Squashing Commits description: Learn how to combine multiple commits into a single commit +title: Squashing Commits --- -# Squashing Commits - Squashing commits is the process of combining multiple commits into a single commit. This is useful for cleaning up your commit history, especially when you have many small commits that are better represented as one logical change. ## Why Squash Commits? diff --git a/contents/docs/4-git-advanced/tools/basic-git-usage/index.mdx b/contents/docs/4-git-advanced/tools/basic-git-usage/index.mdx index 79de7189..30632676 100644 --- a/contents/docs/4-git-advanced/tools/basic-git-usage/index.mdx +++ b/contents/docs/4-git-advanced/tools/basic-git-usage/index.mdx @@ -1,10 +1,8 @@ --- -title: Basic Git Usage description: Learn about Basic Git Usage in Git +title: Basic Git Usage --- -# Basic Git Usage - Starting with a new project, you'll use `git init` to initialize a repository and then make changes using `git add`. Once ready, commit your work with `git commit`. If mistakes occur, `git reset` can help correct them. You'll also interact with remote repositories, whether private or public, by adding remotes (git remote add) and managing their connections through commands like `git fetch`, `git push`, and `git pull`. #### Free Resources diff --git a/contents/docs/4-git-advanced/tools/fetch-without-merge/index.mdx b/contents/docs/4-git-advanced/tools/fetch-without-merge/index.mdx index db481e61..4a9b04e2 100644 --- a/contents/docs/4-git-advanced/tools/fetch-without-merge/index.mdx +++ b/contents/docs/4-git-advanced/tools/fetch-without-merge/index.mdx @@ -1,10 +1,8 @@ --- -title: Fetch Without Merge description: Learn about Fetch Without Merge in Git +title: Fetch Without Merge --- -# Fetch without Merge - Running `git fetch` retrieves changes from a remote repository into your local clone, but does not automatically merge any of these changes into your local working directory. This is different from `git pull`, which both fetches and merges remote changes. By using fetch without merge, you can ensure that your local clone is up-to-date with the latest information from the remote repository, while leaving your working directory unchanged. You can then choose to apply these changes by using merge or rebase. This approach helps maintain a clean and consistent local state, making it easier to manage and commit changes. #### Free Resources diff --git a/contents/docs/4-git-advanced/tools/git-bisect/index.mdx b/contents/docs/4-git-advanced/tools/git-bisect/index.mdx index c569e270..4d599bb2 100644 --- a/contents/docs/4-git-advanced/tools/git-bisect/index.mdx +++ b/contents/docs/4-git-advanced/tools/git-bisect/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Bisect description: Learn about Git Bisect in Git +title: Git Bisect --- -# Git Bisect - Git Bisect is an interactive tool used to identify which commit in your project's history introduced a bug or regression. You start by identifying two commits: one where the issue isn't present (the "good" commit) and another where it is (the "bad" commit). Then, run `git bisect start`, followed by `git bisect good` for the good commit and `git bisect bad` for the bad commit. Git Bisect will guide you through a binary search process, asking you to test the midpoint of your current range until it identifies the exact commit that introduced the bug or regression. #### Free Resources diff --git a/contents/docs/4-git-advanced/tools/git-lfs/index.mdx b/contents/docs/4-git-advanced/tools/git-lfs/index.mdx index df262d03..feb79341 100644 --- a/contents/docs/4-git-advanced/tools/git-lfs/index.mdx +++ b/contents/docs/4-git-advanced/tools/git-lfs/index.mdx @@ -1,10 +1,8 @@ --- -title: Git LFS description: Learn how to handle large files with Git Large File Storage +title: Git LFS --- -# Git LFS - Git Large File Storage (LFS) replaces large files with text pointers inside Git, while storing the file contents on a remote server. ## Installation diff --git a/contents/docs/4-git-advanced/tools/git-patch/index.mdx b/contents/docs/4-git-advanced/tools/git-patch/index.mdx index e69d3054..57047d21 100644 --- a/contents/docs/4-git-advanced/tools/git-patch/index.mdx +++ b/contents/docs/4-git-advanced/tools/git-patch/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Patch description: Learn how to create and apply patches with Git +title: Git Patch --- -# Git Patch - Git patches allow you to share changes as files without using a remote repository. Useful for code reviews, contributions, and offline sharing. ## Creating Patches diff --git a/contents/docs/4-git-advanced/tools/git-stash-basics/index.mdx b/contents/docs/4-git-advanced/tools/git-stash-basics/index.mdx index a7f8c7cd..8f594718 100644 --- a/contents/docs/4-git-advanced/tools/git-stash-basics/index.mdx +++ b/contents/docs/4-git-advanced/tools/git-stash-basics/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Stash Basics description: Learn about Git Stash Basics in Git +title: Git Stash Basics --- -# Git Stash Basics - Git stash allows you to temporarily save your changes, or "stashes", when they're not yet ready for commit. This feature is useful when you need to work on multiple tasks, and want to switch between them without committing changes that are not complete. By using `git stash`, you can quickly stash uncommitted changes, reset the working directory to a clean state, and then apply the stashed changes later when they're ready for commit. This helps avoid cluttering the commit history with incomplete work, and allows you to maintain a clean and organized repository by separating your progress on different tasks. To apply a stash in Git, you can use the following commands: diff --git a/contents/docs/4-git-advanced/tools/git-stash/index.mdx b/contents/docs/4-git-advanced/tools/git-stash/index.mdx index b008f8a2..fbd1af87 100644 --- a/contents/docs/4-git-advanced/tools/git-stash/index.mdx +++ b/contents/docs/4-git-advanced/tools/git-stash/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Stash description: Learn how to temporarily save changes with git stash +title: Git Stash --- -# Git Stash - Git stash temporarily saves your uncommitted changes so you can work on something else, then come back and re-apply them later. ## Basic Commands diff --git a/contents/docs/4-git-advanced/tools/git-worktree/index.mdx b/contents/docs/4-git-advanced/tools/git-worktree/index.mdx index ac4025ad..3a94a40a 100644 --- a/contents/docs/4-git-advanced/tools/git-worktree/index.mdx +++ b/contents/docs/4-git-advanced/tools/git-worktree/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Worktree description: Learn how to work with multiple branches simultaneously using git worktree +title: Git Worktree --- -# Git Worktree - Git worktree allows you to have multiple working directories for the same repository, each checking out different branches. ## Basic Commands diff --git a/contents/docs/4-git-advanced/tools/index.mdx b/contents/docs/4-git-advanced/tools/index.mdx index 9aa796ee..ade3b132 100644 --- a/contents/docs/4-git-advanced/tools/index.mdx +++ b/contents/docs/4-git-advanced/tools/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Tools description: Learn about Git Tools +title: Git Tools --- -# Git Tools - Git provides a variety of powerful tools to enhance your workflow and manage your repositories effectively. This section covers essential Git tools that can help you become more productive with Git. ## Key Git Tools diff --git a/contents/docs/5-github/actions/github-actions/index.mdx b/contents/docs/5-github/actions/github-actions/index.mdx index 8e4d95f0..31046854 100644 --- a/contents/docs/5-github/actions/github-actions/index.mdx +++ b/contents/docs/5-github/actions/github-actions/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Actions description: Learn about Github Actions in Git +title: Github Actions --- -# GitHub Actions - GitHub Actions is a very useful tool for automation, allowing developers to automate tasks within the software development lifecycle directly on GitHub. One of the best ways to learn about GitHub Actions is through the course offered by Microsoft Learn. This course is well-structured and provides practical examples that are concise and easy to understand. diff --git a/contents/docs/5-github/actions/marketplace-actions/index.mdx b/contents/docs/5-github/actions/marketplace-actions/index.mdx index ad6c659f..fa9a919b 100644 --- a/contents/docs/5-github/actions/marketplace-actions/index.mdx +++ b/contents/docs/5-github/actions/marketplace-actions/index.mdx @@ -1,10 +1,8 @@ --- -title: Marketplace Actions description: Learn about Marketplace Actions in Git +title: Marketplace Actions --- -# Marketplace Actions - The GitHub Marketplace offers a wide range of pre-built actions that can be used to automate tasks and workflows within your repository. - Automate tasks: Use marketplace actions to automate tasks such as testing, deployment, or security. diff --git a/contents/docs/5-github/actions/reactions/index.mdx b/contents/docs/5-github/actions/reactions/index.mdx index 98a3faa5..2c2c769a 100644 --- a/contents/docs/5-github/actions/reactions/index.mdx +++ b/contents/docs/5-github/actions/reactions/index.mdx @@ -1,10 +1,8 @@ --- -title: Reactions description: Learn about Reactions in Git +title: Reactions --- -# Reactions - Reactions in GitHub are a way for users to express their feelings or opinions about issues, pull requests, comments, and other discussions without adding additional comments. They are similar to "likes" or "emojis" on social media platforms, providing a quick and non-verbal way to engage with content. #### Free Resources diff --git a/contents/docs/5-github/actions/workflow-context/index.mdx b/contents/docs/5-github/actions/workflow-context/index.mdx index c72347b0..c9db4491 100644 --- a/contents/docs/5-github/actions/workflow-context/index.mdx +++ b/contents/docs/5-github/actions/workflow-context/index.mdx @@ -1,10 +1,8 @@ --- -title: Workflow Context description: Learn about Workflow Context in Git +title: Workflow Context --- -# Workflow Context - Workflow context in GitHub Actions refers to the environment and variables that are available to a workflow. It includes information about the workflow's execution, such as the event that triggered it, the repository, and the workflow itself. Learn more from the following resources: diff --git a/contents/docs/5-github/actions/workflow-runners/index.mdx b/contents/docs/5-github/actions/workflow-runners/index.mdx index a6ff9fe2..484bc1d4 100644 --- a/contents/docs/5-github/actions/workflow-runners/index.mdx +++ b/contents/docs/5-github/actions/workflow-runners/index.mdx @@ -1,10 +1,8 @@ --- -title: Workflow Runners description: Learn about Workflow Runners in Git +title: Workflow Runners --- -# Workflow Runners - Workflow runners are the environments where GitHub Actions workflows are executed. They are hosted on GitHub-hosted virtual machines (GHVMs) or self-hosted runners. Each runner has a specific configuration and capabilities, depending on its type. Learn more from the following resources: diff --git a/contents/docs/5-github/actions/workflow-status/index.mdx b/contents/docs/5-github/actions/workflow-status/index.mdx index f0b2712d..3600c4bb 100644 --- a/contents/docs/5-github/actions/workflow-status/index.mdx +++ b/contents/docs/5-github/actions/workflow-status/index.mdx @@ -1,10 +1,8 @@ --- -title: Workflow Status description: Learn about Workflow Status in Git +title: Workflow Status --- -# Workflow Status - Workflow status in GitHub Actions refers to the current state of a workflow run. It can be one of the following: - Pending: The workflow is waiting for an event to trigger it. diff --git a/contents/docs/5-github/actions/workflow-triggers/index.mdx b/contents/docs/5-github/actions/workflow-triggers/index.mdx index 0ddf8f38..24c51720 100644 --- a/contents/docs/5-github/actions/workflow-triggers/index.mdx +++ b/contents/docs/5-github/actions/workflow-triggers/index.mdx @@ -1,10 +1,8 @@ --- -title: Workflow Triggers description: Learn about Workflow Triggers in Git +title: Workflow Triggers --- -# Workflow Triggers - Workflow triggers are events that initiate a GitHub Actions workflow. They can be scheduled, triggered by code changes, or manually initiated. This allows for automation of tasks based on specific conditions. Learn more from the following resources: diff --git a/contents/docs/5-github/basics/automations/index.mdx b/contents/docs/5-github/basics/automations/index.mdx index 8c62d39b..0640468d 100644 --- a/contents/docs/5-github/basics/automations/index.mdx +++ b/contents/docs/5-github/basics/automations/index.mdx @@ -1,10 +1,8 @@ --- -title: Automations description: Learn about Automations in Git +title: Automations --- -# Automations - To add automation to your GitHub project, use built-in workflows that can trigger actions such as setting fields on item changes or archiving items meeting specific criteria, and also configure automatic item addition from repositories based on matching criteria. #### Free Resources diff --git a/contents/docs/5-github/basics/caching-dependencies/index.mdx b/contents/docs/5-github/basics/caching-dependencies/index.mdx index fb8378c1..51a3fbf1 100644 --- a/contents/docs/5-github/basics/caching-dependencies/index.mdx +++ b/contents/docs/5-github/basics/caching-dependencies/index.mdx @@ -1,10 +1,8 @@ --- -title: Caching Dependencies description: Learn about Caching Dependencies in Git +title: Caching Dependencies --- -# Caching Dependencies - GitHub Actions provides a caching feature that allows you to store and reuse dependencies between workflows, reducing the time it takes to run your actions. By caching dependencies, you can: - Reuse compiled code diff --git a/contents/docs/5-github/basics/campus-program/index.mdx b/contents/docs/5-github/basics/campus-program/index.mdx index bd6dc726..7cbe6e54 100644 --- a/contents/docs/5-github/basics/campus-program/index.mdx +++ b/contents/docs/5-github/basics/campus-program/index.mdx @@ -1,10 +1,8 @@ --- -title: Campus Program description: Learn about Campus Program in Git +title: Campus Program --- -# Campus Program - The GitHub Campus Program offers GitHub Enterprise Cloud and GitHub Enterprise Server free-of-charge for schools that want to make the most of GitHub for their community. This program provides access to a comprehensive set of developer tools, as well as resources and support to help students and educators build projects, collaborate, and develop skills in software development. Visit the following resource to learn more: diff --git a/contents/docs/5-github/basics/cloning-repositories/index.mdx b/contents/docs/5-github/basics/cloning-repositories/index.mdx index a904abba..39459b72 100644 --- a/contents/docs/5-github/basics/cloning-repositories/index.mdx +++ b/contents/docs/5-github/basics/cloning-repositories/index.mdx @@ -1,10 +1,8 @@ --- -title: Cloning Repositories description: Learn about Cloning Repositories in Git +title: Cloning Repositories --- -# Cloning Repositories - Cloning a repository in Git and GitHub involves creating a local copy of a remote repository on your computer. This allows you to work on the project locally, commit changes, and later push those changes back to the remote repository. #### Free Resources diff --git a/contents/docs/5-github/basics/collaboration-on-github/index.mdx b/contents/docs/5-github/basics/collaboration-on-github/index.mdx index d87856fe..2ed7e539 100644 --- a/contents/docs/5-github/basics/collaboration-on-github/index.mdx +++ b/contents/docs/5-github/basics/collaboration-on-github/index.mdx @@ -1,10 +1,8 @@ --- -title: Collaboration On Github description: Learn about Collaboration On Github in Git +title: Collaboration On Github --- -# Collaboration on GitHub - Collaboration on GitHub is a powerful way for multiple people to work together on the same project, using Git as the version control system. GitHub provides various tools and workflows that make collaboration efficient and organized. #### Free Resources diff --git a/contents/docs/5-github/basics/contribution-guidelines/index.mdx b/contents/docs/5-github/basics/contribution-guidelines/index.mdx index 8b22f7dd..a23840d5 100644 --- a/contents/docs/5-github/basics/contribution-guidelines/index.mdx +++ b/contents/docs/5-github/basics/contribution-guidelines/index.mdx @@ -1,10 +1,8 @@ --- -title: Contribution Guidelines description: Learn about Contribution Guidelines in Git +title: Contribution Guidelines --- -# Contribution Guidelines - Contribution guidelines are essential for collaborative projects on GitHub as they help streamline collaboration, set expectations for contributions, and maintain the project's quality and consistency. #### Free Resources diff --git a/contents/docs/5-github/basics/creating-apps/index.mdx b/contents/docs/5-github/basics/creating-apps/index.mdx index 722ce368..3dd33093 100644 --- a/contents/docs/5-github/basics/creating-apps/index.mdx +++ b/contents/docs/5-github/basics/creating-apps/index.mdx @@ -1,10 +1,8 @@ --- -title: Creating Apps description: Learn about Creating Apps in Git +title: Creating Apps --- -# Creating Apps - GitHub Apps are a way to integrate with the GitHub platform programmatically, using either the REST API or GraphQL API. They allow developers to create custom integrations that can automate tasks, provide real-time notifications, and build custom workflows. #### Free Resources diff --git a/contents/docs/5-github/basics/creating-repositories/index.mdx b/contents/docs/5-github/basics/creating-repositories/index.mdx index 8bfdb267..3ef13584 100644 --- a/contents/docs/5-github/basics/creating-repositories/index.mdx +++ b/contents/docs/5-github/basics/creating-repositories/index.mdx @@ -1,10 +1,8 @@ --- -title: Creating Repositories description: Learn about Creating Repositories in Git +title: Creating Repositories --- -# Creating Repositories - Creating a Git repository means setting up a system to track changes in your project's files over time. This is crucial for version control, allowing you to manage, review, and collaborate on code efficiently. #### Free Resources diff --git a/contents/docs/5-github/basics/custom-domains/index.mdx b/contents/docs/5-github/basics/custom-domains/index.mdx index b8e8fc03..15c68f5b 100644 --- a/contents/docs/5-github/basics/custom-domains/index.mdx +++ b/contents/docs/5-github/basics/custom-domains/index.mdx @@ -1,10 +1,8 @@ --- -title: Custom Domains description: Learn about Custom Domains in Git +title: Custom Domains --- -# Custom Domains - On GitHub Pages, users can customize their site's URL by connecting a custom domain to their repository. This feature allows users to use their own domain name instead of the default GitHub.io subdomain, giving their site a more professional and personalized look. #### Free Resources diff --git a/contents/docs/5-github/basics/deploying-static-websites/index.mdx b/contents/docs/5-github/basics/deploying-static-websites/index.mdx index 0adf1a59..18b1e740 100644 --- a/contents/docs/5-github/basics/deploying-static-websites/index.mdx +++ b/contents/docs/5-github/basics/deploying-static-websites/index.mdx @@ -1,10 +1,8 @@ --- -title: Deploying Static Websites description: Learn about Deploying Static Websites in Git +title: Deploying Static Websites --- -# Deploying Static Websites - Deploying static websites on GitHub Pages involves uploading and serving website content that is generated beforehand, without dynamic functionality. This approach allows for fast deployment, low maintenance, and improved security. #### Free Resources diff --git a/contents/docs/5-github/basics/documentation/index.mdx b/contents/docs/5-github/basics/documentation/index.mdx index cc3b39c6..cbdab244 100644 --- a/contents/docs/5-github/basics/documentation/index.mdx +++ b/contents/docs/5-github/basics/documentation/index.mdx @@ -1,10 +1,8 @@ --- -title: Documentation description: Learn about Documentation in Git +title: Documentation --- -# Documentation - A well-maintained repository should include documentation that helps others understand the project, its context, and how to contribute to it. This is essential for fostering a community around your project and making it easier for newcomers to join in. Here are some key sections of documentation that you should consider including in each repository: diff --git a/contents/docs/5-github/basics/forking-vs-cloning/index.mdx b/contents/docs/5-github/basics/forking-vs-cloning/index.mdx index 52e8b485..3a5877d6 100644 --- a/contents/docs/5-github/basics/forking-vs-cloning/index.mdx +++ b/contents/docs/5-github/basics/forking-vs-cloning/index.mdx @@ -1,10 +1,8 @@ --- -title: Forking Vs Cloning description: Learn about Forking Vs Cloning in Git +title: Forking Vs Cloning --- -# Forking vs Cloning - Forking and cloning are two fundamental concepts in Git, particularly when working with repositories hosted on platforms like GitHub, GitLab, or Bitbucket. While both actions involve copying a repository, they serve different purposes and have distinct workflows. Cloning a repository means creating a local copy of a repository that exists on a remote server (e.g., GitHub) on your local machine. This allows you to work on the project locally, make changes, and then push those changes back to the remote repository if you have the necessary permissions. Forking a repository is specific to platforms like GitHub, GitLab, and Bitbucket. When you fork a repository, you create a copy of someone else’s repository in your own account. This forked repository is independent of the original and can be modified without affecting the original project. diff --git a/contents/docs/5-github/basics/github-api/index.mdx b/contents/docs/5-github/basics/github-api/index.mdx index 0475e874..f4bbca43 100644 --- a/contents/docs/5-github/basics/github-api/index.mdx +++ b/contents/docs/5-github/basics/github-api/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Api description: Learn about Github Api in Git +title: Github Api --- -# GitHub API - The GitHub API is a powerful tool that allows developers to interact with the GitHub platform programmatically. It provides access to various GitHub features, such as user data, repository information, and commit history, through both REST and GraphQL interfaces. The API supports authentication, implements rate limiting, and offers webhooks for real-time notifications, enabling developers to automate tasks, create custom integrations, and build applications that leverage GitHub's functionality. #### Free Resources diff --git a/contents/docs/5-github/basics/github-apps/index.mdx b/contents/docs/5-github/basics/github-apps/index.mdx index 7970fb69..d08bf026 100644 --- a/contents/docs/5-github/basics/github-apps/index.mdx +++ b/contents/docs/5-github/basics/github-apps/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Apps description: Learn about Github Apps in Git +title: Github Apps --- -# GitHub Apps - A GitHub App is a way to integrate with the GitHub platform programmatically, using either the REST API or GraphQL API. It allows developers to create custom integrations that can automate tasks, provide real-time notifications, and build custom workflows. #### Free Resources diff --git a/contents/docs/5-github/basics/github-classroom/index.mdx b/contents/docs/5-github/basics/github-classroom/index.mdx index b9a17fa6..b5e2737d 100644 --- a/contents/docs/5-github/basics/github-classroom/index.mdx +++ b/contents/docs/5-github/basics/github-classroom/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Classroom description: Learn about Github Classroom in Git +title: Github Classroom --- -# GitHub Classroom - GitHub Classroom is an integrated feature within GitHub that allows educators to create and assign homework assignments, projects, or quizzes directly to students. This feature streamlines the process of teaching and learning by making it easy for instructors to share code, provide feedback, and track student progress all in one place. By using GitHub Classroom, teachers can focus on high-level instruction and student engagement, while also promoting collaboration and hands-on learning experiences. #### Free Resources diff --git a/contents/docs/5-github/basics/github-cli/index.mdx b/contents/docs/5-github/basics/github-cli/index.mdx index 90463e9a..38e812ba 100644 --- a/contents/docs/5-github/basics/github-cli/index.mdx +++ b/contents/docs/5-github/basics/github-cli/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Cli description: Learn about Github Cli in Git +title: Github Cli --- -# GitHub CLI - GitHub CLI is a command-line interface tool that brings GitHub functionality to your terminal. It allows developers to interact with GitHub directly from the command line, enabling them to manage repositories, create issues, pull requests, and perform various GitHub operations without leaving their terminal environment. This powerful tool streamlines workflows, enhances productivity, and provides a seamless integration between local development and GitHub's collaborative features, making it easier for developers to incorporate GitHub into their daily coding routines. #### Free Resources diff --git a/contents/docs/5-github/basics/github-codespaces/index.mdx b/contents/docs/5-github/basics/github-codespaces/index.mdx index f73c57b2..9a964dd0 100644 --- a/contents/docs/5-github/basics/github-codespaces/index.mdx +++ b/contents/docs/5-github/basics/github-codespaces/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Codespaces description: Learn about Github Codespaces in Git +title: Github Codespaces --- -# GitHub Codespaces - GitHub Codespaces is a cloud-based development environment that allows developers to create, access, and use pre-configured, ready-to-use environments for coding. It provides a seamless way to develop, test, and debug applications in a virtual machine or container, eliminating the need for local setup and configuration. With GitHub Codespaces, users can spin up a new environment with their desired configuration, tools, and dependencies in just a few clicks. This feature streamlines development workflows, reduces friction, and increases productivity by providing instant access to a tailored coding environment for each project. #### Free Resources diff --git a/contents/docs/5-github/basics/github-copilot/index.mdx b/contents/docs/5-github/basics/github-copilot/index.mdx index d928ebf8..ce1fb21b 100644 --- a/contents/docs/5-github/basics/github-copilot/index.mdx +++ b/contents/docs/5-github/basics/github-copilot/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Copilot description: Learn about Github Copilot in Git +title: Github Copilot --- -# GitHub Copilot - GitHub Copilot is an AI-powered code-completion tool that helps developers write code faster and with less errors. It uses a combination of machine learning algorithms and access to GitHub's vast repository of open-source code to provide context-aware suggestions for coding tasks. Copilot can generate entire functions, methods, or even entire classes based on the context of the code being written. This feature aims to reduce the time spent on coding by providing immediate and relevant suggestions, allowing developers to focus more on high-level design and problem-solving. #### Free Resources diff --git a/contents/docs/5-github/basics/github-discussions/index.mdx b/contents/docs/5-github/basics/github-discussions/index.mdx index fdad0fa1..42621bbb 100644 --- a/contents/docs/5-github/basics/github-discussions/index.mdx +++ b/contents/docs/5-github/basics/github-discussions/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Discussions description: Learn about Github Discussions in Git +title: Github Discussions --- -# GitHub Discussions - GitHub Discussions is a collaborative communication feature within GitHub repositories that provides a dedicated space for community conversations, questions, and knowledge sharing. It allows team members, contributors, and users to engage in threaded discussions, share ideas, ask for help, and make announcements outside of specific code changes or issues. This feature enhances project collaboration by centralizing important conversations, reducing noise in the issue tracker, and fostering a sense of community around open-source projects or team initiatives. #### Free Resources diff --git a/contents/docs/5-github/basics/github-education/index.mdx b/contents/docs/5-github/basics/github-education/index.mdx index f9d55c3e..4885e8f7 100644 --- a/contents/docs/5-github/basics/github-education/index.mdx +++ b/contents/docs/5-github/basics/github-education/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Education description: Learn about Github Education in Git +title: Github Education --- -# GitHub Education - GitHub Education is a program that provides free and discounted access to GitHub's developer tools, services, and resources for students, teachers, and researchers. This program aims to support education and research in software development, by making it easier for students and educators to learn, collaborate, and build projects on GitHub. By using GitHub Education, students can gain hands-on experience with real-world coding challenges, while educators can create a more engaging and interactive learning environment. #### Free Resources diff --git a/contents/docs/5-github/basics/github-gists/index.mdx b/contents/docs/5-github/basics/github-gists/index.mdx index 71573f81..6e780edf 100644 --- a/contents/docs/5-github/basics/github-gists/index.mdx +++ b/contents/docs/5-github/basics/github-gists/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Gists description: Learn about Github Gists in Git +title: Github Gists --- -# GitHub Gists - A GitHub Gist is a small code or text snippet that can be shared with others. It is a simple way to share code, configuration files, or other snippets of text without creating a full-fledged repository. Gists are useful for sharing examples, demos, or tutorials, and they can also serve as a starting point for larger projects. Each gist has a unique URL that can be shared with others, allowing them to view and edit the content. Gists support various file types, including code files, text files, and even images. They also provide features like syntax highlighting, line numbers, and commit history. #### Free Resources diff --git a/contents/docs/5-github/basics/github-interface/index.mdx b/contents/docs/5-github/basics/github-interface/index.mdx index 83a7e677..3db2fcd3 100644 --- a/contents/docs/5-github/basics/github-interface/index.mdx +++ b/contents/docs/5-github/basics/github-interface/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Interface description: Learn about Github Interface in Git +title: Github Interface --- -# GitHub Interface - The GitHub interface is a web-based platform that provides a user-friendly environment for managing and collaborating on software projects. It offers a comprehensive set of tools and features accessible through an intuitive layout, including repository management, code browsing, issue tracking, pull requests, and project boards. The interface is designed to streamline workflows, facilitate team communication, and enhance productivity for developers of all skill levels. With its clean and organized structure, users can easily navigate between different sections of their projects, review code changes, manage tasks, and interact with team members, making it an essential tool for modern software development and version control. #### Free Resources diff --git a/contents/docs/5-github/basics/github-marketplace/index.mdx b/contents/docs/5-github/basics/github-marketplace/index.mdx index cfb443fa..6089d882 100644 --- a/contents/docs/5-github/basics/github-marketplace/index.mdx +++ b/contents/docs/5-github/basics/github-marketplace/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Marketplace description: Learn about Github Marketplace in Git +title: Github Marketplace --- -# GitHub Marketplace - GitHub Marketplace is a platform that allows developers to discover, install, and manage third-party tools and services directly within their GitHub environment. These tools can provide a range of features, such as code analysis, project management, or collaboration, making it easier for developers to work efficiently and effectively. By using the GitHub Marketplace, developers can streamline their workflow, reduce friction, and focus on writing code. #### Free Resources diff --git a/contents/docs/5-github/basics/github-models/index.mdx b/contents/docs/5-github/basics/github-models/index.mdx index 5eb2c110..2e1c4094 100644 --- a/contents/docs/5-github/basics/github-models/index.mdx +++ b/contents/docs/5-github/basics/github-models/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Models description: Learn about Github Models in Git +title: Github Models --- -# GitHub Models - GitHub Models is a feature that allows developers to search, explore, and use pre-trained AI models from various sources. This platform provides a way to discover and experiment with these models, making it easier to integrate AI capabilities into software projects. By using GitHub Models, developers can quickly find and try out different models, without having to train them from scratch. #### Free Resources diff --git a/contents/docs/5-github/basics/github-organizations/index.mdx b/contents/docs/5-github/basics/github-organizations/index.mdx index d4c35f10..cdbc8354 100644 --- a/contents/docs/5-github/basics/github-organizations/index.mdx +++ b/contents/docs/5-github/basics/github-organizations/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Organizations description: Learn about Github Organizations in Git +title: Github Organizations --- -# GitHub Organizations - GitHub Organizations are shared accounts that provide centralized management and collaboration for multiple projects and teams. They offer enhanced administrative controls, allowing owners to create teams with specific access permissions, manage member roles, and oversee repositories at scale. Organizations facilitate better project coordination, resource sharing, and team communication, making them ideal for businesses, open-source projects, and large-scale collaborations. With features like team discussions, project boards, and audit logs, GitHub Organizations streamline workflow management and foster a more structured and secure development environment. #### Free Resources diff --git a/contents/docs/5-github/basics/github-packages/index.mdx b/contents/docs/5-github/basics/github-packages/index.mdx index 1741b9c6..8a8ef1c6 100644 --- a/contents/docs/5-github/basics/github-packages/index.mdx +++ b/contents/docs/5-github/basics/github-packages/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Packages description: Learn about Github Packages in Git +title: Github Packages --- -# GitHub Packages - GitHub Packages is a package repository service that allows developers to store and share packages, containers, and other software artifacts. It provides a central location for sharing packages with teams, organizations, or the wider developer community. GitHub Packages supports popular package managers like npm, Maven, and Gradle, as well as container registries like Docker Hub. This feature enables seamless integration of packages into development workflows, making it easier to share dependencies, libraries, and frameworks within and across projects. By using GitHub Packages, developers can simplify dependency management, reduce errors, and improve overall collaboration. #### Free Resources diff --git a/contents/docs/5-github/basics/github-pages/index.mdx b/contents/docs/5-github/basics/github-pages/index.mdx index f1f8d376..3e547e36 100644 --- a/contents/docs/5-github/basics/github-pages/index.mdx +++ b/contents/docs/5-github/basics/github-pages/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Pages description: Learn about Github Pages in Git +title: Github Pages --- -# GitHub Pages - GitHub Pages is a feature that allows users to host and publish web content directly from their GitHub repositories. It provides a simple way to create and deploy websites, blogs, or projects without the need for manual configuration or maintenance. Users can upload custom themes, add plugins, and use various tools to customize their pages. #### Free Resources diff --git a/contents/docs/5-github/basics/github-projects/index.mdx b/contents/docs/5-github/basics/github-projects/index.mdx index 1980387e..63056869 100644 --- a/contents/docs/5-github/basics/github-projects/index.mdx +++ b/contents/docs/5-github/basics/github-projects/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Projects description: Learn about Github Projects in Git +title: Github Projects --- -# GitHub Projects - GitHub Projects is a flexible project management tool integrated directly into GitHub repositories. It allows teams to create customizable project boards, track issues and pull requests, and manage workflows using Kanban-style columns or table views. With features like automated workflows, custom fields, and various visualization options, GitHub Projects helps teams organize, prioritize, and track work across multiple repositories. This tool enhances collaboration, increases transparency, and streamlines project management processes, making it easier for developers and stakeholders to stay aligned on project goals and progress. #### Free Resources diff --git a/contents/docs/5-github/basics/github-releases/index.mdx b/contents/docs/5-github/basics/github-releases/index.mdx index 2e06840c..fae6a784 100644 --- a/contents/docs/5-github/basics/github-releases/index.mdx +++ b/contents/docs/5-github/basics/github-releases/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Releases description: Learn about Github Releases in Git +title: Github Releases --- -# GitHub Releases - GitHub Releases is a feature that allows developers to package and distribute software versions to users. It provides a way to create tagged points in a repository's history, attach binary files (such as compiled executables or packaged code), and include release notes. This feature makes it easy to track and manage different versions of a project, share pre-compiled binaries with users who may not want to build from source, and communicate changes and updates to the community. GitHub Releases integrates seamlessly with Git tags and can be automated as part of a continuous integration and deployment pipeline. #### Free Resources diff --git a/contents/docs/5-github/basics/github-security/index.mdx b/contents/docs/5-github/basics/github-security/index.mdx index ffa64269..e8f32777 100644 --- a/contents/docs/5-github/basics/github-security/index.mdx +++ b/contents/docs/5-github/basics/github-security/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Security description: Learn about Github Security in Git +title: Github Security --- -# GitHub Security - GitHub Security is a suite of features and tools that help developers identify, fix, and prevent security vulnerabilities in their code. It provides a comprehensive approach to secure coding practices by integrating with the developer's workflow. The main components of GitHub Security include: `Code Scanning`, which uses AI-powered analysis to detect potential vulnerabilities; `Dependabot`, which automates dependency updates to prevent attacks via vulnerable dependencies; `Secret scanning`, which detects and flags secrets like API keys or credentials; and `GitHub Advanced Security`, which offers more advanced security features for larger teams. By using these tools, developers can ensure their code is secure, and identify potential issues before they become serious problems. #### Free Resources diff --git a/contents/docs/5-github/basics/github-sponsors/index.mdx b/contents/docs/5-github/basics/github-sponsors/index.mdx index 7b900c7e..a631f501 100644 --- a/contents/docs/5-github/basics/github-sponsors/index.mdx +++ b/contents/docs/5-github/basics/github-sponsors/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Sponsors description: Learn about Github Sponsors in Git +title: Github Sponsors --- -# GitHub Sponsors - A GitHub Sponsor is a way to support and fund open-source projects on GitHub. It allows maintainers of public repositories to receive financial support from users who value their work. Sponsors can contribute funds to help with expenses, development time, or other project-related costs. In return, sponsors are recognized as supporters in the repository's README file and on the project's website. This feature promotes transparency, accountability, and appreciation within open-source communities, making it easier for maintainers to focus on their projects. #### Free Resources diff --git a/contents/docs/5-github/basics/github-wikis/index.mdx b/contents/docs/5-github/basics/github-wikis/index.mdx index 87814619..ab2ebd17 100644 --- a/contents/docs/5-github/basics/github-wikis/index.mdx +++ b/contents/docs/5-github/basics/github-wikis/index.mdx @@ -1,10 +1,8 @@ --- -title: Github Wikis description: Learn about Github Wikis in Git +title: Github Wikis --- -# GitHub Wikis - GitHub Wikis are collaborative documentation spaces integrated directly into GitHub repositories. They provide a platform for teams to create, edit, and organize project-related information, such as documentation, guidelines, and FAQs. Wikis support Markdown formatting, making it easy to structure content and include images or links. With version control and the ability to clone wiki repositories, teams can collaboratively maintain up-to-date documentation alongside their code, enhancing project understanding and facilitating knowledge sharing among contributors and users. #### Free Resources diff --git a/contents/docs/5-github/basics/graphql-api/index.mdx b/contents/docs/5-github/basics/graphql-api/index.mdx index 9a1340e8..6de0cb4d 100644 --- a/contents/docs/5-github/basics/graphql-api/index.mdx +++ b/contents/docs/5-github/basics/graphql-api/index.mdx @@ -1,10 +1,8 @@ --- -title: Graphql Api description: Learn about Graphql Api in Git +title: Graphql Api --- -# GraphQL API - The GitHub GraphQL API is a set of APIs that provides access to various GitHub features, such as user data, repository information, and commit history. It allows developers to interact with the GitHub platform programmatically using GraphQL queries. #### Free Resources diff --git a/contents/docs/5-github/basics/installation-and-setup/index.mdx b/contents/docs/5-github/basics/installation-and-setup/index.mdx index 00420dc3..fe3907e6 100644 --- a/contents/docs/5-github/basics/installation-and-setup/index.mdx +++ b/contents/docs/5-github/basics/installation-and-setup/index.mdx @@ -1,10 +1,8 @@ --- -title: Installation And Setup description: Learn about Installation And Setup in Git +title: Installation And Setup --- -# Installation and Setup - The GitHub CLI can be installed on Windows, macOS, and Linux operating systems. Installation options include downloading binaries directly from the release page or using package managers (such as homebrew, pip, etc). Once installed, setting up the GitHub CLI typically involves authenticating with your GitHub account by running `gh auth login` in your terminal. This step is essential for linking your GitHub credentials to the CLI, allowing you to interact with your repositories and perform various actions. diff --git a/contents/docs/5-github/basics/installing-git-locally/index.mdx b/contents/docs/5-github/basics/installing-git-locally/index.mdx index ff58a469..395506f7 100644 --- a/contents/docs/5-github/basics/installing-git-locally/index.mdx +++ b/contents/docs/5-github/basics/installing-git-locally/index.mdx @@ -1,10 +1,8 @@ --- -title: Installing Git Locally description: Learn about Installing Git Locally in Git +title: Installing Git Locally --- -# Installing Git Locally - To use Git on your local machine, you need to install it first. The installation process varies depending on your operating system: - On Windows: Download the binary from the official Git or GitHub release page and follow the installation instructions. diff --git a/contents/docs/5-github/basics/kanban-boards/index.mdx b/contents/docs/5-github/basics/kanban-boards/index.mdx index 5fc63787..a42fa51f 100644 --- a/contents/docs/5-github/basics/kanban-boards/index.mdx +++ b/contents/docs/5-github/basics/kanban-boards/index.mdx @@ -1,10 +1,8 @@ --- -title: Kanban Boards description: Learn about Kanban Boards in Git +title: Kanban Boards --- -# Kanban Boards - On GitHub, Kanban boards provide a visual representation of issues as they move through the development process. A Kanban board typically has columns representing different stages or states, such as "To-Do", "In-Progress", and "Done". Each issue is represented by a card on the board, which can be moved between columns as its state changes. Users can drag and drop issue cards to move them from one column to another, reflecting progress or completion. diff --git a/contents/docs/5-github/basics/learn-the-basics/index.mdx b/contents/docs/5-github/basics/learn-the-basics/index.mdx index 01398c1a..184abcaa 100644 --- a/contents/docs/5-github/basics/learn-the-basics/index.mdx +++ b/contents/docs/5-github/basics/learn-the-basics/index.mdx @@ -1,10 +1,8 @@ --- -title: Learn The Basics description: Learn about Learn The Basics in Git +title: Learn The Basics --- -# Learn the Basics - A Version Control System (VCS) is a tool that helps developers manage changes to their code over time. It allows multiple versions of a project to exist simultaneously, making it easier to collaborate with others and maintain a record of all modifications. #### Free Resources diff --git a/contents/docs/5-github/basics/markdown/index.mdx b/contents/docs/5-github/basics/markdown/index.mdx index bef998ac..22fff55f 100644 --- a/contents/docs/5-github/basics/markdown/index.mdx +++ b/contents/docs/5-github/basics/markdown/index.mdx @@ -1,10 +1,8 @@ --- -title: Markdown description: Learn about Markdown in Git +title: Markdown --- -# Markdown - Markdown is a simple way to add formatting to text without using HTML tags or other complex syntax. It's easy to read and write, making it suitable for documentation, README files, and more. Some basic GitHub Markdown features include: - Basic syntax: Use headers (`# Heading`), bold/italic text (**bold**, *italic*), and lists (- item) to format text. diff --git a/contents/docs/5-github/basics/mentions/index.mdx b/contents/docs/5-github/basics/mentions/index.mdx index 118a7747..4250e009 100644 --- a/contents/docs/5-github/basics/mentions/index.mdx +++ b/contents/docs/5-github/basics/mentions/index.mdx @@ -1,10 +1,8 @@ --- -title: Mentions description: Learn about Mentions in Git +title: Mentions --- -# Mentions - Mentions on GitHub allow you to notify specific users or teams about comments, issues, pull requests, or other activities. This feature improves collaboration by encouraging participation and discussion among team members, increasing visibility of important topics, and streamlining communication within your repository. To use mentions, simply type `@username` or `@teamname` in a comment, and GitHub will auto-complete the mention as you type, automatically linking their username to the comment and notifying them about the discussion. #### Free Resources diff --git a/contents/docs/5-github/basics/more-github/index.mdx b/contents/docs/5-github/basics/more-github/index.mdx index e6cd3e66..e2a84fc0 100644 --- a/contents/docs/5-github/basics/more-github/index.mdx +++ b/contents/docs/5-github/basics/more-github/index.mdx @@ -1,10 +1,8 @@ --- -title: More Github description: Learn about More Github in Git +title: More Github --- -# More GitHub - In addition to Git, GitHub provides several features that enhance collaboration and project management. GitHub Actions allows for automating workflows and testing code within the platform, while the GitHub CLI enables users to interact with GitHub from their local terminal using commands like `gh`. Additionally, GitHub supports Markdown formatting for creating readable documentation and comments, which can be used in repositories and issues. Learn more from the following resources: diff --git a/contents/docs/5-github/basics/oauth-apps/index.mdx b/contents/docs/5-github/basics/oauth-apps/index.mdx index d99eb80d..19914e66 100644 --- a/contents/docs/5-github/basics/oauth-apps/index.mdx +++ b/contents/docs/5-github/basics/oauth-apps/index.mdx @@ -1,10 +1,8 @@ --- -title: Oauth Apps description: Learn about Oauth Apps in Git +title: Oauth Apps --- -# OAuth Apps - GitHub OAuth Apps allow developers to integrate with GitHub using OAuth 2.0 authentication. They enable secure, token-based access to specific GitHub resources like repositories, issues, and pull requests. OAuth Apps can automate tasks, personalize interactions, and provide real-time notifications through webhooks, all while allowing users to approve only the necessary permissions without sharing their credentials. #### Free Resources diff --git a/contents/docs/5-github/basics/pr-from-a-fork/index.mdx b/contents/docs/5-github/basics/pr-from-a-fork/index.mdx index 3ea9e655..b28fb6b4 100644 --- a/contents/docs/5-github/basics/pr-from-a-fork/index.mdx +++ b/contents/docs/5-github/basics/pr-from-a-fork/index.mdx @@ -1,10 +1,8 @@ --- -title: Pr From A Fork description: Learn about Pr From A Fork in Git +title: Pr From A Fork --- -# PR from a Fork - Creating a pull request from a fork on GitHub is a common workflow for contributing to open-source projects or collaborating on repositories you don't have direct write access to. After forking the original repository to your GitHub account, you can make changes in your fork, commit them, and then create a pull request to propose these changes to the original repository. This process allows project maintainers to review your contributions, discuss any necessary modifications, and ultimately merge your changes into the main project if they're approved. It's an essential feature that facilitates collaboration and code review in distributed development environments. #### Free Resources diff --git a/contents/docs/5-github/basics/private-vs-public/index.mdx b/contents/docs/5-github/basics/private-vs-public/index.mdx index a9aa1008..6c002e9c 100644 --- a/contents/docs/5-github/basics/private-vs-public/index.mdx +++ b/contents/docs/5-github/basics/private-vs-public/index.mdx @@ -1,10 +1,8 @@ --- -title: Private Vs Public description: Learn about Private Vs Public in Git +title: Private Vs Public --- -# Private vs Public - GitHub offers both private and public repositories, each serving different purposes in software development. Public repositories are visible to everyone on the internet, making them ideal for open-source projects, collaboration, and showcasing work to a wider audience. They encourage community contributions and can help developers build their portfolios. Private repositories, on the other hand, are only accessible to the repository owner and designated collaborators. These are suitable for proprietary code, sensitive projects, or work that's not ready for public consumption. Private repositories offer greater control over access and visibility, making them essential for businesses and individuals who need to keep their code confidential. #### Free Resources diff --git a/contents/docs/5-github/basics/profile-readme/index.mdx b/contents/docs/5-github/basics/profile-readme/index.mdx index db683165..edcae650 100644 --- a/contents/docs/5-github/basics/profile-readme/index.mdx +++ b/contents/docs/5-github/basics/profile-readme/index.mdx @@ -1,10 +1,8 @@ --- -title: Profile Readme description: Learn about Profile Readme in Git +title: Profile Readme --- -# Profile Readme - A GitHub Profile README is a special repository that allows users to showcase their skills, projects, and personality directly on their GitHub profile. To create one, you need to make a new repository with the same name as your GitHub username. This repository should contain a README.md file, which GitHub will automatically display on your profile page. The README can be customized with Markdown formatting, allowing you to add text, images, links, and even dynamic content like GitHub stats or recent blog posts. This feature provides a unique opportunity to make your GitHub profile more engaging and informative for visitors, effectively serving as a personalized landing page for your GitHub presence. #### Free Resources diff --git a/contents/docs/5-github/basics/project-planning/index.mdx b/contents/docs/5-github/basics/project-planning/index.mdx index 18fa7492..fd8e9896 100644 --- a/contents/docs/5-github/basics/project-planning/index.mdx +++ b/contents/docs/5-github/basics/project-planning/index.mdx @@ -1,10 +1,8 @@ --- -title: Project Planning description: Learn about Project Planning in Git +title: Project Planning --- -# Project Planning - Project planning on GitHub is a comprehensive process that leverages the platform's built-in tools to organize, track, and manage software development projects efficiently. It typically involves using features such as Issues for task tracking, Projects for kanban-style boards, Milestones for grouping related issues and pull requests, and Labels for categorization. These tools, combined with GitHub's collaborative features like pull requests and code reviews, enable teams to create structured workflows, set priorities, assign tasks, and monitor progress throughout the development lifecycle. By centralizing project management within the same platform used for version control, GitHub streamlines communication and enhances productivity for development teams of all sizes. #### Free Resources diff --git a/contents/docs/5-github/basics/project-readme/index.mdx b/contents/docs/5-github/basics/project-readme/index.mdx index a597d674..30f98e95 100644 --- a/contents/docs/5-github/basics/project-readme/index.mdx +++ b/contents/docs/5-github/basics/project-readme/index.mdx @@ -1,10 +1,8 @@ --- -title: Project Readme description: Learn about Project Readme in Git +title: Project Readme --- -# Project Readme - A GitHub project README is a crucial document that serves as the front page of a repository, providing essential information about the project. It typically includes a brief description of the project's purpose, installation instructions, usage guidelines, and contribution procedures. A well-crafted README helps visitors quickly understand the project's goals, how to get started, and how they can participate. It often contains badges indicating build status, code coverage, and other metrics, as well as links to documentation, issue trackers, and community channels. By effectively communicating the project's value and guiding new users and potential contributors, a good README significantly enhances a project's visibility, adoption, and collaboration potential on GitHub. #### Free Resources diff --git a/contents/docs/5-github/basics/repository-management/index.mdx b/contents/docs/5-github/basics/repository-management/index.mdx index 39e271bd..b4f4b737 100644 --- a/contents/docs/5-github/basics/repository-management/index.mdx +++ b/contents/docs/5-github/basics/repository-management/index.mdx @@ -1,10 +1,8 @@ --- -title: Repository Management description: Learn about Repository Management in Git +title: Repository Management --- -# Repository management - Using GitHub CLI for repository management allows you to streamline tasks and work more efficiently. ou can use GitHub CLI to manage repositories with the following commands: - `gh repo create`: Create a new repository. diff --git a/contents/docs/5-github/basics/rest-api/index.mdx b/contents/docs/5-github/basics/rest-api/index.mdx index 46ed1137..2c23b43f 100644 --- a/contents/docs/5-github/basics/rest-api/index.mdx +++ b/contents/docs/5-github/basics/rest-api/index.mdx @@ -1,10 +1,8 @@ --- -title: Rest Api description: Learn about Rest Api in Git +title: Rest Api --- -# REST API - The GitHub REST API is a set of APIs that provide access to various GitHub features, such as user data, repository information, and commit history. It allows developers to interact with the GitHub platform programmatically. #### Free Resources diff --git a/contents/docs/5-github/basics/roadmaps/index.mdx b/contents/docs/5-github/basics/roadmaps/index.mdx index bfa4026b..a7533690 100644 --- a/contents/docs/5-github/basics/roadmaps/index.mdx +++ b/contents/docs/5-github/basics/roadmaps/index.mdx @@ -1,10 +1,8 @@ --- -title: Roadmaps description: Learn about Roadmaps in Git +title: Roadmaps --- -# Roadmaps - GitHub Roadmaps are a feature that helps you visualize and organize plans for your projects, allowing you to create a high-level view of milestones and goals, and collaborate on planning and tracking progress with team members. #### Free Resources diff --git a/contents/docs/5-github/basics/saved-replies/index.mdx b/contents/docs/5-github/basics/saved-replies/index.mdx index fd3a0fc2..c94bd1b2 100644 --- a/contents/docs/5-github/basics/saved-replies/index.mdx +++ b/contents/docs/5-github/basics/saved-replies/index.mdx @@ -1,10 +1,8 @@ --- -title: Saved Replies description: Learn about Saved Replies in Git +title: Saved Replies --- -# Saved Replies - GitHub allows you to save frequently used comments and reuse them when discussing issues or pull requests. - Saved replies: You can create pre-written comments that can be easily added to conversations. diff --git a/contents/docs/5-github/basics/scheduled-worfklows/index.mdx b/contents/docs/5-github/basics/scheduled-worfklows/index.mdx index c6b79d80..77e0af6f 100644 --- a/contents/docs/5-github/basics/scheduled-worfklows/index.mdx +++ b/contents/docs/5-github/basics/scheduled-worfklows/index.mdx @@ -1,10 +1,8 @@ --- -title: Scheduled Worfklows description: Learn about Scheduled Worfklows in Git +title: Scheduled Worfklows --- -# Scheduled Worfklows - GitHub Actions allows you to schedule workflows to run at specific times or intervals. You can set up workflows to automatically run at predetermined times, such as daily or weekly. #### Free Resources diff --git a/contents/docs/5-github/basics/secrets-and-env-vars/index.mdx b/contents/docs/5-github/basics/secrets-and-env-vars/index.mdx index d63c52e3..bd17982e 100644 --- a/contents/docs/5-github/basics/secrets-and-env-vars/index.mdx +++ b/contents/docs/5-github/basics/secrets-and-env-vars/index.mdx @@ -1,10 +1,8 @@ --- -title: Secrets And Env Vars description: Learn about Secrets And Env Vars in Git +title: Secrets And Env Vars --- -# Secrets and Env Vars - GitHub provides features to securely store and manage sensitive data, such as secrets and environment variables. - Secrets: These are sensitive values that should not be committed to a repository, like API keys or database credentials. diff --git a/contents/docs/5-github/basics/setting-up-profile/index.mdx b/contents/docs/5-github/basics/setting-up-profile/index.mdx index 873b4aa5..f862db1e 100644 --- a/contents/docs/5-github/basics/setting-up-profile/index.mdx +++ b/contents/docs/5-github/basics/setting-up-profile/index.mdx @@ -1,10 +1,8 @@ --- -title: Setting Up Profile description: Learn about Setting Up Profile in Git +title: Setting Up Profile --- -# Setting up Profile - On GitHub, creating a profile is an essential step in showcasing yourself as a developer or contributor. - Sharing information: Your profile page allows others to find out more about you, including your interests and skills. diff --git a/contents/docs/5-github/basics/static-site-generators/index.mdx b/contents/docs/5-github/basics/static-site-generators/index.mdx index cc009913..bbc867bf 100644 --- a/contents/docs/5-github/basics/static-site-generators/index.mdx +++ b/contents/docs/5-github/basics/static-site-generators/index.mdx @@ -1,10 +1,8 @@ --- -title: Static Site Generators description: Learn about Static Site Generators in Git +title: Static Site Generators --- -# Static Site Generators - GitHub offers a set of static site generators (SSGs) that allow users to create and deploy websites directly from their GitHub repositories. These SSGs include `Jekyll`, `Hugo`, and `Middleman`, among others. They provide a simple way to build websites without the need for manual configuration or maintenance. #### Free Resources diff --git a/contents/docs/5-github/basics/storing-artifacts/index.mdx b/contents/docs/5-github/basics/storing-artifacts/index.mdx index 90a823f2..432f5040 100644 --- a/contents/docs/5-github/basics/storing-artifacts/index.mdx +++ b/contents/docs/5-github/basics/storing-artifacts/index.mdx @@ -1,10 +1,8 @@ --- -title: Storing Artifacts description: Learn about Storing Artifacts in Git +title: Storing Artifacts --- -# Storing Artifacts - GitHub provides a feature for storing artifacts, which allows you to upload build outputs or other files as part of your workflow. - Artifacts: These are files generated by a job, such as compiled binaries, test reports, or logs. They can be used to validate the results of a build or deployment. diff --git a/contents/docs/5-github/basics/student-developer-pack/index.mdx b/contents/docs/5-github/basics/student-developer-pack/index.mdx index 50bba7de..cdb11582 100644 --- a/contents/docs/5-github/basics/student-developer-pack/index.mdx +++ b/contents/docs/5-github/basics/student-developer-pack/index.mdx @@ -1,10 +1,8 @@ --- -title: Student Developer Pack description: Learn about Student Developer Pack in Git +title: Student Developer Pack --- -# Student Developer Pack - The GitHub Student Developer Pack is a collection of developer tools and resources that are offered free or at a discounted price to students through the GitHub Education program. This pack includes access to GitHub, GitHub Desktop, GitHub Classroom, GitHub Student Developer Kit, and other benefits. By using the Student Developer Pack, students can gain hands-on experience with professional developer tools, while also getting access to a wide range of educational resources. Visit the following resource to learn more: diff --git a/contents/docs/5-github/basics/teams-within-organization/index.mdx b/contents/docs/5-github/basics/teams-within-organization/index.mdx index ae0f5555..1807a301 100644 --- a/contents/docs/5-github/basics/teams-within-organization/index.mdx +++ b/contents/docs/5-github/basics/teams-within-organization/index.mdx @@ -1,10 +1,8 @@ --- -title: Teams Within Organization description: Learn about Teams Within Organization in Git +title: Teams Within Organization --- -# Teams within Organization - GitHub Organizations allow you to create teams within your organization, which helps in organizing members based on their roles and responsibilities. - Grouping: Team members can be grouped together according to the company or group's structure. diff --git a/contents/docs/5-github/basics/unstaged-changes/index.mdx b/contents/docs/5-github/basics/unstaged-changes/index.mdx index ddd5910f..f5c0b5b7 100644 --- a/contents/docs/5-github/basics/unstaged-changes/index.mdx +++ b/contents/docs/5-github/basics/unstaged-changes/index.mdx @@ -1,10 +1,8 @@ --- -title: Unstaged Changes description: Learn about Unstaged Changes in Git +title: Unstaged Changes --- -# Unstaged Changes - For changes that are not yet staged with `git add`, such as untracked new files or modified existing ones , use `git diff`. This command compares your working directory (your current changes) against the staging area (changes already staged with `git add`). It’s a useful tool for reviewing local modifications before deciding whether to stage them for future commits. The `--unified` option (or -U) controls the number of context lines shown in the diff output. By default, Git shows 3 lines of context around each change. For example, `git diff --unified=5` will display 5 lines of context around each change, making it easier to understand the surrounding code or content. diff --git a/contents/docs/5-github/basics/use-in-automation/index.mdx b/contents/docs/5-github/basics/use-in-automation/index.mdx index 52d8f483..085677f4 100644 --- a/contents/docs/5-github/basics/use-in-automation/index.mdx +++ b/contents/docs/5-github/basics/use-in-automation/index.mdx @@ -1,10 +1,8 @@ --- -title: Use In Automation description: Learn about Use In Automation in Git +title: Use In Automation --- -# Use in Automation - GitHub CLI is a powerful tool for automating GitHub-related tasks directly from the command line. It enables developers to streamline workflows and integrate GitHub processes into scripts and automated systems. Key uses in automation: diff --git a/contents/docs/5-github/basics/usecases/index.mdx b/contents/docs/5-github/basics/usecases/index.mdx index 74945187..74e51ed5 100644 --- a/contents/docs/5-github/basics/usecases/index.mdx +++ b/contents/docs/5-github/basics/usecases/index.mdx @@ -1,10 +1,8 @@ --- -title: Usecases description: Learn about Usecases in Git +title: Usecases --- -# Usecases - GitHub Actions offer a wide range of automation possibilities for your development workflow. Here are some common use cases: 1. Continuous Integration (CI): Automatically build and test your code on every push or pull request. diff --git a/contents/docs/5-github/basics/webhooks/index.mdx b/contents/docs/5-github/basics/webhooks/index.mdx index 421b0100..72baa43c 100644 --- a/contents/docs/5-github/basics/webhooks/index.mdx +++ b/contents/docs/5-github/basics/webhooks/index.mdx @@ -1,10 +1,8 @@ --- -title: Webhooks description: Learn about Webhooks in Git +title: Webhooks --- -# Webhooks - GitHub Webhooks allow developers to receive real-time notifications about events happening within their repository, such as commits, pull requests, and issues. These webhooks enable users to automate tasks, integrate with other services, and build custom workflows. #### Free Resources diff --git a/contents/docs/5-github/collaboration/collaboration-on-github/index.mdx b/contents/docs/5-github/collaboration/collaboration-on-github/index.mdx index 817cc17d..46c4d4e8 100644 --- a/contents/docs/5-github/collaboration/collaboration-on-github/index.mdx +++ b/contents/docs/5-github/collaboration/collaboration-on-github/index.mdx @@ -1,8 +1,8 @@ --- +description: Learn how to effectively collaborate with others using GitHub's powerful + collaboration features and workflows. title: Collaboration on GitHub -description: Learn how to effectively collaborate with others using GitHub's powerful collaboration features and workflows. --- - import { Tabs, TabItem } from '@astrojs/starlight/components'; import { Aside } from '@astrojs/starlight/components'; import { Steps } from '@astrojs/starlight/components'; @@ -10,7 +10,6 @@ import { LinkCard } from '@astrojs/starlight/components'; import { Card, CardGrid } from '@astrojs/starlight/components'; import { Icon } from '@astrojs/starlight/components'; -# Collaboration on GitHub GitHub enhances Git's collaboration capabilities with a suite of powerful features specifically designed to streamline teamwork and facilitate project management. This guide covers GitHub's key collaboration features and how to use them effectively. diff --git a/contents/docs/5-github/collaboration/github-discussions/index.mdx b/contents/docs/5-github/collaboration/github-discussions/index.mdx index b7bd1201..afbf687e 100644 --- a/contents/docs/5-github/collaboration/github-discussions/index.mdx +++ b/contents/docs/5-github/collaboration/github-discussions/index.mdx @@ -1,11 +1,10 @@ --- +description: Learn about GitHub Discussions, a collaborative communication feature + that helps your community ask questions, share information, and have open-ended + conversations. title: GitHub Discussions -description: Learn about GitHub Discussions, a collaborative communication feature that helps your community ask questions, share information, and have open-ended conversations. --- - -# GitHub Discussions - GitHub Discussions provides a collaborative communication space for your community outside of your codebase. This feature allows project maintainers, contributors, and users to gather and have conversations about a project without tying them to specific issues or pull requests. ## What are GitHub Discussions? diff --git a/contents/docs/5-github/collaboration/issue-management/index.mdx b/contents/docs/5-github/collaboration/issue-management/index.mdx index 9374e987..40caab53 100644 --- a/contents/docs/5-github/collaboration/issue-management/index.mdx +++ b/contents/docs/5-github/collaboration/issue-management/index.mdx @@ -1,10 +1,8 @@ --- -title: Issue Management description: Learn about Issue Management in Git +title: Issue Management --- -# Issue Management - The GitHub CLI provides a range of features for managing issues within your repository. Here are some key actions you can perform: - Listing issues: Run `gh issue list` to view a list of all open and closed issues. diff --git a/contents/docs/5-github/collaboration/issues/index.mdx b/contents/docs/5-github/collaboration/issues/index.mdx index 92fa7b3c..8eb792b3 100644 --- a/contents/docs/5-github/collaboration/issues/index.mdx +++ b/contents/docs/5-github/collaboration/issues/index.mdx @@ -1,10 +1,8 @@ --- -title: Issues description: Learn about Issues in Git +title: Issues --- -# Issues - On GitHub, an issue is a way to track and report bugs, feature requests, or other problems with a repository. Here are some key aspects of issues: - Creating issues: Users can create new issues by submitting a form on the repository's Issues page. diff --git a/contents/docs/5-github/collaboration/pull-requests/index.mdx b/contents/docs/5-github/collaboration/pull-requests/index.mdx index 6bdf7241..1016e0b3 100644 --- a/contents/docs/5-github/collaboration/pull-requests/index.mdx +++ b/contents/docs/5-github/collaboration/pull-requests/index.mdx @@ -1,10 +1,8 @@ --- -title: Pull Requests description: Learn how to create and manage pull requests on GitHub +title: Pull Requests --- -# Pull Requests - Pull requests (PRs) are a core feature of GitHub that allow you to propose changes to a repository and collaborate with others through code review. ## What are Pull Requests? diff --git a/contents/docs/5-github/features/citation-files/index.mdx b/contents/docs/5-github/features/citation-files/index.mdx index df3fb2bb..987db447 100644 --- a/contents/docs/5-github/features/citation-files/index.mdx +++ b/contents/docs/5-github/features/citation-files/index.mdx @@ -1,10 +1,8 @@ --- -title: Citation Files description: Learn about CITATION.cff files for academic software +title: Citation Files --- -# Citation Files - Citation files help researchers and developers properly cite your software in academic publications. ## CITATION.cff Format diff --git a/contents/docs/5-github/features/deploying-static-websites/index.mdx b/contents/docs/5-github/features/deploying-static-websites/index.mdx index 367bd487..cbbcd095 100644 --- a/contents/docs/5-github/features/deploying-static-websites/index.mdx +++ b/contents/docs/5-github/features/deploying-static-websites/index.mdx @@ -1,10 +1,8 @@ --- -title: Deploying Static Websites description: Learn about deploying static websites with GitHub Pages +title: Deploying Static Websites --- -# Deploying Static Websites - GitHub Pages makes it easy to deploy static websites directly from your repository. ## Deployment Methods diff --git a/contents/docs/5-github/features/github-actions/index.mdx b/contents/docs/5-github/features/github-actions/index.mdx index 7b6f5676..8d2c1518 100644 --- a/contents/docs/5-github/features/github-actions/index.mdx +++ b/contents/docs/5-github/features/github-actions/index.mdx @@ -1,8 +1,8 @@ --- +description: Learn how to automate workflows with GitHub Actions, a powerful CI/CD + tool integrated directly into your GitHub repository. title: GitHub Actions -description: Learn how to automate workflows with GitHub Actions, a powerful CI/CD tool integrated directly into your GitHub repository. --- - import { Tabs, TabItem } from '@astrojs/starlight/components'; import { Aside } from '@astrojs/starlight/components'; import { Steps } from '@astrojs/starlight/components'; @@ -10,7 +10,6 @@ import { LinkCard } from '@astrojs/starlight/components'; import { Card, CardGrid } from '@astrojs/starlight/components'; import { Icon } from '@astrojs/starlight/components'; -# GitHub Actions GitHub Actions is a powerful automation platform that allows you to build, test, and deploy your code directly from your GitHub repository. This feature enables continuous integration and continuous delivery (CI/CD) workflows and can automate virtually any software development process. diff --git a/contents/docs/5-github/features/github-gists/index.mdx b/contents/docs/5-github/features/github-gists/index.mdx index 530b452e..24cc9d58 100644 --- a/contents/docs/5-github/features/github-gists/index.mdx +++ b/contents/docs/5-github/features/github-gists/index.mdx @@ -1,8 +1,8 @@ --- +description: Learn how to use GitHub Gists to share code snippets, notes, and small + projects with others. title: GitHub Gists -description: Learn how to use GitHub Gists to share code snippets, notes, and small projects with others. --- - import { Tabs, TabItem } from '@astrojs/starlight/components'; import { Aside } from '@astrojs/starlight/components'; import { Steps } from '@astrojs/starlight/components'; @@ -10,7 +10,6 @@ import { LinkCard } from '@astrojs/starlight/components'; import { Card, CardGrid } from '@astrojs/starlight/components'; import { Icon } from '@astrojs/starlight/components'; -# GitHub Gists GitHub Gists are a simple way to share code snippets, notes, and small projects with others. They provide lightweight version control, embedding capabilities, and easy sharing—all without having to create a full repository. diff --git a/contents/docs/5-github/features/github-packages/index.mdx b/contents/docs/5-github/features/github-packages/index.mdx index 7b6cd238..fe490363 100644 --- a/contents/docs/5-github/features/github-packages/index.mdx +++ b/contents/docs/5-github/features/github-packages/index.mdx @@ -1,8 +1,8 @@ --- +description: Learn how to use GitHub Packages to publish and consume packages in your + GitHub workflows and projects. title: GitHub Packages -description: Learn how to use GitHub Packages to publish and consume packages in your GitHub workflows and projects. --- - import { Tabs, TabItem } from '@astrojs/starlight/components'; import { Aside } from '@astrojs/starlight/components'; import { Steps } from '@astrojs/starlight/components'; @@ -10,7 +10,6 @@ import { LinkCard } from '@astrojs/starlight/components'; import { Card, CardGrid } from '@astrojs/starlight/components'; import { Icon } from '@astrojs/starlight/components'; -# GitHub Packages GitHub Packages is a package management service that allows you to host and manage packages alongside your code. It integrates seamlessly with GitHub features like Actions to provide a streamlined workflow for software development. diff --git a/contents/docs/5-github/features/github-pages/index.mdx b/contents/docs/5-github/features/github-pages/index.mdx index f8dc9ce5..9ed05ceb 100644 --- a/contents/docs/5-github/features/github-pages/index.mdx +++ b/contents/docs/5-github/features/github-pages/index.mdx @@ -1,8 +1,8 @@ --- +description: Learn how to host and deploy static websites directly from your GitHub + repositories using GitHub Pages. title: GitHub Pages -description: Learn how to host and deploy static websites directly from your GitHub repositories using GitHub Pages. --- - import { Tabs, TabItem } from '@astrojs/starlight/components'; import { Aside } from '@astrojs/starlight/components'; import { Steps } from '@astrojs/starlight/components'; @@ -10,7 +10,6 @@ import { LinkCard } from '@astrojs/starlight/components'; import { Card, CardGrid } from '@astrojs/starlight/components'; import { Icon } from '@astrojs/starlight/components'; -# GitHub Pages GitHub Pages is a static site hosting service that takes HTML, CSS, and JavaScript files directly from a repository on GitHub, optionally runs the files through a build process, and publishes a website. It's a powerful way to showcase projects, documentation, or personal websites directly from your GitHub repositories. diff --git a/contents/docs/5-github/features/github-projects/index.mdx b/contents/docs/5-github/features/github-projects/index.mdx index 52f5811d..7c33387a 100644 --- a/contents/docs/5-github/features/github-projects/index.mdx +++ b/contents/docs/5-github/features/github-projects/index.mdx @@ -1,8 +1,8 @@ --- +description: Learn how to organize and track your work using GitHub Projects, a flexible + project management tool integrated with GitHub repositories. title: GitHub Projects -description: Learn how to organize and track your work using GitHub Projects, a flexible project management tool integrated with GitHub repositories. --- - import { Tabs, TabItem } from '@astrojs/starlight/components'; import { Aside } from '@astrojs/starlight/components'; import { Steps } from '@astrojs/starlight/components'; @@ -10,7 +10,6 @@ import { LinkCard } from '@astrojs/starlight/components'; import { Card, CardGrid } from '@astrojs/starlight/components'; import { Icon } from '@astrojs/starlight/components'; -# GitHub Projects GitHub Projects is a flexible project management tool that integrates directly with your GitHub issues and pull requests. It allows teams to plan, track, and manage their work efficiently while maintaining a close connection to their code repositories. diff --git a/contents/docs/5-github/features/github-releases/index.mdx b/contents/docs/5-github/features/github-releases/index.mdx index e18b22ae..22c983b3 100644 --- a/contents/docs/5-github/features/github-releases/index.mdx +++ b/contents/docs/5-github/features/github-releases/index.mdx @@ -1,8 +1,8 @@ --- +description: Learn how to create and manage releases, distribute software, and provide + release notes using GitHub Releases. title: GitHub Releases -description: Learn how to create and manage releases, distribute software, and provide release notes using GitHub Releases. --- - import { Tabs, TabItem } from '@astrojs/starlight/components'; import { Aside } from '@astrojs/starlight/components'; import { Steps } from '@astrojs/starlight/components'; @@ -10,7 +10,6 @@ import { LinkCard } from '@astrojs/starlight/components'; import { Card, CardGrid } from '@astrojs/starlight/components'; import { Icon } from '@astrojs/starlight/components'; -# GitHub Releases GitHub Releases provide a way to package and distribute software, documentation, and other assets associated with specific points in your project's history. They are built on top of Git tags and allow you to share your work with your community in a more structured and user-friendly way. diff --git a/contents/docs/5-github/features/github-security/index.mdx b/contents/docs/5-github/features/github-security/index.mdx index de5cbc2c..2dcbdeed 100644 --- a/contents/docs/5-github/features/github-security/index.mdx +++ b/contents/docs/5-github/features/github-security/index.mdx @@ -1,8 +1,8 @@ --- +description: Learn about GitHub's security features to protect your code, detect vulnerabilities, + and implement secure development practices. title: GitHub Security -description: Learn about GitHub's security features to protect your code, detect vulnerabilities, and implement secure development practices. --- - import { Tabs, TabItem } from '@astrojs/starlight/components'; import { Aside } from '@astrojs/starlight/components'; import { Steps } from '@astrojs/starlight/components'; @@ -10,7 +10,6 @@ import { LinkCard } from '@astrojs/starlight/components'; import { Card, CardGrid } from '@astrojs/starlight/components'; import { Icon } from '@astrojs/starlight/components'; -# GitHub Security GitHub provides a comprehensive set of security features designed to help developers identify and fix vulnerabilities, enforce secure development practices, and protect their code. These tools integrate directly into your GitHub workflow, making security a natural part of your development process. diff --git a/contents/docs/5-github/features/github-sponsors/index.mdx b/contents/docs/5-github/features/github-sponsors/index.mdx index e3da0c8c..e8ccad59 100644 --- a/contents/docs/5-github/features/github-sponsors/index.mdx +++ b/contents/docs/5-github/features/github-sponsors/index.mdx @@ -1,10 +1,8 @@ --- -title: GitHub Sponsors description: Learn about GitHub Sponsors program for supporting open source developers +title: GitHub Sponsors --- -# GitHub Sponsors - GitHub Sponsors is a program that allows you to financially support the developers and organizations who design, build, and maintain the open source projects you depend on. ## What is GitHub Sponsors? diff --git a/contents/docs/5-github/features/kanban-boards/index.mdx b/contents/docs/5-github/features/kanban-boards/index.mdx index 21ca3060..793d4825 100644 --- a/contents/docs/5-github/features/kanban-boards/index.mdx +++ b/contents/docs/5-github/features/kanban-boards/index.mdx @@ -1,10 +1,8 @@ --- -title: Kanban Boards description: Learn about GitHub Projects Kanban boards for project management +title: Kanban Boards --- -# Kanban Boards - GitHub Projects provides Kanban-style boards for visual project management. ## Features diff --git a/contents/docs/5-github/integrations/api/index.mdx b/contents/docs/5-github/integrations/api/index.mdx index c5979765..cd7ed4b8 100644 --- a/contents/docs/5-github/integrations/api/index.mdx +++ b/contents/docs/5-github/integrations/api/index.mdx @@ -1,10 +1,8 @@ --- -title: GitHub API description: Learn about the GitHub API and how to integrate with Git programmatically +title: GitHub API --- -# GitHub API - The GitHub API allows you to build applications that integrate with GitHub, automate workflows, and extend GitHub's functionality. #### Free Resources diff --git a/contents/docs/5-github/integrations/github-apps/index.mdx b/contents/docs/5-github/integrations/github-apps/index.mdx index b3127d37..d2c9cf54 100644 --- a/contents/docs/5-github/integrations/github-apps/index.mdx +++ b/contents/docs/5-github/integrations/github-apps/index.mdx @@ -1,10 +1,8 @@ --- -title: GitHub Apps description: Learn about GitHub Apps and their integration with Git workflows +title: GitHub Apps --- -# GitHub Apps - GitHub Apps are a more flexible way to extend GitHub's functionality, allowing for more granular permissions and API access compared to OAuth Apps. #### Free Resources diff --git a/contents/docs/5-github/integrations/github-classroom/index.mdx b/contents/docs/5-github/integrations/github-classroom/index.mdx index 2cd68351..82457b13 100644 --- a/contents/docs/5-github/integrations/github-classroom/index.mdx +++ b/contents/docs/5-github/integrations/github-classroom/index.mdx @@ -1,10 +1,8 @@ --- -title: GitHub Classroom description: Learn about GitHub Classroom and how it integrates with Git for education +title: GitHub Classroom --- -# GitHub Classroom - GitHub Classroom automates repository creation and access control, making it easy to distribute code and provide feedback to students. #### Free Resources diff --git a/contents/docs/5-github/integrations/github-cli/index.mdx b/contents/docs/5-github/integrations/github-cli/index.mdx index adeeb4c7..798feb72 100644 --- a/contents/docs/5-github/integrations/github-cli/index.mdx +++ b/contents/docs/5-github/integrations/github-cli/index.mdx @@ -1,10 +1,9 @@ --- +description: Learn about the GitHub Command Line Interface (CLI) and how it integrates + with Git title: GitHub CLI -description: Learn about the GitHub Command Line Interface (CLI) and how it integrates with Git --- -# GitHub CLI - GitHub CLI is a command-line tool that brings GitHub functionality to your terminal, making it easier to work with GitHub without leaving the command line. #### Free Resources diff --git a/contents/docs/5-github/integrations/github-codespaces/index.mdx b/contents/docs/5-github/integrations/github-codespaces/index.mdx index 0f86bb7f..44233c94 100644 --- a/contents/docs/5-github/integrations/github-codespaces/index.mdx +++ b/contents/docs/5-github/integrations/github-codespaces/index.mdx @@ -1,10 +1,8 @@ --- -title: GitHub Codespaces description: Learn about GitHub Codespaces and how it integrates with Git +title: GitHub Codespaces --- -# GitHub Codespaces - GitHub Codespaces provides a complete, configurable dev environment in the cloud, allowing you to code, build, test, and debug from any device. #### Free Resources diff --git a/contents/docs/5-github/integrations/github-copilot/index.mdx b/contents/docs/5-github/integrations/github-copilot/index.mdx index 95fb118e..1a28204f 100644 --- a/contents/docs/5-github/integrations/github-copilot/index.mdx +++ b/contents/docs/5-github/integrations/github-copilot/index.mdx @@ -1,10 +1,8 @@ --- -title: GitHub Copilot description: Learn about GitHub Copilot and how it integrates with Git workflows +title: GitHub Copilot --- -# GitHub Copilot - GitHub Copilot is an AI pair programmer that helps you write code faster with less work. It draws context from comments and code to suggest individual lines and whole functions instantly. #### Free Resources diff --git a/contents/docs/5-github/integrations/github-education/index.mdx b/contents/docs/5-github/integrations/github-education/index.mdx index de3b5270..d025d699 100644 --- a/contents/docs/5-github/integrations/github-education/index.mdx +++ b/contents/docs/5-github/integrations/github-education/index.mdx @@ -1,10 +1,8 @@ --- -title: GitHub Education description: Learn about GitHub Education and its resources for students and educators +title: GitHub Education --- -# GitHub Education - GitHub Education helps students, teachers, and schools access the tools and events they need to shape the next generation of software development. #### Free Resources diff --git a/contents/docs/6-workflows/best-practices/documentation/index.mdx b/contents/docs/6-workflows/best-practices/documentation/index.mdx index 85907647..cf05d809 100644 --- a/contents/docs/6-workflows/best-practices/documentation/index.mdx +++ b/contents/docs/6-workflows/best-practices/documentation/index.mdx @@ -1,10 +1,8 @@ --- -title: Documentation description: Learn about proper documentation in Git projects +title: Documentation --- -# Documentation - Good documentation is crucial for any Git project. It helps team members understand the codebase, its purpose, and how to contribute. #### Free Resources diff --git a/contents/docs/6-workflows/best-practices/git-hooks/index.mdx b/contents/docs/6-workflows/best-practices/git-hooks/index.mdx index edba95fc..b5274e77 100644 --- a/contents/docs/6-workflows/best-practices/git-hooks/index.mdx +++ b/contents/docs/6-workflows/best-practices/git-hooks/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Hooks description: Learn about Git Hooks in Git +title: Git Hooks --- -# Git hooks - Git hooks are scripts that run automatically at specific points during the Git workflow, such as when you commit, push, or pull changes from a repository. These scripts can be used to perform various tasks, like validating code, formatting files, or even sending notifications. There are two types of Git hooks: diff --git a/contents/docs/6-workflows/best-practices/pr-guidelines/index.mdx b/contents/docs/6-workflows/best-practices/pr-guidelines/index.mdx index 5058a9a5..61bd2a4b 100644 --- a/contents/docs/6-workflows/best-practices/pr-guidelines/index.mdx +++ b/contents/docs/6-workflows/best-practices/pr-guidelines/index.mdx @@ -1,10 +1,8 @@ --- -title: Pr Guidelines description: Learn about Pr Guidelines in Git +title: Pr Guidelines --- -# PR Guidelines - Pull Request (PR) guidelines are essential for maintaining a smooth and efficient code review process in collaborative development environments. These guidelines typically outline best practices for creating, formatting, and submitting PRs, ensuring that changes are well-documented, easy to review, and align with the project's standards. They may cover aspects such as PR size, commit message formatting, documentation requirements, and testing expectations. By establishing clear PR guidelines, teams can streamline their workflow, improve code quality, and facilitate effective communication among contributors. #### Free Resources diff --git a/contents/docs/6-workflows/best-practices/project-readme/index.mdx b/contents/docs/6-workflows/best-practices/project-readme/index.mdx index a9a7d1f9..c0833c4d 100644 --- a/contents/docs/6-workflows/best-practices/project-readme/index.mdx +++ b/contents/docs/6-workflows/best-practices/project-readme/index.mdx @@ -1,10 +1,8 @@ --- -title: Project README description: Learn about crafting effective README files for Git projects +title: Project README --- -# Project README - A README file is the first thing people see when they visit your repository. It's essential to provide clear information about the project, its purpose, and how to get started. #### Free Resources diff --git a/contents/docs/6-workflows/best-practices/yaml-syntax/index.mdx b/contents/docs/6-workflows/best-practices/yaml-syntax/index.mdx index bcb60ad6..1a058508 100644 --- a/contents/docs/6-workflows/best-practices/yaml-syntax/index.mdx +++ b/contents/docs/6-workflows/best-practices/yaml-syntax/index.mdx @@ -1,10 +1,8 @@ --- -title: Yaml Syntax description: Learn about Yaml Syntax in Git +title: Yaml Syntax --- -# YAML Syntax - YAML (YAML Ain't Markup Language) is a human-readable data serialization standard for all programming languages. It is designed to be easily readable by humans while also being machine-parsable. Key features of YAML include: 1. Simplicity: YAML uses a minimalist syntax with significant whitespace and indentation. diff --git a/contents/docs/6-workflows/models/git-flow/index.mdx b/contents/docs/6-workflows/models/git-flow/index.mdx index ec4257c6..78da6625 100644 --- a/contents/docs/6-workflows/models/git-flow/index.mdx +++ b/contents/docs/6-workflows/models/git-flow/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Flow description: Learn about Git Flow - a robust branching model for releases +title: Git Flow --- -# Git Flow - Git Flow is a branching model that defines a strict branching model designed around project releases. It provides a robust framework for managing larger projects with scheduled releases. ## Branch Types diff --git a/contents/docs/6-workflows/models/github-flow/index.mdx b/contents/docs/6-workflows/models/github-flow/index.mdx index e5387b0e..4da89e37 100644 --- a/contents/docs/6-workflows/models/github-flow/index.mdx +++ b/contents/docs/6-workflows/models/github-flow/index.mdx @@ -1,10 +1,8 @@ --- -title: GitHub Flow description: Learn about GitHub Flow - a simple, branch-based workflow +title: GitHub Flow --- -# GitHub Flow - GitHub Flow is a lightweight, branch-based workflow that supports teams and projects where deployments are made regularly. It's perfect for teams that deploy frequently and want a simple workflow. ## Core Principles diff --git a/contents/docs/6-workflows/team-collaboration/forking-vs-cloning/index.mdx b/contents/docs/6-workflows/team-collaboration/forking-vs-cloning/index.mdx index ceefc771..03b0eaa4 100644 --- a/contents/docs/6-workflows/team-collaboration/forking-vs-cloning/index.mdx +++ b/contents/docs/6-workflows/team-collaboration/forking-vs-cloning/index.mdx @@ -1,10 +1,8 @@ --- -title: Forking vs Cloning description: Learn the differences between forking and cloning repositories +title: Forking vs Cloning --- -# Forking vs Cloning - Understanding the difference between forking and cloning repositories is essential for effective collaboration on Git projects. #### Free Resources diff --git a/contents/docs/7-automation/ci-cd/automations/index.mdx b/contents/docs/7-automation/ci-cd/automations/index.mdx index 6f7434d2..c2c5a28b 100644 --- a/contents/docs/7-automation/ci-cd/automations/index.mdx +++ b/contents/docs/7-automation/ci-cd/automations/index.mdx @@ -1,10 +1,8 @@ --- -title: Automations description: Learn about automating workflows with Git +title: Automations --- -# Automations - Automation is a key aspect of modern development workflows. Learn how to automate repetitive tasks in your Git workflows. #### Free Resources diff --git a/contents/docs/7-automation/ci-cd/caching-dependencies/index.mdx b/contents/docs/7-automation/ci-cd/caching-dependencies/index.mdx index e91c624b..f5662b7e 100644 --- a/contents/docs/7-automation/ci-cd/caching-dependencies/index.mdx +++ b/contents/docs/7-automation/ci-cd/caching-dependencies/index.mdx @@ -1,10 +1,8 @@ --- -title: Caching Dependencies description: Learn how to cache dependencies in GitHub Actions for faster builds +title: Caching Dependencies --- -# Caching Dependencies - Caching dependencies in GitHub Actions significantly reduces build times by storing and reusing downloaded packages and compiled artifacts between workflow runs. ## Why Cache Dependencies? diff --git a/contents/docs/7-automation/ci-cd/github-actions/index.mdx b/contents/docs/7-automation/ci-cd/github-actions/index.mdx index 41320b56..e6d53bf6 100644 --- a/contents/docs/7-automation/ci-cd/github-actions/index.mdx +++ b/contents/docs/7-automation/ci-cd/github-actions/index.mdx @@ -1,10 +1,8 @@ --- -title: GitHub Actions description: Learn about implementing CI/CD with GitHub Actions +title: GitHub Actions --- -# GitHub Actions - GitHub Actions is a powerful CI/CD platform that allows you to automate your build, test, and deployment workflows directly from your GitHub repository. #### Free Resources diff --git a/contents/docs/7-automation/ci-cd/marketplace-actions/index.mdx b/contents/docs/7-automation/ci-cd/marketplace-actions/index.mdx index 51830b84..b8077cac 100644 --- a/contents/docs/7-automation/ci-cd/marketplace-actions/index.mdx +++ b/contents/docs/7-automation/ci-cd/marketplace-actions/index.mdx @@ -1,10 +1,9 @@ --- +description: Learn about using pre-built actions from the GitHub Marketplace in your + CI/CD workflows title: Marketplace Actions -description: Learn about using pre-built actions from the GitHub Marketplace in your CI/CD workflows --- -# Marketplace Actions - The GitHub Marketplace provides a library of pre-built actions that you can use in your workflows to simplify and enhance your CI/CD pipelines. #### Free Resources diff --git a/contents/docs/7-automation/ci-cd/storing-artifacts/index.mdx b/contents/docs/7-automation/ci-cd/storing-artifacts/index.mdx index e745a4f5..d1ac7f9a 100644 --- a/contents/docs/7-automation/ci-cd/storing-artifacts/index.mdx +++ b/contents/docs/7-automation/ci-cd/storing-artifacts/index.mdx @@ -1,10 +1,8 @@ --- -title: Storing Artifacts description: Learn how to store and share build artifacts in GitHub Actions +title: Storing Artifacts --- -# Storing Artifacts - Artifacts in GitHub Actions allow you to persist data after a job completes and share data between jobs in the same workflow. This is essential for saving build outputs, test reports, and other important files. ## What are Artifacts? diff --git a/contents/docs/7-automation/ci-cd/use-in-automation/index.mdx b/contents/docs/7-automation/ci-cd/use-in-automation/index.mdx index 666cec14..d0ffe927 100644 --- a/contents/docs/7-automation/ci-cd/use-in-automation/index.mdx +++ b/contents/docs/7-automation/ci-cd/use-in-automation/index.mdx @@ -1,10 +1,8 @@ --- -title: Use in Automation description: Learn how to use Git effectively in automated workflows +title: Use in Automation --- -# Use in Automation - Git can be powerful when integrated into automated workflows. This section covers best practices for using Git within automated processes. #### Free Resources diff --git a/contents/docs/7-automation/ci-cd/workflow-context/index.mdx b/contents/docs/7-automation/ci-cd/workflow-context/index.mdx index 7fcb39eb..8181ed03 100644 --- a/contents/docs/7-automation/ci-cd/workflow-context/index.mdx +++ b/contents/docs/7-automation/ci-cd/workflow-context/index.mdx @@ -1,10 +1,8 @@ --- -title: Workflow Context description: Learn about workflow context in CI/CD pipelines +title: Workflow Context --- -# Workflow Context - Understanding workflow context is essential for creating effective CI/CD pipelines, as it defines the environment and variables available during workflow execution. #### Free Resources diff --git a/contents/docs/7-automation/ci-cd/workflow-runners/index.mdx b/contents/docs/7-automation/ci-cd/workflow-runners/index.mdx index 537ff4d3..1a2b8180 100644 --- a/contents/docs/7-automation/ci-cd/workflow-runners/index.mdx +++ b/contents/docs/7-automation/ci-cd/workflow-runners/index.mdx @@ -1,10 +1,8 @@ --- -title: Workflow Runners description: Learn about workflow runners in CI/CD pipelines +title: Workflow Runners --- -# Workflow Runners - Workflow runners are the execution environments where your CI/CD workflows run. Understanding how they work is essential for configuring effective automated workflows. #### Free Resources diff --git a/contents/docs/7-automation/ci-cd/workflow-triggers/index.mdx b/contents/docs/7-automation/ci-cd/workflow-triggers/index.mdx index 2725e365..1578bc4a 100644 --- a/contents/docs/7-automation/ci-cd/workflow-triggers/index.mdx +++ b/contents/docs/7-automation/ci-cd/workflow-triggers/index.mdx @@ -1,10 +1,8 @@ --- -title: Workflow Triggers description: Learn about different types of triggers for CI/CD workflows +title: Workflow Triggers --- -# Workflow Triggers - Workflow triggers determine when your CI/CD pipelines run. Understanding the various types of triggers is essential for automating your development workflow effectively. #### Free Resources diff --git a/contents/docs/7-automation/git-hooks/client-vs-server-hooks/index.mdx b/contents/docs/7-automation/git-hooks/client-vs-server-hooks/index.mdx index 3afcbf58..308827e2 100644 --- a/contents/docs/7-automation/git-hooks/client-vs-server-hooks/index.mdx +++ b/contents/docs/7-automation/git-hooks/client-vs-server-hooks/index.mdx @@ -1,10 +1,8 @@ --- -title: Client Vs Server Hooks description: Learn about Client Vs Server Hooks in Git +title: Client Vs Server Hooks --- -# Client vs Server Hooks - Like many other Version Control Systems, Git has a way to fire off custom scripts when certain important actions occur. There are two groups of these hooks: client-side and server-side. Client-side hooks are triggered by operations such as committing and merging, while server-side hooks run on network operations such as receiving pushed commits. #### Free Resources diff --git a/contents/docs/7-automation/git-hooks/commit-msg/index.mdx b/contents/docs/7-automation/git-hooks/commit-msg/index.mdx index 08f7277d..e8d49240 100644 --- a/contents/docs/7-automation/git-hooks/commit-msg/index.mdx +++ b/contents/docs/7-automation/git-hooks/commit-msg/index.mdx @@ -1,10 +1,8 @@ --- -title: Commit Message Hooks description: Learn about commit-msg hooks for validating commit messages +title: Commit Message Hooks --- -# Commit Message Hooks - The commit-msg hook validates commit messages before they are saved, ensuring consistent message format and quality. ## Use Cases diff --git a/contents/docs/7-automation/git-hooks/git-hooks/index.mdx b/contents/docs/7-automation/git-hooks/git-hooks/index.mdx index ba1ae90a..335afb34 100644 --- a/contents/docs/7-automation/git-hooks/git-hooks/index.mdx +++ b/contents/docs/7-automation/git-hooks/git-hooks/index.mdx @@ -1,10 +1,8 @@ --- -title: Git Hooks Overview description: Learn about Git hooks for automating Git workflows +title: Git Hooks Overview --- -# Git Hooks Overview - Git hooks are scripts that run automatically at specific points in the Git workflow. ## Types of Hooks diff --git a/contents/docs/7-automation/git-hooks/post-checkout/index.mdx b/contents/docs/7-automation/git-hooks/post-checkout/index.mdx index 61807f3d..f9139266 100644 --- a/contents/docs/7-automation/git-hooks/post-checkout/index.mdx +++ b/contents/docs/7-automation/git-hooks/post-checkout/index.mdx @@ -1,10 +1,8 @@ --- -title: Post-checkout Hooks description: Learn about post-checkout hooks for actions after branch changes +title: Post-checkout Hooks --- -# Post-checkout Hooks - Post-checkout hooks run after git checkout operations, useful for updating the working directory based on the new branch. ## Use Cases diff --git a/contents/docs/7-automation/git-hooks/post-update/index.mdx b/contents/docs/7-automation/git-hooks/post-update/index.mdx index 8f9c47bd..4749312e 100644 --- a/contents/docs/7-automation/git-hooks/post-update/index.mdx +++ b/contents/docs/7-automation/git-hooks/post-update/index.mdx @@ -1,10 +1,8 @@ --- -title: Post-update Hooks description: Learn about post-update hooks for server-side Git operations +title: Post-update Hooks --- -# Post-update Hooks - Post-update hooks run on the server after refs are updated, commonly used for deployment and notifications. ## Use Cases diff --git a/contents/docs/7-automation/git-hooks/pre-commit/index.mdx b/contents/docs/7-automation/git-hooks/pre-commit/index.mdx index 95aa5007..745e8f35 100644 --- a/contents/docs/7-automation/git-hooks/pre-commit/index.mdx +++ b/contents/docs/7-automation/git-hooks/pre-commit/index.mdx @@ -1,10 +1,8 @@ --- -title: Pre-commit Hooks description: Learn about pre-commit hooks in Git for automated code quality checks +title: Pre-commit Hooks --- -# Pre-commit Hooks - Pre-commit hooks are scripts that run automatically before each commit, allowing you to check your code for issues and enforce coding standards. ## What are Pre-commit Hooks? diff --git a/contents/docs/7-automation/git-hooks/pre-push/index.mdx b/contents/docs/7-automation/git-hooks/pre-push/index.mdx index 97418be3..f7ec163b 100644 --- a/contents/docs/7-automation/git-hooks/pre-push/index.mdx +++ b/contents/docs/7-automation/git-hooks/pre-push/index.mdx @@ -1,10 +1,8 @@ --- -title: Pre-push Hooks description: Learn about pre-push hooks for validating commits before pushing +title: Pre-push Hooks --- -# Pre-push Hooks - Pre-push hooks run before git push operations, allowing you to validate the commits being pushed. ## Use Cases diff --git a/contents/docs/7-automation/scripts/checkout-tags/index.mdx b/contents/docs/7-automation/scripts/checkout-tags/index.mdx index 09b31f95..9adcd6ba 100644 --- a/contents/docs/7-automation/scripts/checkout-tags/index.mdx +++ b/contents/docs/7-automation/scripts/checkout-tags/index.mdx @@ -1,10 +1,8 @@ --- -title: Checkout Tags Scripts description: Learn about scripts for checking out Git tags +title: Checkout Tags Scripts --- -# Checkout Tags Scripts - Scripts for automating the process of checking out specific Git tags. ## Basic Checkout Script diff --git a/contents/docs/7-automation/scripts/managing-tags/index.mdx b/contents/docs/7-automation/scripts/managing-tags/index.mdx index 6d968e4c..995251f7 100644 --- a/contents/docs/7-automation/scripts/managing-tags/index.mdx +++ b/contents/docs/7-automation/scripts/managing-tags/index.mdx @@ -1,10 +1,8 @@ --- -title: Managing Tags Scripts description: Learn about scripts for managing Git tags +title: Managing Tags Scripts --- -# Managing Tags Scripts - Scripts for automating Git tag management operations. ## List Tags Script diff --git a/contents/docs/7-automation/scripts/tagging/index.mdx b/contents/docs/7-automation/scripts/tagging/index.mdx index b537842a..340ba4b5 100644 --- a/contents/docs/7-automation/scripts/tagging/index.mdx +++ b/contents/docs/7-automation/scripts/tagging/index.mdx @@ -1,10 +1,8 @@ --- -title: Tagging Scripts description: Learn about scripts for creating Git tags +title: Tagging Scripts --- -# Tagging Scripts - Scripts for automating the process of creating Git tags. ## Create Tag Script