summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcia Ramos <virtua.creative@gmail.com>2017-07-20 18:55:25 -0300
committerMarcia Ramos <virtua.creative@gmail.com>2017-07-20 18:55:25 -0300
commitc4d935cabd3a9119ff4c431fdec3b7ade00988da (patch)
tree761018225ab29c29db4792807d1e23af533e4275
parent26c73682dcee08aa399dbf265bb0f0edaf4170d3 (diff)
downloadgitlab-ce-docs-new-topic-user.tar.gz
-rw-r--r--doc/user/index.md121
1 files changed, 83 insertions, 38 deletions
diff --git a/doc/user/index.md b/doc/user/index.md
index 63c5fe76c83..e2bf715ac2b 100644
--- a/doc/user/index.md
+++ b/doc/user/index.md
@@ -1,64 +1,109 @@
# User documentation
-Enhance your workflow with GitLab, the most complete software development platform.
+GitLab is a fully integrated software development platform that enables you
+and your team to work cohersively, faster, transparently, and effectivelly,
+since discussion a new idea, until taking that idea to production, from within
+the same platform.
+
+## Overview
+
+Welcome to GitLab! As a GitLab user you'll have access to all the features
+your subscription includes, except the GitLab Administrator settings. An
+admin user (the one who installs and maintain GitLab) can use GitLab the
+same way as regular users do, but they also
+have access to GitLab's configuration set itself. For GitLab.com, admin
+privileges are restricted to the GitLab team.
Learn how to use GitLab and its features through the **User documentation**.
If you run your own GitLab instance and are looking for the administration settings,
please refer to the [administration]() documentation.
+## Use cases
+
+GitLab is a git-base version control platforms that integrates chat, issue tracker,
+issue boards, code hosting, continuous integration, static website server, container registry,
+service desk, and a lot more, in one platforms. For example, we can use GitLab for:
+
+- **Develop software**: for yourself or for your team, GitLab is the most complete platform
+for software development
+ - [In 13 minutes from Kubernetes to a complete application development tool](https://about.gitlab.com/2016/11/14/idea-to-production/)
+ - [GitLab Workflow, an Overview](https://about.gitlab.com/2016/10/25/gitlab-workflow-an-overview/)
+- **Build, test, and deploy** the software you develop with **GitLab CI/CD**
+- **Deploy** your app with **continuous methods** (continuous delivery, continuous deployment)
+ - [Continuous Delivery of a Spring Boot application with GitLab CI and Kubernetes](https://about.gitlab.com/2016/12/14/continuous-delivery-of-a-spring-boot-application-with-gitlab-ci-and-kubernetes/)
+ - [Automated Debian Package Build with GitLab CI](https://about.gitlab.com/2016/10/12/automated-debian-package-build-with-gitlab-ci/)
+- Build, test, and deploy **static websites** for free with **GitLab Pages**
+ - [Building a new GitLab Docs site with Nanoc, GitLab CI, and GitLab Pages](https://about.gitlab.com/2016/12/07/building-a-new-gitlab-docs-site-with-nanoc-gitlab-ci-and-gitlab-pages/)
+- Redact and review **texts and books**
+- Build Android and iOS apps
+ - [Setting up GitLab CI for Android projects](https://about.gitlab.com/2016/11/30/setting-up-gitlab-ci-for-android-projects/)
+
+## Projects
+
+In GitLab, you can create projects for numerous reasons, such as, host
+your code, use it as an issue tracker, collaborate on code, and continuously
+build, test, and deploy your app with built-in GitLab CI/CD. Or, you can do
+it all at once, from one project.
+
+Your projects can be public, internal or private, GitLab does not limit
+the number of private repositories you can create.
+
+When you create a project in GitLab, you'll have access to a large number of
+features:
+
+- [Repository](repository/index.md): safely host your code with version control,
+view branches, commits, tags, git graphs, contributors, branch comparisons,
+and the file chart (file languages, statistics)
+- [Issues](issues/index.md): make collaboration faster by discussing
+implementations in the same place your code is hosted
+ - [Issue Boards](project/issue_board.md#multiple-issue-boards): organize and prioritize your workflow with the ability
+ to view your issues in one screen, and moving them around according to your workflow
+ - **GitLab Enterprise Edition Starter** users can also create [Multiple Issue Boards](),
+ facilitating the workflow for teams working on the same project
+- [Merge Requests](merge_requests/index.md): submit code using the best of your branching strategy,
+gather feedback, perform inline reviews. With **GitLab Enterprise Edition Starter**
+you can also and ask for your manager's [approval](project/merge_requests/merge_request_approvals.md) before merging
+- [Milestones](project/milestones/index.md): track issues and merge requests created to
+achieve a broader goal in a certain period of time
+- [GitLab CI/CD](ee/ci/README.md): configure GitLab CI to build, test, and deploy your app directly from GitLab
+ - [Configure GitLab CI](../ci/quick_start/README.md#creating-a-simple-gitlab-ci-yml-file) for your project
+ - [Pipelines](../ci/pipelines.md#pipelines):
+ - [Container Registry](project/container_registry.md)
+- [GitLab Pages](project/pages/index.md): build, test, and deploy your static website with GitLab Pages
+- [Snippets](snippets.md): create and share your code snippets
+- [Settings]()
+ - [Integrations]() (Services)
+
+## Groups
+
+
## Account
There is a lot you can customize and configure
to enjoy the best of GitLab.
+> To access your profile settings,
+locate your **avatar** at the upright corner of your screen,
+expand the dropdown menu, and click **Settings**
+
From your profile settings, you can:
- Adjust your [profile settings](): add your personal information
(e-mails, access tokens, social info)
-- Setup account settings: private tokens, 2FA, change your username,
-and remove your account
-- Manage OAuth authorized applications
-- Manage access tokens for your devices
-- Manage notification settings
+- Setup account settings: private tokens, [2FA](profile/account/two_factor_authentication.md),
+change your username, and remove your account
+- Manage OAuth authorized applications (e.g., another GitLab instance, a GUI client, etc)
+- Manage [access tokens](profile/personal_access_tokens.md) for your devices (e.g., desktop, laptop, mobile)
+- Manage [notification settings](../workflow/notifications.md#notification-settings)
- Manage emails: you can add more than one email and choose which you
want as primary, notifications, and public
- Change your password
- Manage notifications per project and per group
-- Manage SSH keys
-- Adjust your preferences: syntax highlighting theme,
+- Manage [SSH](ssh/README.md) keys
+- Adjust your [preferences](preferences.md): syntax highlighting theme,
navigation, behavior for layout, dashboard, and projects landing pages.
- Check your authentication log (sign in dates and methods)
-## Projects
-
-In GitLab, you can create projects for numerous reasons, such as, host
-your code, use it as an issue tracker, collaborate on code, and continuously
-build, test, and deploy your app with built-in GitLab CI/CD. Or, you can do
-it all at once, from one project.
-
-Your projects can be public, internal or private, GitLab does not limit
-the number of private repositories you can create.
-
-- [Project](project/)
- - [Repository](repository/index.md): safely host your code with version control
- - [Issues](issues/index.md): make collaboration faster by discussing
- implementations in the same place your code is hosted
- - [Issue Boards](): organize and prioritize your workflow with the ability
- to view your issues in one screen, and moving them around according to your workflow
- GitLab Enterprise Edition Starter users can also create [Multiple Issue Boards](),
- facilitating the workflow for teams working on the same project
- - [Merge Requests](merge_requests/index.md): submit code using the best of your branching strategy,
- gather feedback, perform inline reviews. With GitLab Enterprise Edition Starter
- you can also and ask for your manager's approval before merging
- - Milestones
- - GitLab CI/CD:
- - [Configure GitLab CI]() for your project
- - [Pipelines]():
- - [Container Registry]()
- - [Snippets]()
- - [Settings]()
- - [Integrations]() (Services)
-
## Discussions
## Todos