docs(git_github) add content to roadmap (#6520)
Co-authored-by: Stavros Siamantas <ssiamantas@shipreality.com>pull/6523/head
parent
6d73c805b2
commit
940bf2ebdb
23 changed files with 173 additions and 24 deletions
@ -1 +1,7 @@ |
||||
# 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: |
||||
|
||||
- [@official@About GitHub Campus Program](https://docs.github.com/en/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program) |
@ -1 +1,7 @@ |
||||
# 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. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@Creating GitHub Apps](https://docs.github.com/en/apps/creating-github-apps) |
@ -1 +1,8 @@ |
||||
# 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. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@Configuring a custom domain for your GitHub Pages site](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site) |
||||
- [@video@How to Host a Website on GitHub Pages Free (Custom Domain Setup Included)](https://www.youtube.com/watch?v=e5AwNU3Y2es&t=156s) |
@ -1 +1,8 @@ |
||||
# 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. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@arcticle@How to Deploy a Static Website for Free Using Github Pages](https://medium.com/flycode/how-to-deploy-a-static-website-for-free-using-github-pages-8eddc194853b) |
||||
- [@video@How to Host a Website on GitHub Pages Free (Custom Domain Setup Included)](https://www.youtube.com/watch?v=e5AwNU3Y2es) |
@ -1 +1,3 @@ |
||||
# 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. |
@ -1 +1,7 @@ |
||||
# 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. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@GitHub Apps Documentation](https://docs.github.com/en/apps) |
@ -1,5 +1,8 @@ |
||||
# GitHub Classroom |
||||
|
||||
Managing and organizing your class is easy with GitHub Classroom. It allows educators to track and manage assignments directly from a dashboard, automatically grade student work, and provide assistance when students encounter difficulties. GitHub Classroom leverages GitHub, the industry-standard tool used by developers, to create a seamless experience for both educators and students. |
||||
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. |
||||
|
||||
A valuable resource for understanding GitHub Classroom is this comprehensive playlist from the GitHub Education channel: [GitHub Classroom Getting Started Guide](https://www.youtube.com/watch?v=xVVeqIDgCvM&list=PLIRjfNq867bewk3ZGV6Z7a16YDNRCpK3u). The playlist provides a thorough introduction to using GitHub Classroom effectively. |
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@About GitHub Classroom](https://docs.github.com/en/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom) |
||||
- [@video@GitHub Classroom - Getting Started Guide](https://www.youtube.com/watch?v=xVVeqIDgCvM&list=PLIRjfNq867bewk3ZGV6Z7a16YDNRCpK3u) |
@ -1 +1,8 @@ |
||||
# 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. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@GitHub Codespaces Overview](https://docs.github.com/en/codespaces/overview) |
||||
- [@video@How to Deploy a GitHub Codespace](https://www.youtube.com/watch?v=_01iCF9sO1c) |
@ -1 +1,9 @@ |
||||
# 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. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@Quickstart for GitHub Copilot](https://docs.github.com/en/copilot/quickstart) |
||||
- [@video@Intro to GitHob Copilot in Visual Studio](https://www.youtube.com/watch?v=z1ycDvspv8U) |
||||
- [@video@GitHub Copilot in VSCode: Top 10 Features Explained](https://www.youtube.com/watch?v=2nPoiUJpDaU) |
@ -1 +1,3 @@ |
||||
# 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. |
@ -1 +1,9 @@ |
||||
# 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. |
||||
|
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@Creating gists](https://docs.github.com/en/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists) |
||||
- [@official@REST API endpoints for gists](https://docs.github.com/en/rest/gists/gists?apiVersion=2022-11-28) |
@ -1 +1,8 @@ |
||||
# 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. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@GitHub Marketplace](https://github.com/marketplace) |
||||
- [@official@About GitHub Marketplace for apps](https://docs.github.com/en/apps/github-marketplace/github-marketplace-overview/about-github-marketplace-for-apps) |
@ -1 +1,8 @@ |
||||
# 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. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@Prototyping with AI models](https://docs.github.com/en/github-models/prototyping-with-ai-models) |
||||
- [@video@GitHub Models DEMO | AI models for developers on GitHub](https://www.youtube.com/watch?v=WiBB8Lsgl7I) |
@ -1 +1,8 @@ |
||||
# 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. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@Introduction to GitHub Packages](https://docs.github.com/en/packages/learn-github-packages/introduction-to-github-packages) |
||||
- [@official@GitHub Packages documentation](https://docs.github.com/en/packages) |
@ -1 +1,9 @@ |
||||
# 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. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@About GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages) |
||||
- [@official@Ceating a GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site) |
||||
- [@official@GitHub Pages examples](https://github.com/collections/github-pages-examples) |
@ -1 +1,9 @@ |
||||
# 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. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@GitHub security features](https://docs.github.com/en/code-security/getting-started/github-security-features) |
||||
- [@official@Dependabot quickstart guide](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide) |
||||
- [@official@About user alerts](https://docs.github.com/en/code-security/secret-scanning/managing-alerts-from-secret-scanning/about-alerts#about-user-alerts) |
@ -1 +1,8 @@ |
||||
# 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. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@Sponsoring an open source contributor through GitHub](https://docs.github.com/en/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor-through-github) |
||||
- [@official@Receiving sponsorships through GitHub Sponsors](https://docs.github.com/en/sponsors/receiving-sponsorships-through-github-sponsors) |
@ -1 +1,8 @@ |
||||
# 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. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@GitHub GraphQL API documentation](https://docs.github.com/en/graphql) |
||||
- [@official@Forming calls with GraphQL](https://docs.github.com/en/graphql/guides/forming-calls-with-graphql) |
@ -1 +1,8 @@ |
||||
# OAuth Apps |
||||
|
||||
GitHub OAuth Apps are a way to integrate with the GitHub platform using OAuth authentication. They allow developers to create custom integrations that can automate tasks, provide real-time notifications, and build custom workflows. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@Creating an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) |
||||
- [@video@GitHub Login With React (GitHub APIs, GitHub OAuth 2.0 Authentication)](https://www.youtube.com/watch?v=rRn2EisxPl4) |
@ -1 +1,9 @@ |
||||
# 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. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@GitHub REST API documentation](https://docs.github.com/en/rest?apiVersion=2022-11-28) |
||||
- [@official@Quickstart for GitHub REST API](https://docs.github.com/en/rest/quickstart?apiVersion=2022-11-28) |
||||
- [@video@[Tutorial] - How to use GitHub REST API for Beginners](https://www.youtube.com/watch?v=OvfLavRD1Os) |
@ -1 +1,8 @@ |
||||
# 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. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@Static Site Generators](https://github.com/collections/static-site-generators) |
||||
- [@official@About GitHub Pages and Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll) |
@ -1 +1,7 @@ |
||||
# 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: |
||||
|
||||
- [@official@Apply to GitHub Education as a student](https://docs.github.com/en/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/apply-to-github-education-as-a-student) |
@ -1 +1,9 @@ |
||||
# 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. |
||||
|
||||
Visit the following resources to learn more: |
||||
|
||||
- [@official@About webhooks](https://docs.github.com/en/webhooks/about-webhooks) |
||||
- [@official@Webhooks documentation](https://docs.github.com/en/webhooks) |
||||
- [@video@How to use GitHub Webhooks with Discord](https://www.youtube.com/watch?v=-gyEHj0CVx0&) |
Loading…
Reference in new issue