new-issue.md

🎯 Purpose

The purpose of this guide is to give you the basic information you need to get going with GitHub. This guide is intended to be used for GitHub in a common configuration. It is not the end all and be all of the information available to help you succeed with GitHub, but is a curated list of the following GitHub resources as well as other public sources of information:

• GitHub User Help Docs

• GitHub Enterprise Help Docs

• GitHub Services Resources

• GitHub Resources

• GitHub Guides

• GitHub Videos

Example how to link to additional markdown files in the same repository

• GitHub Enterprise FAQ - Deutsch

The GitHub Platform

GitHub is more than "version control"; it is an all-inclusive and unified collaboration platform:

⏩ Get Going!

• 💻 Get Distributed
• ⚙️ Get Installed *
• 🔧 Get Configured *
• 📁 Get Organized
• 🔑 Get Access
• 🔩 Get Setup
• 🌊 Get Flowing
• ✅ Get Managing
• 📚 Get Documented
• 🔗 Get Integrated
• ⬆️ Get Upgraded *
• 📢 Get Informed
• 🆘 Get Help
• 🌐 Get Open Sourcing

* ENTERPRISE ONLY

💻 Get Distributed

Get familiarized with why modern distributed version control is an improvement over traditional centralized version control

• About Version Control (Distributed vs. Centralized)

• Git Basics (Snapshots vs. Differences)

• Intro to Distributed Version Control (vs. Centralized Version Control)

⚙️ Get Installed *

Get your GitHub Enterprise instance installed and on a virtualization platform of your choice

• Provisioning and installation

🔧 Get Configured *

Get your GitHub Enterprise instance configured with the right authentication and backup infrastructure for your environment

• Web-based management console

• Authenticating users for your GitHub Enterprise instance

• High Availability configuration

• Backups and disaster recovery

• Using GHE with a load balancer

• About Geo-replication

• Recommended architecture:

  

📁 Get Organized

Get your people and code organized to optimize discoverability and reuse

• Organizing People for Successful Collaboration (5 min video)

  • Collaborating with groups in organizations

  • Organizing members into teams

  • Creating repositories

  • e.g. @ GitHub Desktop

• Why organization structure matters

  • The immediate instinct may be to create an organization for every project or department at your company, leading to many divided groups that function in GitHub as siloes

  • This may seem like a good way to manage permissions and reduce noise, but it’s not always the ideal strategy

  • In fact, it is detrimental to cross-team collaboration and can result in administrative headaches down the line

  • Instead of creating many organizations and siloing users, we suggest using one or few organizations for shared ownership of repositories and making use of teams to segment users within those organizations -- e.g.: Google; Microsoft

    

🔑 Get Access

Get access and permissions in place to satisfy your security policies

• Permission levels for an organization

• Repository permission levels for an organization

• Permission levels for a user account repository

• Administering a repository

  • About protected branches

  • About required status checks

  • About branch restrictions

🔩 Get Setup

Get Git and GitHub setup for the first time

• Git and GitHub Setup

• Connecting to GitHub with SSH

• GitHub Desktop: Extend your GitHub workflow beyond your browser

• Atom: A customizable text editor

• GitHub for Atom: Git and GitHub integration inside Atom

🌊 Get Flowing

Get your work flowing to the right people and reviewed by the right people

• Understanding the GitHub Flow

• About branches

• About commits

• About pull requests

• About pull request reviews

• About pull request merges

• Mentioning users and teams

• e.g. @ Electron

✅ Get Managing

Get your work and projects managed from start to finish

• Describing and discussing work:

  • Managing your work with issues

  • Labeling issues and pull requests

  • Finding information in a repository

  • e.g. @ Atom

• Planning and tracking work:

  • Tracking progress with project boards

  • Tracking progress with milestones

  • Releases

  • e.g. @ Kubernetes

📚 Get Documented

Get information about your work and projects documented to share right next to your code

• READMEs -- e.g.  :  Spotify  ;  Docker

• Wikis -- e.g.  :  D3  ;  Netflix Hystrix  ;  Projects with great wikis

• GitHub Pages -- e.g.  :  Facebook React Native  ;  Twitter  ;  Best Buy  ;  GitHub Pages examples

🔗 Get Integrated

Get integrated with the rest of your development pipeline

• Products that integrate with the GitHub platform

• GitHub Services Integration

• GitHub Marketplace

• GitHub API

📢 Get Informed

Get informed on what's new with GitHub

• GitHub Blog

• GitHub Engineering

• The State of the Octoverse

• @github on Twitter

⬆️ Get Upgraded *

Get your GitHub Enterprise instance upgraded to the latest release

• Upgrading GitHub Enterprise

• GitHub Enterprise Releases

ℹ️ Get Enabled

Get enabled on the basics of Git and GitHub

• GitHub Learning Lab

• Git and GitHub learning resources

• On Demand Training  :  GitHub Learning Resources  ;  Learning Path

• GitHub Guides @ YouTube  :  Git Basics • Training  ;  Git and GitHub with Briana Swift (videos)

🆘 Get Help

Get dedicated help from GitHub to support your continued success

• GitHub Success Team  |  GitHub Professional Services

• GitHub.com Support  |  GitHub Enterprise Support

Get help from the GitHub community

• GitHub Community Forum  |  GitHub Platform Forum

🌐 Get Open Sourcing

Get collaborating with the Open Source community

• The largest open source community in the world

• Open Source Guides

• Explore GitHub

• Open source organizations -- e.g.:

  • Open Source at Microsoft  :  TypeScript  ;  Azure Docs

  • Capital One Open Source

  • Develop with Deere

  • Walmart Labs

  • Spotify

  • Mapbox