summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Remove contents section since it's not necessary [ci skip]object-state-models-docsVictor Wu2016-11-201-7/+0
|
* Remove hyphen [ci skip]Victor Wu2016-11-181-0/+0
|
* Remove hyphen [ci skip]Victor Wu2016-11-181-0/+0
|
* Add spaces to conform to style guide [ci skip]Victor Wu2016-11-181-0/+5
|
* Update object_state_models.md [ci skip]Victor Wu2016-11-171-0/+27
|
* Delete .gitkeep [ci skip]Victor Wu2016-11-171-0/+0
|
* Upload new file [ci skip]Victor Wu2016-11-171-0/+0
|
* Upload new file [ci skip]Victor Wu2016-11-171-0/+0
|
* Upload new file [ci skip]Victor Wu2016-11-171-0/+0
|
* Add new directory [ci skip]Victor Wu2016-11-171-0/+0
|
* Add file [ci skip]Victor Wu2016-11-171-0/+0
|
* Link to object state models [ci skip]Victor Wu2016-11-171-0/+1
|
* Merge branch 'update-supported-web-browsers' into 'master' Jacob Schatz2016-11-171-6/+3
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Update "Supported web browsers" text ## What does this MR do? Updates the `Supported web browsers` text in the installation docs. ## Are there points in the code the reviewer needs to double check? ## Why was this MR needed? Slack discussion ## Screenshots (if relevant) ## Does this MR meet the acceptance criteria? - [ ] [Changelog entry](https://docs.gitlab.com/ce/development/changelog.html) added - [ ] [Documentation created/updated](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/doc_styleguide.md) - [ ] API support added - Tests - [ ] Added for this feature/bug - [ ] All builds are passing - [ ] Conform by the [merge request performance guides](http://docs.gitlab.com/ce/development/merge_request_performance_guidelines.html) - [ ] Conform by the [style guides](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#style-guides) - [ ] Branch has no merge conflicts with `master` (if it does - rebase it please) - [ ] [Squashed related commits together](https://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits) ## What are the relevant issue numbers? See merge request !7341
| * Update requirements.md with new supported web browsers textupdate-supported-web-browsersLuke "Jared" Bennett2016-11-071-6/+3
| |
* | Merge branch 'sort-api-groups' into 'master' Sean McGivern2016-11-171-2/+7
|\ \ | | | | | | | | | | | | | | | | | | Allow sorting groups in API Relates to #20013. See merge request !7529
| * | Allow sorting groups in APIsort-api-groupsSean McGivern2016-11-171-2/+7
| | | | | | | | | | | | | | | | | | Allow `order_by` and `sort` parameters to `/api/v3/groups.json`. At present, only ordering by name and path is supported, and the default sort is name ascending (alphabetical order).
* | | Update copy.md with issue guideline updates and merge request guidelinesVictor Wu2016-11-171-26/+47
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Update examples and labels to use sentence case. Update copy.md [ci skip] Update copy.md [ci skip] Update copy.md
* | | Fix missing URL from environments docsAchilleas Pipinellis2016-11-171-1/+3
| | | | | | | | | | | | [ci skip]
* | | Merge branch 'google-singletons-are' into 'master' Jacob Schatz2016-11-171-0/+51
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Decide on and document a convention for singletons > The singleton pattern is a design pattern that restricts the instantiation of a class to one object. This is useful when exactly one object is needed to coordinate actions across the system. The simplest implementation uses an object literal to contain the logic. ```javascript gl.MyThing = { prop1: 'hello', method1: () => {} }; ``` A live example of this is [GfmAutoComplete](https://gitlab.com/gitlab-org/gitlab-ce/blob/172aab108b875e8dc9a5f1d3c2d53018eff76ea1/app/assets/javascripts/gfm_auto_complete.js.es6) Another approach makes use of ES6 `class` syntax. ```javascript let singleton; class MyThing { constructor() { if (!singleton) { singleton = this; singleton.init(); } return singleton; } init() { this.prop1 = 'hello'; } method1() {} } gl.MyThing = MyThing; ``` A live example of this is [Sidebar](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/app/assets/javascripts/sidebar.js.es6) Another functional approach to define Singleton using `Javascript Revealing Module Pattern` is like below ```javascript /** * 1. It instantiates only a single object * 2. It is safe – it keeps the reference to the singleton inside a variable, which lives inside a lexical closure, so it is not accessible by the outside world * 3. It allows privacy – you can define all private methods of your singleton inside the lexical closure of the first module pattern * 4. No this keyword trap (no wrong context referring) * 5. No use of new keyword * 6. Easy to write test code */ // const Singleton = (function () { // Instance stores a reference to the Singleton var instance; function init() { // Singleton // Private methods and variables function privateMethod(){ console.log( "I am private" ); } var privateVariable = "Im also private"; var privateRandomNumber = Math.random(); return { // Public methods and variables publicMethod: function () { console.log( "The public can see me!" ); }, publicProperty: "I am also public", getRandomNumber: function() { return privateRandomNumber; } }; }; return { // Get the Singleton instance if one exists // or create one if it doesn't getInstance: function () { if ( !instance ) { instance = init(); } return instance; } }; })(); const singletonObj = Singleton.getInstance() ``` ## Are there points in the code the reviewer needs to double check? ## What does this MR do? Creates a space for discussion and contribution for interested devs. ## Why was this MR needed? ## Screenshots (if relevant) ## Does this MR meet the acceptance criteria? - [x] [Documentation created/updated](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/doc_styleguide.md) - [x] All builds are passing (http://docs.gitlab.com/ce/development/merge_request_performance_guidelines.html) - [x] Conform by the [style guides](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#style-guides) - [x] [Squashed related commits together](https://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits) ## What are the relevant issue numbers? See merge request !6620
| * | | Fix spacing in code sample.google-singletons-areBryce Johnson2016-11-011-3/+5
| | | |
| * | | Document convention for singleton use in front-end code.Bryce Johnson2016-10-311-0/+49
| | | |
* | | | Merge branch '23740-create-a-doc-for-the-ce-ee-development-workflow' into ↵Robert Speicher2016-11-172-0/+273
|\ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 'master' Start to document how to code for CE with EE in mind Closes #23740 [ci skip] See merge request !7248
| * | | | Fix typosRémy Coutable2016-11-171-8/+7
| | | | | | | | | | | | | | | | | | | | Signed-off-by: Rémy Coutable <remy@rymai.me>
| * | | | Document the `rake ee_compat_check` task23740-create-a-doc-for-the-ce-ee-development-workflowRémy Coutable2016-11-171-59/+85
| | | | | | | | | | | | | | | | | | | | Signed-off-by: Rémy Coutable <remy@rymai.me>
| * | | | Start to document how to code for CE with EE in mindRémy Coutable2016-11-172-0/+248
| | | | | | | | | | | | | | | | | | | | Signed-off-by: Rémy Coutable <remy@rymai.me>
* | | | | Merge branch 'docs/environments' into 'master' Achilleas Pipinellis2016-11-171-0/+10
|\ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | Mention Git strategy none See merge request !7530
| * | | | | Mention Git strategy noneAchilleas Pipinellis2016-11-171-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | [ci skip]
* | | | | | Merge branch 'docs/review-apps' into 'master' Achilleas Pipinellis2016-11-175-4/+151
|\ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add documentation for Review Apps ## What does this MR do? Add docs for review apps. ## What are the relevant issue numbers? Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/23484 See merge request !6982
| * | | | | | Add 8.14 to versions with further additions to review appsAchilleas Pipinellis2016-11-171-3/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | [ci skip]
| * | | | | | Add Limitations sections to environments and review apps docsAchilleas Pipinellis2016-11-172-12/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | [ci skip]
| * | | | | | Add link to environments docsAchilleas Pipinellis2016-11-171-0/+3
| | | | | | |
| * | | | | | Fix URL to review apps docsAchilleas Pipinellis2016-11-171-1/+1
| | | | | | |
| * | | | | | Add a prerequisites section, add some linksAchilleas Pipinellis2016-11-171-5/+22
| | | | | | |
| * | | | | | Link to NGINX example project for the time beingAchilleas Pipinellis2016-11-171-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | [ci skip]
| * | | | | | Get rid most of the irrelevant sectionsAchilleas Pipinellis2016-11-172-32/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | [ci skip]
| * | | | | | Add note about current limitation in $CI_BUILD_REF_NAMEAchilleas Pipinellis2016-11-171-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | [ci skip]
| * | | | | | Add an intro and an Overview section for Review AppsAchilleas Pipinellis2016-11-171-43/+83
| | | | | | | | | | | | | | | | | | | | | | | | | | | | [ci skip]
| * | | | | | WIP review appsAchilleas Pipinellis2016-11-171-0/+82
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/23484 [ci skip]
| * | | | | | Add Review apps link to CI READMEAchilleas Pipinellis2016-11-171-3/+7
| | |_|_|/ / | |/| | | |
* | | | | | Merge branch 'mailroom_idle_timeout' into 'master' Rémy Coutable2016-11-171-0/+10
|\ \ \ \ \ \ | |_|/ / / / |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Allows configuration of idle_timeout for incoming email. https://gitlab.com/gitlab-org/omnibus-gitlab/merge_requests/1087 See merge request !7423
| * | | | | Correct the idle_timeout in the docs for installation from source.mailroom_idle_timeoutMarin Jankovski2016-11-161-3/+3
| | | | | |
| * | | | | Add idle_timeout to reply by email doc.Marin Jankovski2016-11-161-0/+10
| | | | | |
* | | | | | Merge branch 'doc/sentinel' into 'master' Achilleas Pipinellis2016-11-172-75/+9
|\ \ \ \ \ \ | |_|/ / / / |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Improvements to Redis HA docs Following https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6471 See merge request !7502
| * | | | | Remove ToC since it's now supported in the docs portal itselfAchilleas Pipinellis2016-11-172-53/+0
| | | | | | | | | | | | | | | | | | | | | | | | [ci skip]
| * | | | | Remove login as root step from Redis HA docsdoc/sentinelAchilleas Pipinellis2016-11-161-22/+9
| | | | | | | | | | | | | | | | | | | | | | | | [ci skip]
* | | | | | Merge branch 'docs/refactor-environments' into 'master' Achilleas Pipinellis2016-11-1716-56/+491
|\ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Refactor environments documentation ## What does this MR do? Refactor environments docs. ## What are the relevant issue numbers? https://gitlab.com/gitlab-org/gitlab-ce/issues/23484 See merge request !7107
| * | | | | | Add stop environment permissions and remove deleteAchilleas Pipinellis2016-11-171-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | [ci skip]
| * | | | | | Add note about auto-stopping of environmentsAchilleas Pipinellis2016-11-172-5/+19
| | | | | | |
| * | | | | | Finish "Stopping envs" and "Grouping similar envs" sectionsAchilleas Pipinellis2016-11-172-27/+56
| | | | | | | | | | | | | | | | | | | | | | | | | | | | [ci skip]
| * | | | | | Finish dynamic environments and URLs sectionsdocs/refactor-environmentsAchilleas Pipinellis2016-11-175-4/+156
| | | | | | | | | | | | | | | | | | | | | | | | | | | | [ci skip]