Download as
Browse Code »

Commit d8eefdccfc58fdbc4918941a21d699e644c7443a

Authored by Sytse Sijbrandij
1 parent 3392f6c1
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

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

…es that deviate from the guidelines.
Showing 3 changed files with 55 additions and 82 deletions   Show diff stats
CONTRIBUTING.md
  Diff comments   View file @d8eefdc
1 1 # Contribute to GitLab
2 2  
3   -If you have a question or want to contribute to GitLab this guide show you the appropriate channel to use.
  3 +This guide details how to use pull requests and the issues to improve GitLab.
4 4  
5   -## Ruling out common errors
  5 +## Closing deviating issues
6 6  
7   -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.
8   -
9   -## Support forum
10   -
11   -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.
12   -
13   -### Use the support forum if ...
14   -
15   -* You get permission denied errors
16   -* You can't see your repos
17   -* You have issues cloning, pulling or pushing
18   -* You have issues with web_hooks not firing
19   -
20   -**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.
21   -
22   -## Support options
23   -
24   -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/)
25   -
26   -## Feature suggestions
27   -
28   -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.
  7 +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.
29 8  
30 9 ## Pull requests
31 10  
32   -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).
  11 +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.
  12 +
  13 +## Pull request guidelines
33 14  
34   -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:
  15 + If you can please submit a pull request with the fix including tests. The workflow to make a pull request is as follows:
35 16  
36 17 1. Fork the project on GitHub
37 18 1. Create a feature branch
... ... @@ -53,26 +34,20 @@ We will accept pull requests if:
53 34  
54 35 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).
55 36  
56   -## Submitting via GitHub's issue tracker
  37 +## Issue tracker
57 38  
58   -* For obvious bugs or misbehavior in GitLab in the master branch. Please include the revision id and a reproducible test case.
59   -* For problematic or insufficient documentation. Please give a suggestion on how to improve it.
  39 +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.
60 40  
61   -If you're unsure where to post, post it to the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) first.
62   -There are a lot of helpful GitLab users there who may be able to help you quickly.
63   -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).
  41 +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.
64 42  
65   -### When submitting an issue
  43 +### Issue tracker guidelines
66 44  
67 45 **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.
68 46  
69   -Please consider the following points when submitting an **issue**:
70   -
71   -* Summarize your issue in one sentence (what happened wrong, when you did/expected something else)
72   -* Describe your issue in detail (including steps to reproduce)
  47 +* Summarize your issue in one sentence (what goes wrong, what did you expect to happen)
  48 +* Describe your issue in detail
  49 +* 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)
  50 +* Add the last commit sha1 of the GitLab version you used to replicate the issue
73 51 * Add logs or screen shots when possible
  52 +* Link to the line of code that might be responsible for the problem
74 53 * Describe your setup (use relevant parts from `sudo -u gitlab -H bundle exec rake gitlab:env:info`)
75   -
76   -## Thank you!
77   -
78   -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.
... ...
README.md
  Diff comments   View file @d8eefdc
... ... @@ -12,7 +12,7 @@
12 12  
13 13 * powered by Ruby on Rails
14 14 * completely free and open source (MIT license)
15   -* used by 10.000 organizations to keep their code secure
  15 +* used by more than 10.000 organizations to keep their code secure
16 16  
17 17 ### Code status
18 18  
... ... @@ -30,7 +30,7 @@
30 30  
31 31 * 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)
32 32  
33   -* 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/)
  33 +* 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/)
34 34  
35 35 * GitLab CI: [Readme](https://github.com/gitlabhq/gitlab-ci/blob/master/README.md) of the GitLab open-source continuous integration server
36 36  
... ... @@ -47,7 +47,7 @@
47 47  
48 48 ### Installation
49 49  
50   -#### For production
  50 +#### Official production installation
51 51  
52 52 Follow the installation guide for production server.
53 53  
... ... @@ -55,21 +55,37 @@ Follow the installation guide for production server.
55 55  
56 56 * [Installation guide for the current master branch (5.1)](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md)
57 57  
58   -#### For development
59 58  
60   -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.
  59 +#### Official development installation
  60 +
  61 +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.
61 62  
62 63 * [Vagrant virtual machine](https://github.com/gitlabhq/gitlab-vagrant-vm)
63 64  
64   -#### Unsupported installation methods
  65 +
  66 +#### Unsupported production installation
65 67  
66 68 * [GitLab recipes](https://github.com/gitlabhq/gitlab-recipes) for setup on different platforms
67 69  
68 70 * [Unofficial installation guides](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Unofficial-Installation-Guides)
69 71  
  72 +* [BitNami one-click installers](http://bitnami.com/stack/gitlab)
70 73  
  74 +* [TurnKey Linux virtual appliance](http://www.turnkeylinux.org/gitlab)
71 75  
72   -### Starting
  76 +
  77 +### New versions and upgrading
  78 +
  79 +Each month on the 22th a new version is released together with an upgrade guide.
  80 +
  81 +* [Upgrade guides](https://github.com/gitlabhq/gitlabhq/wiki)
  82 +
  83 +* [Changelog](https://github.com/gitlabhq/gitlabhq/blob/master/CHANGELOG)
  84 +
  85 +* [Roadmap](https://github.com/gitlabhq/gitlabhq/blob/master/ROADMAP.md)
  86 +
  87 +
  88 +### Getting started
73 89  
74 90 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
75 91  
... ... @@ -107,42 +123,35 @@ If you want to contribute, please first read our [Contributing Guidelines](https
107 123  
108 124 bundle exec rake spinach
109 125  
110   -### Getting help
111   -
112   -* [Troubleshooting guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide)
113 126  
114   -* [Support forum](https://groups.google.com/forum/#!forum/gitlabhq)
  127 +### GitLab interfaces
115 128  
116   -* [Feedback and suggestions forum](http://gitlab.uservoice.com/forums/176466-general)
  129 +* [GitLab API](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/README.md)
117 130  
118   -* [Support subscription](http://www.gitlab.com/subscription/)
  131 +* [Rake tasks](https://github.com/gitlabhq/gitlabhq/tree/master/doc/raketasks)
119 132  
120   -* [Consultancy](http://www.gitlab.com/consultancy/)
  133 +* [Directory structure](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/structure.md)
121 134  
122   -### New versions and upgrading
  135 +* [Databases](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/databases.md)
123 136  
124   -Each month on the 22th a new version is released together with an upgrade guide.
125 137  
126   -* [Upgrade guides](https://github.com/gitlabhq/gitlabhq/wiki)
  138 +### Getting help
127 139  
128   -* [Changelog](https://github.com/gitlabhq/gitlabhq/blob/master/CHANGELOG)
  140 +* [Troubleshooting guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide) contains solutions to common problems.
129 141  
130   -* [Roadmap](https://github.com/gitlabhq/gitlabhq/blob/master/ROADMAP.md)
  142 +* [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.
131 143  
132   -### GitLab interfaces
  144 +* [Feedback and suggestions forum](http://gitlab.uservoice.com/forums/176466-general) is the place to propose and discuss new features for GitLab.
133 145  
134   -* [GitLab API](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/README.md)
  146 +* [Support subscription](http://www.gitlab.com/subscription/) connect you to the knowledge of GitLab experts that will resolve your issues and answer your questions.
135 147  
136   -* [Rake tasks](https://github.com/gitlabhq/gitlabhq/tree/master/doc/raketasks)
  148 +* [Consultancy](http://www.gitlab.com/consultancy/) allows you hire GitLab exports for installations, upgrades and customizations.
137 149  
138   -* [Directory structure](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/structure.md)
  150 +* [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.
139 151  
140   -* [Databases](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/databases.md)
141 152  
142 153 ### Getting in touch
143 154  
144   -* [Contributing guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md)
145   -
146 155 * [Core team](https://github.com/gitlabhq?tab=members)
147 156  
148 157 * [Contributors](https://github.com/gitlabhq/gitlabhq/graphs/contributors)
... ...
doc/install/installation.md
  Diff comments   View file @d8eefdc
1 1 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.
2 2  
3   -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.
4   -
5 3 **Important Note:**
6   -The following steps have been known to work.
7   -If you deviate from this guide, do it with caution and make sure you don't
8   -violate any assumptions GitLab makes about its environment.
9   -For things like AWS installation scripts, init scripts or config files for
10   -alternative web server have a look at the [`Advanced Setup
11   -Tips`](./installation.md#advanced-setup-tips) section.
  4 +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).
12 5  
  6 +**Important Note:**
  7 +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.
13 8  
14 9 **Important Note:**
15   -If you find a bug/error in this guide please submit an issue or pull request
16   -following the [`contribution guide`](../../CONTRIBUTING.md).
  10 +If you find a bug/error in this guide please submit a pull request following the [`contributing guide`](../../CONTRIBUTING.md).
17 11  
18 12 - - -
19 13  
... ... @@ -299,8 +293,3 @@ If you are running SSH on a non-standard port, you must change the gitlab user's
299 293 hostname 127.0.0.1; # Your server name or IP
300 294  
301 295 You also need to change the corresponding options (e.g. ssh_user, ssh_host, admin_uri) in the `config\gitlab.yml` file.
302   -
303   -## User-contributed Configurations
304   -
305   -You can find things like AWS installation scripts, init scripts or config files
306   -for alternative web server in our [recipes collection](https://github.com/gitlabhq/gitlab-recipes/).
... ...