Commit Graph

218 Commits

Author SHA1 Message Date
Marcel Amirault 20654fb9bf Enforce consistent prefix for bullet lists
Adjusts asterisks to hyphens in assorted docs to allow lint rule to pass
2019-07-01 03:36:23 +00:00
Mark Fletcher 8f506305e2 Update issue workflow for subject labels
Mentions the automatic inference of stage and group labels based
on the applied subject labels
2019-06-28 12:29:23 +01:00
charlie ablett df59801db2 Fix broken style guide links 2019-06-28 01:15:36 +00:00
Craig Gomes adce3f299e Added Memory and Ecosystem team labels 2019-06-27 13:59:26 -07:00
Evan Read e128239340 Add Markdown linting
Also adds and one linting rule
and makes project conform to it.
2019-06-25 04:34:55 +00:00
Mek Stittri c1ea40c4b9 Improve bug severity definitions and consolidate guidance for clarity 2019-06-20 14:26:32 +00:00
Mek Stittri 54e9889e93 Change SLA to target SLO for bugs and defects 2019-06-13 08:52:43 -07:00
Marcia Ramos 78dd828f72 Merge branch 'winh-community-review-time-docs' into 'master'
Apply review turnaround time to community contributions

See merge request gitlab-org/gitlab-ce!28233
2019-05-27 15:59:17 +00:00
Brendan O'Leary 🐢 4a6e25ac45 Container Registry is now proper cased 2019-05-23 12:50:07 +00:00
Rémy Coutable 5dc8051676
Stage labels are now scoped
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-05-23 13:01:21 +02:00
Mark Fletcher 19f202ca83 Group labels are now scoped labels 2019-05-23 09:37:55 +00:00
Mark Fletcher 325f8590db Add group label docs to Issue Workflow 2019-05-22 11:55:07 +01:00
Winnie Hellmann 7796ee78fc Apply review turnaround time to community contributions 2019-05-10 12:46:43 +02:00
Marcel Amirault 0207468401 Docs: Merge EE doc/development to CE 2019-05-05 13:57:21 +00:00
Pedro Moreira da Silva 8a421fdf28 Clarify UX debt label 2019-04-24 13:37:22 +00:00
Victor Zagorodny 6f36f1e891 Clarify "Shell commands" link title in style guide doc 2019-04-11 01:52:42 +00:00
Rémy Coutable 78654a8c6a
Add missing team and stage labels in the workflow labels doc
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-04-10 17:53:15 +02:00
Evan Read ce042ef02a Update broken links to new destinations 2019-04-10 06:29:36 +00:00
Lucas Charles 7f9ef2a585 Docs: Update contribution closing policy to include community attribution 2019-03-29 13:14:53 +02:00
Gabriel Mazetto e5af7d8396 Upgrade `gitlab-markup` to 1.7.0
The new version requires `python3` to be available. In omnibus
installation this is already a reality as we are currently pathing
previous `gitlab-markup` version to use `python3` instead of `python2`.

We are now requiring `python3` with the gem without having to patch it.

As a consequence to also make it easy to use it in development, we've
introduced a `Pipfile` and `Pipfile.lock`, working similarly to
`Gemfile` and `Gemfile.lock`, and added documentation on how to use
them.
2019-03-27 16:29:22 +01:00
Marcel Amirault cf89e3b2fe Docs: Cleaning up the merge request workflow 2019-03-13 18:44:03 +00:00
Marcel Amirault 9c8dc7ddf6 Docs: Fix broken anchors in development docs 2019-03-05 13:06:32 +00:00
Takuya Noguchi e8fee6b8f7 Fix misspellings in docs
Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>
2019-02-25 10:31:35 +09:00
Evan Read eb86630959 Ensure all lists are surrounded by new lines
Markdown renderers find it easier to determine
where lists start and end when lists are surrounded
by new lines.

For consistency, also ensure entries in the list
are aligned when they span multipls lines.
2019-02-22 13:17:10 +00:00
Yorick Peterse 4d10197915
Refactor the upgrading from source docs
Instead of requiring one separate document for every version (which is
created by release managers), we now use a single document for both
Community Edition and Enterprise Edition. This allows developers to add
guidelines right away, instead of release managers having to determine
what to add.

Version specific upgrading instructions are placed in a separate
section. This prevents instructions from lingering around for many
versions should a developer forget to remove them. This also ensures
that all instructions are kept in a single place, instead of being
spread across different documents.

A minor downside is that CE and EE guidelines now live in the same
document, which could cause merge conflicts. Since we are working
towards a single codebase, this should only be an issue until we merge
the codebases together; something we expect to do in the coming months.

This commit also removes all old upgrading instructions, but these can
still be accessed using Git branch specific URLs (included in the
updating README).
2019-02-11 15:29:21 +01:00
Mike Lewis 4864767283 Merge branch 'gitlab-use-group-milestones' into 'master'
docs: GitLab uses group milestones to handle issues

See merge request gitlab-org/gitlab-ce!24953
2019-02-07 17:12:37 +00:00
Marin Jankovski 294129475c Merge branch 'docs/source-installation-requirements' into 'master'
Update source installation to make it easier for release managers to work on releases

Closes gitlab-org/release/framework#113

See merge request gitlab-org/gitlab-ce!24967
2019-02-07 12:56:01 +00:00
Philippe Lafoucrière 1effc189c3 Add Go guidelines to developer docs 2019-02-06 16:10:12 +00:00
Yorick Peterse fd838d805d
Document adding source installation steps
This adds a small line to the MR workflow to clarify that new source
installation requirements have to be added when they are introduced,
instead of release managers having to add them.
2019-02-06 15:23:16 +01:00
Hiroyuki Sato 7eed1ddf00 GitLab uses group milestones to handle issues 2019-02-06 16:51:00 +09:00
Evan Read c2c2d04b3a Fix most instances of bare URLs in markdown 2019-01-24 06:52:33 +00:00
Seth Engelhard 335b2a4e9c Update reference to ~Monitoring to be ~Monitor 2019-01-18 14:27:40 +00:00
Lin Jen-Shin e03f5f8c17 Adopt label renaming from ~"feature proposal" to
just ~feature.
2019-01-15 02:18:05 +08:00
Evan Read d98560c1f5 Make unordered lists conform to styleguide
- Also makes other minor Markdown fixes that were near the main fixes.
2019-01-08 12:21:09 +10:00
Jacob Wolen bd3c2f3aba Removed Gitlab Upgrader found in /lib/gitlab/upgrader.rb 2018-12-24 14:48:31 +00:00
Rémy Coutable 6269f35b45
Improve & clean up the PROCESS.md doc
Signed-off-by: Rémy Coutable <remy@rymai.me>
2018-12-17 12:03:48 +01:00
Evan Read 2ee8c40fc1 Merge branch '54230-eliminate-duplicated-words' into 'master'
Eliminate duplicated words (for docs)

See merge request gitlab-org/gitlab-ce!23183
2018-11-27 04:31:47 +00:00
Takuya Noguchi e238882d0c Eliminate duplicated words
Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>
2018-11-22 15:44:32 +09:00
Marcel Amirault 4cee901dab Docs: Cleaning up various links 2018-11-21 23:15:01 +00:00
Philipp Hasper 5dd2dbc971 Update issue_workflow.md: team labels
Label CI/CD has been deprecated (cf. ~CI/CD-DoNotUse ) and its description says to use ~Release or ~Verify
2018-11-06 12:15:05 +01:00
Sanad Liaquat 2d973572e9 Using inline links per review feedback 2018-11-02 18:09:35 +05:00
Sanad Liaquat fb49ee439a Changed dev stage team to quality team 2018-11-01 11:04:55 +05:00
Sanad Liaquat 53f83f2939 Update definition of done with e2e tests requirement 2018-10-29 14:55:48 +05:00
Rémy Coutable 6192c0a508
Make the 'Accepting merge requests' workflow consistent
Signed-off-by: Rémy Coutable <remy@rymai.me>
2018-10-22 17:29:25 +02:00
Ray Paik cf05c5310d Update index.md 2018-10-18 23:53:52 +00:00
Filipa Lacerda 8e7d4d9475 Merge branch 'docs-tech-debt-followup-issues' into 'master'
When to create follow-up technical debt issues

See merge request gitlab-org/gitlab-ce!22384
2018-10-18 09:26:43 +00:00
Nick Thomas 0c13bffbdc
Maintainers should be involved in follow-up issues 2018-10-17 18:06:49 +01:00
Nick Thomas 6b1820b569
Amend the tech debt in follow-ups policy 2018-10-17 17:29:29 +01:00
Nick Thomas dfe428f510
Round P/S labels up, not down 2018-10-17 15:19:41 +01:00
Nick Thomas d5ef55976a
When to create follow-up technical debt issues 2018-10-16 11:15:43 +01:00
Fabio Busatto be7c15c47e Define Stage labels in issue workflow 2018-10-15 20:01:25 +00:00
Rémy Coutable bfd6129506
Improve the contributing documentation
This removes duplicated content from CONTRIBUTING.md and consolidate
everything under doc/development/contributing/.

This also fixes missing links.

Lastly, this moves the style guides from the "Implement design & UI
elements" page to a new "Style guides" page.

Signed-off-by: Rémy Coutable <remy@rymai.me>
2018-10-11 16:33:46 +02:00
Rémy Coutable 1c51a6bed7 Merge branch 'dimitrieh-master-patch-11276' into 'master'
Add in review specifics

See merge request gitlab-org/gitlab-ce!22242
2018-10-10 13:19:43 +00:00
Dimitrie Hoekstra 2850c97997 Add in review specifics 2018-10-09 21:59:00 +00:00
Mek Stittri 6d69ff61df Clarify SLA for defects 2018-10-09 09:48:27 -07:00
Zsolt Kovari eb6e0f4b6f Use proper Configure label instead of Configuration in issue_workflow.md 2018-10-04 13:55:57 +00:00
Achilleas Pipinellis 790eabcaf4 Merge branch 'patch-28' into 'master'
Documentation: Fix broken link of feature proposal template in issue_workflow.md

See merge request gitlab-org/gitlab-ce!21894
2018-09-28 10:23:11 +00:00
Ray Paik 8ed08db8db
Document community roles 2018-09-27 11:37:53 +02:00
Evan Read 50f8ead56a Remove DocToc frontmatter from published pages
- Also fix some markdown syntax.
2018-09-27 10:22:28 +10:00
Zsolt Kovari d55f7a12e5 Fix broken link of feature proposal template in issue_workflow.md 2018-09-24 19:30:23 +00:00
Marcel Amirault 109cfd951d
Correct grammar (setup to set-up) in Docs 2018-09-21 16:29:14 +02:00
Achilleas Pipinellis b9ea4e35ac Merge branch 'jlenny-UpdateProductDiscoverySteps' into 'master'
Add steps for closing product discovery issue

See merge request gitlab-org/gitlab-ce!21273
2018-09-11 07:53:30 +00:00
Mark Pundsack 531bdd6d93 Update design.md 2018-09-10 14:55:16 +00:00
Brett Walker b0be58a1b3 Resolve "CE documentation is not CommonMark compliant" 2018-09-06 16:52:18 +00:00
Jason Lenny 1029b5b5f8 Add steps for closing product discovery issue 2018-08-17 08:35:40 +00:00
Sarrah Vesselov bca56c17f8 fix design artifact label to be product discovery. Was done here https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/20862 but not merged before this was moved. 2018-08-10 12:49:42 +00:00
Rémy Coutable b70f3909a5
Fix docs linting
Signed-off-by: Rémy Coutable <remy@rymai.me>
2018-08-09 14:33:50 +02:00
Eddie Stubbington 6dfded73c8 Phase 2: #47282 Improving Contributor On-Boarding Documentation 2018-08-09 10:09:07 +00:00