diff options
Diffstat (limited to 'doc/development')
| -rw-r--r-- | doc/development/architecture.md | 4 | ||||
| -rw-r--r-- | doc/development/contributing/issue_workflow.md | 7 | ||||
| -rw-r--r-- | doc/development/documentation/feature-change-workflow.md | 4 | ||||
| -rw-r--r-- | doc/development/documentation/styleguide.md | 14 |
4 files changed, 6 insertions, 23 deletions
diff --git a/doc/development/architecture.md b/doc/development/architecture.md index 7b2c26ef478..75debff778d 100644 --- a/doc/development/architecture.md +++ b/doc/development/architecture.md @@ -1,7 +1,3 @@ ---- -table_display_block: true ---- - # GitLab Architecture Overview ## Software delivery diff --git a/doc/development/contributing/issue_workflow.md b/doc/development/contributing/issue_workflow.md index 810d03e82c5..2e455ef1819 100644 --- a/doc/development/contributing/issue_workflow.md +++ b/doc/development/contributing/issue_workflow.md @@ -45,8 +45,8 @@ Most issues will have labels for at least one of the following: - Category: ~"Category:Code Analytics", ~"Category:DevOps Score", ~"Category:Templates", etc. - Feature: ~wiki, ~ldap, ~api, ~issues, ~"merge requests", etc. - Department: ~UX, ~Quality -- Team: ~Documentation, ~Delivery -- Specialization: ~frontend, ~backend +- Team: ~"Technical Writing", ~Delivery +- Specialization: ~frontend, ~backend, ~documentation - Release Scoping: ~Deliverable, ~Stretch, ~"Next Patch Release" - Priority: ~P1, ~P2, ~P3, ~P4 - Severity: ~S1, ~S2, ~S3, ~S4 @@ -228,7 +228,7 @@ people. The current team labels are: - ~Delivery -- ~Documentation +- ~"Technical Writing" #### Naming and color convention @@ -241,6 +241,7 @@ These labels narrow the [specialization](https://about.gitlab.com/company/team/s - ~frontend - ~backend +- ~documentation ### Release scoping labels diff --git a/doc/development/documentation/feature-change-workflow.md b/doc/development/documentation/feature-change-workflow.md index 4512b0fc987..2b8a9ea6e1c 100644 --- a/doc/development/documentation/feature-change-workflow.md +++ b/doc/development/documentation/feature-change-workflow.md @@ -77,7 +77,7 @@ and default merge request template will assist you with following this process. For issues requiring any new or updated documentation, the Product Manager (PM) must: -- Add the `Documentation` label. +- Add the ~documentation label. - Confirm or add the [documentation requirements](#documentation-requirements-in-feature-issues). - Ensure the issue contains any new or updated feature name, overview/description, and use cases, as required per the [documentation structure and template](structure.md), when applicable. @@ -92,7 +92,7 @@ do the following: #### Authoring -As a developer, if a ~feature issue also contains the ~Documentation label, you must ship the new or updated documentation with the code of the feature. The documentation is an essential part of the product. +As a developer, if a ~feature issue also contains the ~documentation label, you must ship the new or updated documentation with the code of the feature. The documentation is an essential part of the product. Technical writers are happy to help, as requested and planned on an issue-by-issue basis. For feature issues requiring documentation, follow the process below unless otherwise agreed with the product manager and technical writer for a given issue: diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 32ac399925e..286fedd5f61 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -239,20 +239,6 @@ Do not include the same information in multiple places. [Link to a SSOT instead. - List item 2 ``` -### Tables overlapping the TOC - -By default, all tables have a width of 100% on docs.gitlab.com. -In a few cases, the table will overlap the table of contents (ToC). -For these cases, add an entry to the document's frontmatter to -render them displaying block. This will make sure the table -is displayed behind the ToC, scrolling horizontally: - -```md ---- -table_display_block: true ---- -``` - ### Emphasis - Use double asterisks (`**`) to mark a word or text in bold (`**bold**`). |