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
3c202475
Commit
3c202475
authored
Nov 27, 2020
by
Craig Norris
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update Style Guide
Update guide for revised version handling.
parent
5adab7b4
Changes
4
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
74 additions
and
93 deletions
+74
-93
doc/development/documentation/feature_flags.md
doc/development/documentation/feature_flags.md
+1
-1
doc/development/documentation/styleguide/index.md
doc/development/documentation/styleguide/index.md
+70
-89
doc/development/documentation/workflow.md
doc/development/documentation/workflow.md
+2
-2
doc/development/ee_features.md
doc/development/ee_features.md
+1
-1
No files found.
doc/development/documentation/feature_flags.md
View file @
3c202475
...
...
@@ -30,7 +30,7 @@ See how to document them below, according to the state of the flag:
-
[
Features that can be enabled or disabled for a single project
](
#features-enabled-by-project
)
.
-
[
Features with the feature flag removed
](
#features-with-flag-removed
)
.
The
[
`**(CORE ONLY)**`
](
styleguide/index.md#product-badges
)
badge or equivalent for
The
[
`**(CORE ONLY)**`
](
styleguide/index.md#product-
tier-
badges
)
badge or equivalent for
the feature's tier should be added to the line and heading that refers to
enabling/disabling feature flags as Admin access is required to do so,
therefore, it indicates that it cannot be done by regular users of GitLab.com.
...
...
doc/development/documentation/styleguide/index.md
View file @
3c202475
This diff is collapsed.
Click to expand it.
doc/development/documentation/workflow.md
View file @
3c202475
...
...
@@ -154,8 +154,8 @@ Remember:
Ensure the following if skipping an initial Technical Writer review:
-
That
[
product badges
](
styleguide/index.md#product-badges
)
are applied.
-
That the GitLab
[
version
](
styleguide/index.md#
text-for-documentation-requiring-version-text
)
that
-
That
[
product badges
](
styleguide/index.md#product-
tier-
badges
)
are applied.
-
That the GitLab
[
version
](
styleguide/index.md#
gitlab-versions
)
that
introduced the feature has been included.
-
That changes to headings don't affect in-app hyperlinks.
-
Specific
[
user permissions
](
../../user/permissions.md
)
are documented.
...
...
doc/development/ee_features.md
View file @
3c202475
...
...
@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
-
**Write the code and the tests.**
: As with any code, EE features should have
good test coverage to prevent regressions.
-
**Write documentation.**
: Add documentation to the
`doc/`
directory. Describe
the feature and include screenshots, if applicable. Indicate
[
what editions
](
documentation/styleguide/index.md#product-badges
)
the feature and include screenshots, if applicable. Indicate
[
what editions
](
documentation/styleguide/index.md#product-
tier-
badges
)
the feature applies to.
-
**Submit a MR to the `www-gitlab-com` project.**
: Add the new feature to the
[
EE features list
](
https://about.gitlab.com/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