Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
62ca86b3
Commit
62ca86b3
authored
Jan 13, 2022
by
Marcia Ramos
Committed by
Suzanne Selhorn
Jan 13, 2022
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Docs: Deprecated features style guidelines
parent
d74b5255
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
41 additions
and
18 deletions
+41
-18
doc/development/documentation/styleguide/index.md
doc/development/documentation/styleguide/index.md
+41
-18
No files found.
doc/development/documentation/styleguide/index.md
View file @
62ca86b3
...
@@ -1669,24 +1669,6 @@ If a feature is moved to another tier:
...
@@ -1669,24 +1669,6 @@ If a feature is moved to another tier:
> - [Moved](<link-to-issue>) from GitLab Premium to GitLab Free in 12.0.
> - [Moved](<link-to-issue>) from GitLab Premium to GitLab Free in 12.0.
```
```
If a feature is deprecated, include a link to a replacement (when available):
```
markdown
> - [Deprecated](<link-to-issue>) in GitLab 11.3. Replaced by [meaningful text](<link-to-appropriate-documentation>).
```
You can also describe the replacement in surrounding text, if available. If the
deprecation isn't obvious in existing text, you may want to include a warning:
```
markdown
WARNING:
This feature was
[
deprecated
](
link-to-issue
)
in GitLab 12.3 and replaced by
[
Feature name
](
link-to-feature-documentation
)
.
```
In the first major GitLab version after the feature was deprecated, be sure to
remove information about that deprecated feature.
#### Inline version text
#### Inline version text
If you're adding content to an existing topic, you can add version information
If you're adding content to an existing topic, you can add version information
...
@@ -1786,6 +1768,47 @@ To view historical information about a feature, review GitLab
...
@@ -1786,6 +1768,47 @@ To view historical information about a feature, review GitLab
[
release posts
](
https://about.gitlab.com/releases/
)
, or search for the issue or
[
release posts
](
https://about.gitlab.com/releases/
)
, or search for the issue or
merge request where the work was done.
merge request where the work was done.
### Deprecated features
When a feature is deprecated, add
`(DEPRECATED)`
to the page title or to
the heading of the section documenting the feature, immediately before
the tier badge:
```
markdown
<!-- Page title example: -->
# Feature A (DEPRECATED) **(ALL TIERS)**
<!-- Doc section example: -->
## Feature B (DEPRECATED) **(PREMIUM SELF)**
```
Add the deprecation to the version history note (you can include a link
to a replacement when available):
```
markdown
> - [Deprecated](<link-to-issue>) in GitLab 11.3. Replaced by [meaningful text](<link-to-appropriate-documentation>).
```
You can also describe the replacement in surrounding text, if available. If the
deprecation isn't obvious in existing text, you may want to include a warning:
```
markdown
WARNING:
This feature was
[
deprecated
](
link-to-issue
)
in GitLab 12.3 and replaced by
[
Feature name
](
link-to-feature-documentation
)
.
```
If you add
`(DEPRECATED)`
to the page's title and the document is linked from the docs
navigation, either remove the page from the nav or update the nav item to include the
same text before the feature name:
```
yaml
-
doc_title
:
(DEPRECATED) Feature A
```
In the first major GitLab version after the feature was deprecated, be sure to
remove information about that deprecated feature.
## Products and features
## Products and features
Refer to the information in this section when describing products and features
Refer to the information in this section when describing products and features
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment