diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-11-21 18:06:17 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-11-21 18:06:17 +0300 |
commit | b5ad06174bb1de39438c90847abb86ac6988e944 (patch) | |
tree | 1bb386b92f023fd2a8f776ccc10386675b3b1ef9 /doc/development | |
parent | 0a6ffb540e569bd7a7c548d59b12bc55d4bf9cf1 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development')
-rw-r--r-- | doc/development/contributing/merge_request_workflow.md | 13 | ||||
-rw-r--r-- | doc/development/fe_guide/accessibility.md | 2 | ||||
-rw-r--r-- | doc/development/fe_guide/style_guide_scss.md | 2 | ||||
-rw-r--r-- | doc/development/gotchas.md | 2 | ||||
-rw-r--r-- | doc/development/issuable-like-models.md | 10 | ||||
-rw-r--r-- | doc/development/licensing.md | 2 | ||||
-rw-r--r-- | doc/development/logging.md | 2 | ||||
-rw-r--r-- | doc/development/testing_guide/testing_migrations_guide.md | 8 |
8 files changed, 25 insertions, 16 deletions
diff --git a/doc/development/contributing/merge_request_workflow.md b/doc/development/contributing/merge_request_workflow.md index 510e90524ed..e839ae0ea3a 100644 --- a/doc/development/contributing/merge_request_workflow.md +++ b/doc/development/contributing/merge_request_workflow.md @@ -248,3 +248,16 @@ request: 1. The [GitLab Development Kit](https://gitlab.com/gitlab-org/gitlab-development-kit). 1. The [CI environment preparation](https://gitlab.com/gitlab-org/gitlab/blob/master/scripts/prepare_build.sh). 1. The [Omnibus package creator](https://gitlab.com/gitlab-org/omnibus-gitlab). + +### Incremental improvements + +We allow engineering time to fix small problems (with or without an +issue) that are incremental improvements, such as: + +1. Unprioritized bug fixes (e.g. [Banner alerting of project move is +showing up everywhere](https://gitlab.com/gitlab-org/gitlab/merge_requests/18985)) +1. Documentation improvements +1. Rubocop or Code Quality improvements + +Tag a merge request with ~"Stuff that should Just Work" to track work in +this area. diff --git a/doc/development/fe_guide/accessibility.md b/doc/development/fe_guide/accessibility.md index 64c793cfd64..4fd9a4fed60 100644 --- a/doc/development/fe_guide/accessibility.md +++ b/doc/development/fe_guide/accessibility.md @@ -16,5 +16,5 @@ useful compilation of accessibility-related material. [audit-rules]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules [axe-website]: https://www.deque.com/axe/ [axe-firefox-extension]: https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/ -[axe-chrome-extension]: https://chrome.google.com/webstore/detail/axe/lhdoppojpmngadmnindnejefpokejbdd +[axe-chrome-extension]: https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd [awesome-a11y]: https://github.com/brunopulis/awesome-a11y diff --git a/doc/development/fe_guide/style_guide_scss.md b/doc/development/fe_guide/style_guide_scss.md index 54d41b42c77..1a5b24ce6f4 100644 --- a/doc/development/fe_guide/style_guide_scss.md +++ b/doc/development/fe_guide/style_guide_scss.md @@ -28,7 +28,7 @@ New utility classes should be added to [`utilities.scss`](https://gitlab.com/git - `{variant}` is one of 'primary', 'secondary', 'success', 'warning', 'error' - `{shade}` is one of the shades listed on [colors](https://design.gitlab.com/product-foundations/colors/) -- `{size}` is a number from 1-6 from our [Type scale](https://design.gitlab.com/product-foundations/typography) +- `{size}` is a number from 1-6 from our [Type scale](https://design.gitlab.com/product-foundations/typography/) #### When should I create component classes? diff --git a/doc/development/gotchas.md b/doc/development/gotchas.md index da27ae9110b..7529278f902 100644 --- a/doc/development/gotchas.md +++ b/doc/development/gotchas.md @@ -155,7 +155,7 @@ refresh_service.execute(oldrev, newrev, ref) See ["Why is it bad style to `rescue Exception => e` in Ruby?"](https://stackoverflow.com/questions/10048173/why-is-it-bad-style-to-rescue-exception-e-in-ruby). _**Note:** This rule is [enforced automatically by -Rubocop](https://gitlab.com/gitlab-org/gitlab/blob/8-4-stable/.rubocop.yml#L911-914)._ +Rubocop](https://gitlab.com/gitlab-org/gitlab-foss/blob/8-4-stable/.rubocop.yml#L911-914)._ ## Do not use inline JavaScript in views diff --git a/doc/development/issuable-like-models.md b/doc/development/issuable-like-models.md index ce19fd77496..3892f56156e 100644 --- a/doc/development/issuable-like-models.md +++ b/doc/development/issuable-like-models.md @@ -1,7 +1,9 @@ # Issuable-like Rails models utilities -GitLab Rails codebase contains several models that hold common functionality and behave similarly to an [Issue]. Other -examples of `Issuable`s are [Merge Requests] and [Epics]. +GitLab Rails codebase contains several models that hold common functionality and behave similarly to +[Issues](https://docs.gitlab.com/ee/user/project/issues/). Other examples of "issuables" +are [Merge Requests](https://docs.gitlab.com/ee/user/project/merge_requests/) and +[Epics](https://docs.gitlab.com/ee/user/group/epics/). This guide accumulates guidelines on working with such Rails models. @@ -13,7 +15,3 @@ There are max length constraints for the most important text fields for `Issuabl - `title_html`: 800 chars - `description`: 1 megabyte - `description_html`: 5 megabytes - -[Issue]: https://docs.gitlab.com/ee/user/project/issues -[Merge Requests]: https://docs.gitlab.com/ee/user/project/merge_requests -[Epics]: https://docs.gitlab.com/ee/user/group/epics diff --git a/doc/development/licensing.md b/doc/development/licensing.md index 40ff604c7c4..052c90c2b37 100644 --- a/doc/development/licensing.md +++ b/doc/development/licensing.md @@ -65,7 +65,6 @@ Libraries with the following licenses require legal approval for use: - [GNU GPL](https://choosealicense.com/licenses/gpl-3.0/) (version 1, [version 2][GPLv2], [version 3][GPLv3], or any future versions): GPL-licensed libraries cannot be linked to from non-GPL projects. - [GNU AGPLv3](https://choosealicense.com/licenses/agpl-3.0/): AGPL-licensed libraries cannot be linked to from non-GPL projects. - [Open Software License (OSL)][OSL]: is a copyleft license. In addition, the FSF [recommend against its use][OSL-GNU]. -- [Facebook BSD + PATENTS][Facebook]: is a 3-clause BSD license with a patent grant that has been deemed [Category X][x-list] by the Apache foundation. - [WTFPL][WTFPL]: is a public domain dedication [rejected by the OSI (3.2)][WTFPL-OSI]. Also has a strong language which is not in accordance with our diversity policy. ## GPL Cooperation Commitment @@ -124,7 +123,6 @@ Dependencies which are only used in development or test environment are exempt f [Org-Repo]: https://gitlab.com/gitlab-com/organization [UNLICENSE]: https://unlicense.org [OWFa1]: http://www.openwebfoundation.org/legal/the-owf-1-0-agreements/owfa-1-0 -[Facebook]: https://code.facebook.com/pages/850928938376556 [x-list]: https://www.apache.org/legal/resolved.html#category-x [Acceptable-Licenses]: #acceptable-licenses [Unacceptable-Licenses]: #unacceptable-licenses diff --git a/doc/development/logging.md b/doc/development/logging.md index b43f1029cc6..22f3059d4b2 100644 --- a/doc/development/logging.md +++ b/doc/development/logging.md @@ -39,7 +39,7 @@ Note that currently on GitLab.com, any messages in `production.log` will NOT get indexed by Elasticsearch due to the sheer volume and noise. They do end up in Google Stackdriver, but it is still harder to search for logs there. See the [GitLab.com logging -documentation](https://gitlab.com/gitlab-com/runbooks/blob/master/howto/logging.md) +documentation](https://gitlab.com/gitlab-com/runbooks/blob/master/logging/doc/README.md) for more details. ## Use structured (JSON) logging diff --git a/doc/development/testing_guide/testing_migrations_guide.md b/doc/development/testing_guide/testing_migrations_guide.md index b28d17a4b55..3fef13afa9c 100644 --- a/doc/development/testing_guide/testing_migrations_guide.md +++ b/doc/development/testing_guide/testing_migrations_guide.md @@ -104,9 +104,9 @@ end ### Example database migration test This spec tests the -[`db/post_migrate/20170526185842_migrate_pipeline_stages.rb`](https://gitlab.com/gitlab-org/gitlab/blob/v11.6.5/db/post_migrate/20170526185842_migrate_pipeline_stages.rb) +[`db/post_migrate/20170526185842_migrate_pipeline_stages.rb`](https://gitlab.com/gitlab-org/gitlab-foss/blob/v11.6.5/db/post_migrate/20170526185842_migrate_pipeline_stages.rb) migration. You can find the complete spec in -[`spec/migrations/migrate_pipeline_stages_spec.rb`](https://gitlab.com/gitlab-org/gitlab/blob/v11.6.5/spec/migrations/migrate_pipeline_stages_spec.rb). +[`spec/migrations/migrate_pipeline_stages_spec.rb`](https://gitlab.com/gitlab-org/gitlab-foss/blob/v11.6.5/spec/migrations/migrate_pipeline_stages_spec.rb). ```ruby require 'spec_helper' @@ -171,9 +171,9 @@ end ### Example background migration test This spec tests the -[`lib/gitlab/background_migration/archive_legacy_traces.rb`](https://gitlab.com/gitlab-org/gitlab/blob/v11.6.5/lib/gitlab/background_migration/archive_legacy_traces.rb) +[`lib/gitlab/background_migration/archive_legacy_traces.rb`](https://gitlab.com/gitlab-org/gitlab-foss/blob/v11.6.5/lib/gitlab/background_migration/archive_legacy_traces.rb) background migration. You can find the complete spec on -[`spec/lib/gitlab/background_migration/archive_legacy_traces_spec.rb`](https://gitlab.com/gitlab-org/gitlab/blob/v11.6.5/spec/lib/gitlab/background_migration/archive_legacy_traces_spec.rb) +[`spec/lib/gitlab/background_migration/archive_legacy_traces_spec.rb`](https://gitlab.com/gitlab-org/gitlab-foss/blob/v11.6.5/spec/lib/gitlab/background_migration/archive_legacy_traces_spec.rb) ```ruby require 'spec_helper' |