Commit 4eacb58f authored by Xueshan Feng's avatar Xueshan Feng
Browse files

fix toc.

parent ba2a6c95
......@@ -2,44 +2,44 @@
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
- [<a name="422-error" ></a> Why do I get "422 Error" when sign-in?](#a-name422-error-a-why-do-i-get-422-error-when-sign-in)
- [<a name="help" ></a> How do I get help?](#a-namehelp-a-how-do-i-get-help)
- [<a name="minimum-setup" ></a> What is the minimum setup before I start using GitLab?](#a-nameminimum-setup-a-what-is-the-minimum-setup-before-i-start-using-gitlab)
- [<a name="usage-limits" ></a> What are GitLab usage limits?](#a-nameusage-limits-a-what-are-gitlab-usage-limits)
- [<a name="generate-ssh-key"></a> How to generate and upload GitLab ssh-key?](#a-namegenerate-ssh-keya-how-to-generate-and-upload-gitlab-ssh-key)
- [<a name="GitLab-project"></a> What is a GitLab project?](#a-namegitlab-projecta-what-is-a-gitlab-project)
- [<a name="username-space"></a> What is the username space?](#a-nameusername-spacea-what-is-the-username-space)
- [<a name="project-limit"></a> How many personal GitLab projects I can create?](#a-nameproject-limita-how-many-personal-gitlab-projects-i-can-create)
- [<a name="project-visibility"></a> What is the default project visibility?](#a-nameproject-visibilitya-what-is-the-default-project-visibility)
- [<a name="GitLab-group"></a> What is a GitLab group?](#a-namegitlab-groupa-what-is-a-gitlab-group)
- [<a name="workgroup"></a>Is GitLab intergated with Stanford's workgroup?](#a-nameworkgroupais-gitlab-intergated-with-stanfords-workgroup)
- [<a name="restore-repo"></a>I accidentally deleted my repository, how do I restore it?](#a-namerestore-repoai-accidentally-deleted-my-repository-how-do-i-restore-it)
- [Why do I get "422 Error" when sign-in?](#why-do-i-get-422-error-when-sign-in)
- [How do I get help?](#how-do-i-get-help)
- [What is the minimum setup before I start using GitLab?](#what-is-the-minimum-setup-before-i-start-using-gitlab)
- [What are GitLab usage limits?](#what-are-gitlab-usage-limits)
- [How to generate and upload GitLab ssh-key?](#how-to-generate-and-upload-gitlab-ssh-key)
- [What is a GitLab project?](#what-is-a-gitlab-project)
- [What is the username space?](#what-is-the-username-space)
- [How many personal GitLab projects I can create?](#how-many-personal-gitlab-projects-i-can-create)
- [What is the default project visibility?](#what-is-the-default-project-visibility)
- [What is a GitLab group?](#what-is-a-gitlab-group)
- [Is GitLab integrated with Stanford's workgroup?](#is-gitlab-integrated-with-stanfords-workgroup)
- [I accidentally deleted my repository, how do I restore it?](#i-accidentally-deleted-my-repository-how-do-i-restore-it)
- [I do I get notification for scheduled maintenance outage?](#i-do-i-get-notification-for-scheduled-maintenance-outage)
- [<a name="migrate"></a>How do I migrate github project to GitLab?](#a-namemigrateahow-do-i-migrate-github-project-to-gitlab)
- [How do I migrate github project to GitLab?](#how-do-i-migrate-github-project-to-gitlab)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## <a name="422-error" ></a> Why do I get "422 Error" when sign-in?
## Why do I get "422 Error" when sign-in?
If you get this error the first time your sign-in, most likely, your email contact information in StanfordYou
is either private or doesn't exist. It can be caused by sponsorship changes.
code.stanford.edu service requires your email address to log you in. You should be able to go to stanfordyou.stanford.edu and add your email address - click on 'Maintain your directory and AlertSU emergency contact information', then click 'change...' next to 'SU Contact Info'. You need at least Stanford visibility for your email address.
## <a name="help" ></a> How do I get help?
## How do I get help?
For general usage questions, Use [Gitlab's help](https://code.stanford.edu/help) documetation. For backend server code.stanford.edu related
questions, please submit a [HelpSU](https://helpsu.stanford.edu/?pcat=itarch) ticket.
You can also join *git* slack channel on [StanfordCop team] (https://stanfordcop.slack.com).
## <a name="minimum-setup" ></a> What is the minimum setup before I start using GitLab?
## What is the minimum setup before I start using GitLab?
Most of your profile settings are already populated from Stanford directory when you sign up with GitLab, such as your account id (sunetid), name, email. You should not change these.
You can click **Profile Settings** button on the left panel to change default appearance for your GitLab web interface. You definitely want to look into the "SSH Keys" tab. In this tab, click the "Add SSH Key" button to add SSH keys so you can communicate with GitLab through git command.
## <a name="usage-limits" ></a> What are GitLab usage limits?
## What are GitLab usage limits?
* PHI data: NO
* Default personal repository limit: *50*
......@@ -51,15 +51,16 @@ Container Registry images uploaded to GitLab Registry Service doesn't have size
For large size repository, consider to use [GitLab LFS](https://docs.gitlab.com/ee/workflow/lfs/manage_large_binaries_with_git_lfs.html).
## <a name="generate-ssh-key"></a> How to generate and upload GitLab ssh-key?
## How to generate and upload GitLab ssh-key?
* [Generate ssh-key](http://doc.GitLab.com/ce/ssh/README.html)
* [Add ssh-key](http://doc.GitLab.com/ce/GitLab-basics/create-your-ssh-keys.html#add-your-ssh-key)
## <a name="GitLab-project"></a> What is a GitLab project?
## What is a GitLab project?
A GitLab project is all things about a project: a git repository, wiki, issues, documentations, etc.
## <a name="username-space"></a> What is the username space?
## What is the username space?
When you create a new project in GitLab, the default namespace for the project is the personal namespace associated with your GitLab userid. The git repositories created in your personal namespace looks like this:
......@@ -67,23 +68,23 @@ When you create a new project in GitLab, the default namespace for the project i
git@code.stanford.edu:<sunetid>/<project>.git
```
## <a name="project-limit"></a> How many personal GitLab projects I can create?
## How many personal GitLab projects I can create?
The default personal project limit is *50*.
## <a name="project-visibility"></a> What is the default project visibility?
## What is the default project visibility?
Project visibility level in GitLab can be either private, internal or public. The default is **private**. As a project owner, you can change your project visibility by using your projetct's "Settings" function.
## <a name="GitLab-group"></a> What is a GitLab group?
## What is a GitLab group?
Gitlab group allows you group projects together into one namespace (directory), so you can give other users permission to all projects in one place. You are allowed to create groups or transfer personal projects to a group that you own. Here is more information about [GitLab groups](http://doc.GitLab.com/ee/workflow/groups.html#GitLab-groups).
## <a name="workgroup"></a>Is GitLab intergated with Stanford's workgroup?
## Is GitLab integrated with Stanford's workgroup?
Not yet. You can freely assemble your project team from members in different groups.
## <a name="restore-repo"></a>I accidentally deleted my repository, how do I restore it?
## I accidentally deleted my repository, how do I restore it?
You are asked to confirm the deletion; If you still delete it, you maybe able to find a checked-out repo on your computer, and
can use it to re-create your repo; If you or your co-workers don't have a local copy, then file a HelpSU ticket, we can
......@@ -104,10 +105,10 @@ The actual scheduled upgrade, impact, and outage duration will be posted on http
If you have automated jobs that need to connect to the service, please put them outside of the standing maintenance window. It is also a good practice to add retires to improve application resilience.
## <a name="migrate"></a>How do I migrate github project to GitLab?
## How do I migrate github project to GitLab?
Navigate to [https://code.stanford.edu/projects/new](https://code.stanford.edu/projects/new). At the top of the form, you will have the option to make either a blank project, to create a project from a template, or to import a project. Select to import a project. Next, select to import a project from GitHub.
Next, you need to let GitHub know it's okay for code.stanford.edu to look at all of your repos. You do this by giving code.stanford.edu a token (which works sort of like a password, but only for specific tasks and scopes). In a new browser tab, go to [https://github.com/settings/tokens](https://github.com/settings/tokens), and click "generate token". Under "token description" enter something like code.stanford.edu, and select the "repo" scope (which allows code.stanford.edu to read all of your repos, and do a few other things). In the next screen, copy your personal access token. This is the only time you'll be able to copy the token you just generated, though if you make a mistake, you can generate a new one at any time.
Drop your access token into the code.stanford.edu browser tab, and list your repos. For the repos you want to imporpt, make sure that you have the correct namespace listed, and optionally change the repo name. Finally, click "import", and you should be done importing into GitLab.
Drop your access token into the code.stanford.edu browser tab, and list your repos. For the repos you want to import, make sure that you have the correct namespace listed, and optionally change the repo name. Finally, click "import", and you should be done importing into GitLab.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment