/doc/README.md
Markdown | 67 lines | 61 code | 6 blank | 0 comment | 0 complexity | 1ed2c2f9999b745bb6ed9fb29c2613ca MD5 | raw file
- # Documentation
- ## User documentation
- - [API](api/README.md) Automate GitLab via a simple and powerful API.
- - [CI](ci/README.md) GitLab Continuous Integration (CI) getting started, `.gitlab-ci.yml` options, and examples.
- - [GitLab as OAuth2 authentication service provider](integration/oauth_provider.md). It allows you to login to other applications from GitLab.
- - [GitLab Basics](gitlab-basics/README.md) Find step by step how to start working on your commandline and on GitLab.
- - [Importing to GitLab](workflow/importing/README.md).
- - [Markdown](markdown/markdown.md) GitLab's advanced formatting system.
- - [Migrating from SVN](workflow/importing/migrating_from_svn.md) Convert a SVN repository to Git and GitLab
- - [Permissions](permissions/permissions.md) Learn what each role in a project (external/guest/reporter/developer/master/owner) can do.
- - [Profile Settings](profile/README.md)
- - [Project Services](project_services/project_services.md) Integrate a project with external services, such as CI and chat.
- - [Public access](public_access/public_access.md) Learn how you can allow public and internal access to projects.
- - [Analytics](analytics/README.md)
- - [SSH](ssh/README.md) Setup your ssh keys and deploy keys for secure access to your projects.
- - [Webhooks](web_hooks/web_hooks.md) Let GitLab notify you when new code has been pushed to your project.
- - [Workflow](workflow/README.md) Using GitLab functionality and importing projects from GitHub and SVN.
- - [GitLab Pages](pages/README.md) Using GitLab Pages.
- - [Custom templates for issues and merge requests](customization/issue_and_merge_request_template.md) Pre-fill the description of issues and merge requests to your liking.
- ## Administrator documentation
- - [Audit Events](administration/audit_events.md) Check how user access changed in projects and groups.
- - [Authentication/Authorization](administration/auth/README.md) Configure
- external authentication with LDAP, SAML, CAS and additional Omniauth providers.
- - [Changing the appearance of the login page](customization/branded_login_page.md) Make the login page branded for your GitLab instance.
- - [Custom git hooks](hooks/custom_hooks.md) Custom git hooks (on the filesystem) for when webhooks aren't enough.
- - [Email](tools/email.md) Email GitLab users from GitLab
- - [Git Hooks](git_hooks/git_hooks.md) Advanced push rules for your project.
- - [Help message](customization/help_message.md) Set information about administrators of your GitLab instance.
- - [Install](install/README.md) Requirements, directory structures and installation from source.
- - [Installing your license](license/README.md)
- - [Integration](integration/README.md) How to integrate with systems such as JIRA, Redmine, LDAP and Twitter.
- - [Restart GitLab](administration/restart_gitlab.md) Learn how to restart GitLab and its components
- - [Issue closing](customization/issue_closing.md) Customize how to close an issue from commit messages.
- - [Libravatar](customization/libravatar.md) Use Libravatar for user avatars.
- - [Log system](logs/logs.md) Log system.
- - [Environment Variables](administration/environment_variables.md) to configure GitLab.
- - [Operations](operations/README.md) Keeping GitLab up and running
- - [Raketasks](raketasks/README.md) Backups, maintenance, automatic webhook setup and the importing of projects.
- - [Repository checks](administration/repository_checks.md) Periodic Git repository checks
- - [Security](security/README.md) Learn what you can do to further secure your GitLab instance.
- - [System hooks](system_hooks/system_hooks.md) Notifications when users, projects and keys are changed.
- - [Update](update/README.md) Update guides to upgrade your installation.
- - [Welcome message](customization/welcome_message.md) Add a custom welcome message to the sign-in page.
- - [Reply by email](incoming_email/README.md) Allow users to comment on issues and merge requests by replying to notification emails.
- - [Migrate GitLab CI to CE/EE](migrate_ci_to_ce/README.md) Follow this guide to migrate your existing GitLab CI data to GitLab CE/EE.
- - [Downgrade back to CE](downgrade_ee_to_ce/README.md) Follow this guide if you need to downgrade from EE to CE.
- - [git-annex configuration](workflow/git_annex.md#configuration)
- - [Git LFS configuration](workflow/lfs/lfs_administration.md)
- - [Housekeeping](administration/housekeeping.md) Keep your Git repository tidy and fast.
- - [GitLab Pages configuration](pages/administration.md)
- - [Elasticsearch](integration/elasticsearch.md) Enable Elasticsearch
- - [GitLab Performance Monitoring](monitoring/performance/introduction.md) Configure GitLab and InfluxDB for measuring performance metrics
- - [Sidekiq Troubleshooting](administration/troubleshooting/sidekiq.md) Debug when Sidekiq appears hung and is not processing jobs
- - [High Availability](administration/high_availability/README.md) Configure multiple servers for scaling or high availability
- - [GitLab GEO](gitlab-geo/README.md) Configure GitLab GEO, a
- secondary read-only GitLab instance
- ## Contributor documentation
- - [Documentation styleguide](development/doc_styleguide.md) Use this styleguide if you are
- contributing to documentation.
- - [Development](development/README.md) Explains the architecture and the guidelines for shell commands.
- - [Legal](legal/README.md) Contributor license agreements.