diff --git a/gitHubAdmin/quickGuides/membersQuickSetup.md b/gitHubAdmin/quickGuides/membersQuickSetup.md new file mode 100644 index 0000000..70b41d2 --- /dev/null +++ b/gitHubAdmin/quickGuides/membersQuickSetup.md @@ -0,0 +1,9 @@ +# How to add new members + +![Organization Teams tab](gitHubOrgTeamPage.png) + +
+[Admin Overview](overview) +[Site Index](https://frc6506.github.io/docs/index) +
+_Updated 20210415_ diff --git a/gitHubAdmin/quickGuides/repositoryQuickSettup.md b/gitHubAdmin/quickGuides/repositoryQuickSettup.md deleted file mode 100644 index 0e436cf..0000000 --- a/gitHubAdmin/quickGuides/repositoryQuickSettup.md +++ /dev/null @@ -1,55 +0,0 @@ -# Repositories Quick Setup Guide - -This guide will explain how to create an official team repository and share it with the programming team. - -## Initial Creation - -![Organization Repositories tab](gitHubOrgHomePage-QuickSetupAnnotation.png) - -1. Click New -
-![Repository Creation Menu](gitHubRepoCreation.png) -1. Ensure that the owner is listed as `frc6506`. - > This ensures that the team can track, look back on, and archive old work. -1. Give it name- include the project and year. We don't currently have a set pattern yet. -1. Give it a description -1. Set the repository to `Public`. - > Most FRC doing is not too complex or special, so there is no reason not try to be friendly with others. It also makes it easier to work with others. -1. Make sure `Add a README file` is checked. This will present a nice space to make notes on the project. -1. For WPILib-j projects: Check `Add .gitignore` and select `Java` for the `.gitignore template`. - > This saves bandwidth by ignore build optimization files that can easily be generated locally. -1. Feel free to ignore the `Choose a license` button, however if you do selected it, FIRST prefers the BSD-3-clause license. -1. Click `Create repository` - -## Initial Setup (Optional Part) - -Turn off things you don't need/won't use in `Settings` > `Options`. These are designed for if you plan on allot of outside people using and working on your project: - -- `Wikis` -- `Sponsorships` (off by default) -- `Discussions` (off by default) - -## Initial Setup (Necessary Part) - -Now that you have a repository, you need to prepare it for use by the programming team. - > Note that this tutorial assumes one is adding an entire organizational team to the repository instead of adding everyone individually. You can also use these instructions to add other people who are not part of a team quickly, although the `Invite teams or people` button may move around. - -![Repository Access Controls](repoAccessControls.png) - -1. Go to `Manage access` -1. Click on `Invite teams or people` -
-![Repository Access Control Add Dialog](repoAccessAdd.png) -1. Search for `CORE` and select `frc6506/core` -![Repository Add and Set Permissions Add Dialog](repoAccessAddPermissions.png) -1. Select `Write` to allow all members of the `frc6506/CORE` (the main programming team) team to write. Don't worry about admins, organization admins already have access to everything. -1. Click the green `Add frc6506/core to this repository` button. - -
-You can now clone the repository to your computers and use it to manage files and versions. See the index for help getting started with git/GitHub on your local computer and FRC coding. - -
-[Admin Overview](overview) -[Site Index](https://frc6506.github.io/docs/index) -
-_Updated 20210416T1509 PDT_ diff --git a/gitHubAdmin/quickGuides/repositoryQuickSetup.md b/gitHubAdmin/quickGuides/repositoryQuickSetup.md index 70b41d2..0e436cf 100644 --- a/gitHubAdmin/quickGuides/repositoryQuickSetup.md +++ b/gitHubAdmin/quickGuides/repositoryQuickSetup.md @@ -1,9 +1,55 @@ -# How to add new members +# Repositories Quick Setup Guide -![Organization Teams tab](gitHubOrgTeamPage.png) +This guide will explain how to create an official team repository and share it with the programming team. + +## Initial Creation + +![Organization Repositories tab](gitHubOrgHomePage-QuickSetupAnnotation.png) + +1. Click New +
+![Repository Creation Menu](gitHubRepoCreation.png) +1. Ensure that the owner is listed as `frc6506`. + > This ensures that the team can track, look back on, and archive old work. +1. Give it name- include the project and year. We don't currently have a set pattern yet. +1. Give it a description +1. Set the repository to `Public`. + > Most FRC doing is not too complex or special, so there is no reason not try to be friendly with others. It also makes it easier to work with others. +1. Make sure `Add a README file` is checked. This will present a nice space to make notes on the project. +1. For WPILib-j projects: Check `Add .gitignore` and select `Java` for the `.gitignore template`. + > This saves bandwidth by ignore build optimization files that can easily be generated locally. +1. Feel free to ignore the `Choose a license` button, however if you do selected it, FIRST prefers the BSD-3-clause license. +1. Click `Create repository` + +## Initial Setup (Optional Part) + +Turn off things you don't need/won't use in `Settings` > `Options`. These are designed for if you plan on allot of outside people using and working on your project: + +- `Wikis` +- `Sponsorships` (off by default) +- `Discussions` (off by default) + +## Initial Setup (Necessary Part) + +Now that you have a repository, you need to prepare it for use by the programming team. + > Note that this tutorial assumes one is adding an entire organizational team to the repository instead of adding everyone individually. You can also use these instructions to add other people who are not part of a team quickly, although the `Invite teams or people` button may move around. + +![Repository Access Controls](repoAccessControls.png) + +1. Go to `Manage access` +1. Click on `Invite teams or people` +
+![Repository Access Control Add Dialog](repoAccessAdd.png) +1. Search for `CORE` and select `frc6506/core` +![Repository Add and Set Permissions Add Dialog](repoAccessAddPermissions.png) +1. Select `Write` to allow all members of the `frc6506/CORE` (the main programming team) team to write. Don't worry about admins, organization admins already have access to everything. +1. Click the green `Add frc6506/core to this repository` button. + +
+You can now clone the repository to your computers and use it to manage files and versions. See the index for help getting started with git/GitHub on your local computer and FRC coding.
[Admin Overview](overview) [Site Index](https://frc6506.github.io/docs/index)
-_Updated 20210415_ +_Updated 20210416T1509 PDT_