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
d9501e7f
Commit
d9501e7f
authored
Dec 04, 2020
by
Amy Qualls
Committed by
Suzanne Selhorn
Dec 04, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Revise configuration docs section
Revise this subheading to reduce wordiness.
parent
597d5a94
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
18 additions
and
24 deletions
+18
-24
doc/development/documentation/styleguide/index.md
doc/development/documentation/styleguide/index.md
+18
-24
No files found.
doc/development/documentation/styleguide/index.md
View file @
d9501e7f
...
...
@@ -122,7 +122,7 @@ of GitLab more efficient.
-
If the answer to a question exists in documentation, share the link to the
documentation instead of rephrasing the information.
-
When you encounter new information not available in GitLab
’s
documentation (for
-
When you encounter new information not available in GitLab documentation (for
example, when working on a support case or testing a feature), your first step
should be to create a merge request (MR) to add this information to the
documentation. You can then share the MR to communicate this information.
...
...
@@ -964,7 +964,7 @@ search engine optimization (SEO), use the imperative, where possible.
| Do | Don't |
|:--------------------------------------|:------------------------------------------------------------|
| Configure GDK | Configuring GDK |
| GitLab Release and Maintenance Policy | This section covers
GitLab's
Release and Maintenance Policy |
| GitLab Release and Maintenance Policy | This section covers
the GitLab
Release and Maintenance Policy |
| Backport to older releases | Backporting to older releases |
| GitLab Pages examples | Examples |
...
...
@@ -1925,28 +1925,24 @@ If the document resides outside of the GitLab CE/EE
### Installation guide
**Ruby:**
In
[
step 2 of the installation guide
](
../../../install/installation.md#2-ruby
)
,
we install Ruby from source. When a version update is needed,
remember to change it throughout the code block and also replace
the sha256sum. You can find the sha256sum on the
[
downloads page
](
https://www.ruby-lang.org/en/downloads/
)
of the Ruby website.
we install Ruby from source. To update the guide for a new Ruby version:
### Configuration documentation for source and Omnibus installations
GitLab officially supports two installation methods: installations
from source and Omnibus packages installations.
-
Change the version throughout the code block.
-
Replace the sha256sum. It's available on the
[
downloads page
](
https://www.ruby-lang.org/en/downloads/
)
of the Ruby website.
Whenever there's a setting that's configurable for both installation methods,
the preference is to document it in the CE documentation to avoid duplication.
### Configuration documentation for source and Omnibus installations
Configuration settings include:
GitLab supports two installation methods: installations from source, and Omnibus
packages. Possible configuration settings include:
-
Settings that touch configuration files in
`config/`
.
-
NGINX settings and settings in
`lib/support/`
in general.
-
NGINX settings.
-
Other settings in
`lib/support/`
.
When you document a list of steps, it may entail editing the configuration fil
e
and reconfiguring or restarting GitLab. In that case, use these style
s:
Configuration procedures can require users to edit configuration files, reconfigur
e
GitLab, or restart GitLab. Use these styles to document these step
s:
<!-- vale off -->
...
...
@@ -1981,13 +1977,11 @@ and reconfiguring or restarting GitLab. In that case, use these styles:
In this case:
-
Before each step list the installation method is declared in bold.
-
Three dashes (
`---`
) are used to create a horizontal line and separate the two
methods.
-
The code blocks are indented one or more spaces under the list item to render
correctly.
-
Different highlighting languages are used for each configuration in the code block.
-
The
[
GitLab Restart
](
#gitlab-restart
)
section is used to explain a required
-
Bold the installation method's name.
-
Separate the methods with three dashes (
`---`
) to create a horizontal line.
-
Indent the code blocks to line up with the list item they belong to..
-
Use the appropriate syntax highlighting for each code block.
-
Use the
[
GitLab Restart
](
#gitlab-restart
)
section to explain any required
restart or reconfigure of GitLab.
### Troubleshooting
...
...
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