Removing duplication by putting everything in the readme. Allow us to close issu…

…es that deviate from the guidelines.

Removing duplication by putting everything in the readme. Allow us to close issu…
…es that deviate from the guidelines.
Sytse Sijbrandij
1 parent 3392f6c1
Showing 3 changed files with 55 additions and 82 deletions Show diff stats
CONTRIBUTING.md
README.md
doc/install/installation.md
 # Contribute to GitLab
-If you have a question or want to contribute to GitLab this guide show you the appropriate channel to use.
+This guide details how to use pull requests and the issues to improve GitLab.
-## Ruling out common errors
+## Closing deviating issues
-Some errors are common and it may so happen, that you are not the only one who stumbled over a particular issue. We have [collected several of those and documented quick solutions](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide) for them.
-
-## Support forum
-
-Please visit our [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) for any kind of question regarding the usage or adiministration/configuration of GitLab.
-
-### Use the support forum if ...
-
-* You get permission denied errors
-* You can't see your repos
-* You have issues cloning, pulling or pushing
-* You have issues with web_hooks not firing
-
-**Search** for similar issues before posting your own, there's a good chance somebody else had the same issue you have now and had it resolved.
-
-## Support options
-
-Community support in the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) is done by volunteers. A support subscription is available from [GitLab.com](http://blog.gitlab.com/subscription/)
-
-## Feature suggestions
-
-Feature suggestions don't belong in issues but can go to [Feedback forum](http://gitlab.uservoice.com/forums/176466-general) where they can be voted on.
+Pull requests and issues not in line with the guidelines listed in this document will be closed with just a link to this paragraph. GitLab is popular open source project and the capacity to deal with issues and pull requests is limited. To get support for your problems please use other channels as detailed in [the getting help section of the readme](https://github.com/gitlabhq/gitlabhq#getting-help). [Support subscriptions](http://www.gitlab.com/subscription/) and [consulting services](http://www.gitlab.com/consultancy/) are available from GitLab.com.
 ## Pull requests
-You can submit a pull request if you have made an improvement to GitLab. The issues we would really like a pull request for are listed with the [status 'accepting merge/pull requests' on our feedback forum](http://feedback.gitlab.com/forums/176466-general/status/796455).
+We welcome pull request with improvements to GitLab code and/or documentation. The issues we would really like a pull request for are listed with the [status 'accepting merge/pull requests' on our feedback forum](http://feedback.gitlab.com/forums/176466-general/status/796455) but other improvements are also welcome.
+
+## Pull request guidelines
-Code speaks louder than words. If you can please submit a pull request with the fix including tests. The workflow to make a pull request is as follows:
+ If you can please submit a pull request with the fix including tests. The workflow to make a pull request is as follows:
 1. Fork the project on GitHub
 1. Create a feature branch
@@ -53,26 +34,20 @@ We will accept pull requests if:
 For examples of feedback on pull requests please look at already [closed pull requests](https://github.com/gitlabhq/gitlabhq/pulls?direction=desc&page=1&sort=created&state=closed).
-## Submitting via GitHub's issue tracker
+## Issue tracker
-* For obvious bugs or misbehavior in GitLab in the master branch. Please include the revision id and a reproducible test case.
-* For problematic or insufficient documentation. Please give a suggestion on how to improve it.
+The [issue tracker](https://github.com/gitlabhq/gitlabhq/issues) is only for obvious bugs or misbehavior in the master branch of GitLab. When submitting an issue please conform to the issue submission guidelines listed below.
-If you're unsure where to post, post it to the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) first.
-There are a lot of helpful GitLab users there who may be able to help you quickly.
-If your particular issue turns out to be a bug, it will find its way from there to the [issue tracker on GitHub](https://github.com/gitlabhq/gitlabhq/issues).
+Please send a pull request with a tested solution or a pull request with a failing test instead of opening an issue if you can. If you're unsure where to post, post to the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) first. There are a lot of helpful GitLab users there who may be able to help you quickly. If your particular issue turns out to be a bug, it will find its way from there.
-### When submitting an issue
+### Issue tracker guidelines
 **Search** for similar entries before submitting your own, there's a good chance somebody else had the same issue or idea. Show your support with `:+1:` and/or join the discussion.
-Please consider the following points when submitting an **issue**:
-
-* Summarize your issue in one sentence (what happened wrong, when you did/expected something else)
-* Describe your issue in detail (including steps to reproduce)
+* Summarize your issue in one sentence (what goes wrong, what did you expect to happen)
+* Describe your issue in detail
+* How can we reproduce the issue on the [GitLab Vagrant virtual machine](https://github.com/gitlabhq/gitlab-vagrant-vm) (start with: vagrant destroy && vagrant up && vagrant ssh)
+* Add the last commit sha1 of the GitLab version you used to replicate the issue
 * Add logs or screen shots when possible
+* Link to the line of code that might be responsible for the problem
 * Describe your setup (use relevant parts from `sudo -u gitlab -H bundle exec rake gitlab:env:info`)
-
-## Thank you!
-
-By taking the time to use the right channel, you help the development team to organize and prioritize issues and suggestions in order to make GitLab a better product for us all.
@@ -12,7 +12,7 @@
 * powered by Ruby on Rails
 * completely free and open source (MIT license)
-* used by 10.000 organizations to keep their code secure
+* used by more than 10.000 organizations to keep their code secure
 ### Code status
@@ -30,7 +30,7 @@
 * GitLab.org community site: [Homepage](http://gitlab.org) [Screenshots](http://gitlab.org/screenshots/) [Blog](http://blog.gitlab.org/) [Demo](http://demo.gitlabhq.com/users/sign_in)
-* GitLab.com commercial services: [Homepage](http://www.gitlab.com/) [GitLab Cloud](http://www.gitlab.com/cloud/) [Subscription](http://www.gitlab.com/subscription/) [Consultancy](http://www.gitlab.com/consultancy/) [Blog](http://blog.gitlab.com/)
+* GitLab.com commercial services: [Homepage](http://www.gitlab.com/) [Subscription](http://www.gitlab.com/subscription/) [Consultancy](http://www.gitlab.com/consultancy/) [GitLab Cloud](http://www.gitlab.com/cloud/) [Blog](http://blog.gitlab.com/)
 * GitLab CI: [Readme](https://github.com/gitlabhq/gitlab-ci/blob/master/README.md) of the GitLab open-source continuous integration server
@@ -47,7 +47,7 @@
 ### Installation
-#### For production
+#### Official production installation
 Follow the installation guide for production server.
@@ -55,21 +55,37 @@ Follow the installation guide for production server.
 * [Installation guide for the current master branch (5.1)](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md)
-#### For development
-If you want to contribute, please first read our [Contributing Guidelines](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md) and then we suggest you to use the Vagrant virtual machine project to get an environment working sandboxed and with all dependencies.
+#### Official development installation
+
+If you want to contribute, please first read our [Contributing Guidelines](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md) and then we suggest you to use the Vagrant virtual machine project to get an environment working with all dependencies.
 * [Vagrant virtual machine](https://github.com/gitlabhq/gitlab-vagrant-vm)
-#### Unsupported installation methods
+
+#### Unsupported production installation
 * [GitLab recipes](https://github.com/gitlabhq/gitlab-recipes) for setup on different platforms
 * [Unofficial installation guides](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Unofficial-Installation-Guides)
+* [BitNami one-click installers](http://bitnami.com/stack/gitlab)
+* [TurnKey Linux virtual appliance](http://www.turnkeylinux.org/gitlab)
-### Starting
+
+### New versions and upgrading
+
+Each month on the 22th a new version is released together with an upgrade guide.
+
+* [Upgrade guides](https://github.com/gitlabhq/gitlabhq/wiki)
+
+* [Changelog](https://github.com/gitlabhq/gitlabhq/blob/master/CHANGELOG)
+
+* [Roadmap](https://github.com/gitlabhq/gitlabhq/blob/master/ROADMAP.md)
+
+
+### Getting started
 1. The Installation guide contains instructions to download an init script and run that on boot. With the init script you can also start GitLab
@@ -107,42 +123,35 @@ If you want to contribute, please first read our [Contributing Guidelines](https
         bundle exec rake spinach
-### Getting help
-
-* [Troubleshooting guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide)
-* [Support forum](https://groups.google.com/forum/#!forum/gitlabhq)
+### GitLab interfaces
-* [Feedback and suggestions forum](http://gitlab.uservoice.com/forums/176466-general)
+* [GitLab API](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/README.md)
-* [Support subscription](http://www.gitlab.com/subscription/)
+* [Rake tasks](https://github.com/gitlabhq/gitlabhq/tree/master/doc/raketasks)
-* [Consultancy](http://www.gitlab.com/consultancy/)
+* [Directory structure](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/structure.md)
-### New versions and upgrading
+* [Databases](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/databases.md)
-Each month on the 22th a new version is released together with an upgrade guide.
-* [Upgrade guides](https://github.com/gitlabhq/gitlabhq/wiki)
+### Getting help
-* [Changelog](https://github.com/gitlabhq/gitlabhq/blob/master/CHANGELOG)
+* [Troubleshooting guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide) contains solutions to common problems.
-* [Roadmap](https://github.com/gitlabhq/gitlabhq/blob/master/ROADMAP.md)
+* [Support forum](https://groups.google.com/forum/#!forum/gitlabhq) is the best place to ask questions. For example you can use it if you have questions about: permission denied errors, invisible repos, can't clone/pull/push or with web hooks that don't fire. Please search for similar issues before posting your own, there's a good chance somebody else had the same issue you have now and had it resolved. There are a lot of helpful GitLab users there who may be able to help you quickly. If your particular issue turns out to be a bug, it will find its way from there to a fix.
-### GitLab interfaces
+* [Feedback and suggestions forum](http://gitlab.uservoice.com/forums/176466-general) is the place to propose and discuss new features for GitLab.
-* [GitLab API](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/README.md)
+* [Support subscription](http://www.gitlab.com/subscription/) connect you to the knowledge of GitLab experts that will resolve your issues and answer your questions.
-* [Rake tasks](https://github.com/gitlabhq/gitlabhq/tree/master/doc/raketasks)
+* [Consultancy](http://www.gitlab.com/consultancy/) allows you hire GitLab exports for installations, upgrades and customizations.
-* [Directory structure](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/structure.md)
+* [Contributing guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md) describes how to submit pull requests and issues. Pull requests and issues not in line with the guidelines in this document will be closed without comment.
-* [Databases](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/databases.md)
 ### Getting in touch
-* [Contributing guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md)
-
 * [Core team](https://github.com/gitlabhq?tab=members)
 * [Contributors](https://github.com/gitlabhq/gitlabhq/graphs/contributors)
 This installation guide was created for Debian/Ubuntu and tested on it. Please read [`doc/install/requirements.md`](./requirements.md) for hardware and platform requirements.
-This installation guide is recommended to set up a production server. If you want a development environment please use the [Vagrant virtual machine](https://github.com/gitlabhq/gitlab-vagrant-vm) since it makes it much easier to set up all the dependencies for integration testing.
-
 **Important Note:**
-The following steps have been known to work.
-If you deviate from this guide, do it with caution and make sure you don't
-violate any assumptions GitLab makes about its environment.
-For things like AWS installation scripts, init scripts or config files for
-alternative web server have a look at the [`Advanced Setup
-Tips`](./installation.md#advanced-setup-tips) section.
+This is the official installation guide to set up a production server. To set up a development installation or for many other installation options please consult [the installation section in the readme](https://github.com/gitlabhq/gitlabhq#installation).
+**Important Note:**
+The following steps have been known to work. If you deviate from this guide, do it with caution and make sure you don't violate any assumptions GitLab makes about its environment.
 **Important Note:**
-If you find a bug/error in this guide please submit an issue or pull request
-following the [`contribution guide`](../../CONTRIBUTING.md).
+If you find a bug/error in this guide please submit a pull request following the [`contributing guide`](../../CONTRIBUTING.md).
 - - -
@@ -299,8 +293,3 @@ If you are running SSH on a non-standard port, you must change the gitlab user&#39;s
         hostname 127.0.0.1; # Your server name or IP
 You also need to change the corresponding options (e.g. ssh_user, ssh_host, admin_uri) in the `config\gitlab.yml` file.
-
-## User-contributed Configurations
-
-You can find things like  AWS installation scripts, init scripts or config files
-for alternative web server in our [recipes collection](https://github.com/gitlabhq/gitlab-recipes/).