Skip to content

Commit 1588e1c

Browse files
balasankarcrutgerw
andcommitted
Merge branch 'fix-link-missing-docs-readme' into 'master'
Fix some broken links in project README.md file See merge request https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/7270 Merged-by: Balasankar 'Balu' C <[email protected]> Approved-by: Dmytro Makovey <[email protected]> Approved-by: Achilleas Pipinellis <[email protected]> Co-authored-by: Rutger Wessels <[email protected]>
2 parents c8baf57 + d82e72f commit 1588e1c

File tree

1 file changed

+17
-22
lines changed

1 file changed

+17
-22
lines changed

README.md

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ to make contributing as easy as possible.
1414

1515
## Documentation
1616

17-
The documentation overview is in the [readme in the doc directory](doc/README.md).
17+
The documentation can be found in the [doc directory](doc/index.md).
1818

1919
## Omnibus fork
2020

2121
Omnibus GitLab is using a fork of [omnibus project](https://github.com/chef/omnibus). For additional information see the comments in the [Gemfile](/Gemfile).
2222

2323
## Deprecated links
2424

25-
*We left the links below in the readme to preserve old links, but please use the [readme in the doc directory](doc/README.md) to browse the complete documentation.*
25+
*We left the links below in the readme to preserve old links, but please use the [doc directory](doc/index.md) to browse the complete documentation.*
2626

2727
## Contributing
2828

@@ -37,7 +37,7 @@ Please follow the steps on the [downloads page][downloads].
3737
Your GitLab instance should be reachable over HTTP at the IP or hostname of your
3838
server. You can login as an admin user with username `root` and password `5iveL!fe`.
3939

40-
See [doc/maintenance/README.md](doc/maintenance/README.md) for useful commands
40+
See [doc/maintenance/index.md](doc/maintenance/index.md) for useful commands
4141
to control/debug your GitLab instance.
4242

4343
### Configuration options
@@ -129,70 +129,65 @@ See [doc/settings/configuration.md](doc/settings/configuration.md#only-start-omn
129129
### Updating
130130

131131
Instructions for updating your Omnibus installation and upgrading from a manual
132-
installation are in the [update doc](doc/update/README.md).
132+
installation are in the [update directory](doc/update/).
133133

134134
### Uninstalling Omnibus GitLab
135135

136136
See [doc/installation/index.md](doc/installation/index.md#uninstall-the-linux-package-omnibus).
137137

138138
### Common installation problems
139139

140-
This section has been moved to the separate document [doc/common_installation_problems/README.md](doc/common_installation_problems/README.md).
140+
This section has been moved to the separate document [doc/troubleshooting.md](doc/troubleshooting.md).
141141

142142
Section below remains for historical reasons(mainly to not break existing links). Each section contains the link to the new location.
143143

144144
#### Apt error 'The requested URL returned error: 403'
145145

146-
See [doc/common_installation_problems/README.md](doc/common_installation_problems/README.md#apt-error-the-requested-url-returned-error-403).
146+
See [doc/troubleshooting.md](doc/troubleshooting.md#apt-error-the-requested-url-returned-error-403).
147147

148148
#### GitLab is unreachable in my browser
149149

150-
See [doc/common_installation_problems/README.md](doc/common_installation_problems/README.md#gitlab-is-unreachable-in-my-browser).
150+
See [doc/troubleshooting.md](doc/troubleshooting.md#gitlab-is-unreachable-in-my-browser).
151151

152152
#### Emails are not being delivered
153153

154-
See [doc/common_installation_problems/README.md](doc/common_installation_problems/README.md#emails-are-not-being-delivered).
155-
156-
#### Reconfigure freezes at `ruby_block[supervise_redis_sleep] action run`
157-
158-
See [doc/common_installation_problems/README.md](doc/common_installation_problems/README.md#reconfigure-freezes-at-ruby_blocksupervise_redis_sleep-action-run).
154+
See [doc/troubleshooting.md](doc/troubleshooting.md#emails-are-not-being-delivered).
159155

160156
#### TCP ports for GitLab services are already taken
161157

162-
See [doc/common_installation_problems/README.md](doc/common_installation_problems/README.md#tcp-ports-for-gitlab-services-are-already-taken).
158+
See [doc/troubleshooting.md](doc/troubleshooting.md#tcp-ports-for-gitlab-services-are-already-taken).
163159

164160
#### Git SSH access stops working on SELinux-enabled systems
165161

166-
See [doc/common_installation_problems/README.md](doc/common_installation_problems/README.md#git-ssh-access-stops-working-on-selinux-enabled-systems
167-
).
162+
See [doc/troubleshooting.md](doc/troubleshooting.md#selinux-enabled-systems).
168163

169164
#### Postgres error 'FATAL: could not create shared memory segment: Cannot allocate memory'
170165

171-
See [doc/common_installation_problems/README.md](doc/common_installation_problems/README.md#postgres-error-fatal-could-not-create-shared-memory-segment-cannot-allocate-memory).
166+
See [doc/troubleshooting.md](doc/troubleshooting.md#postgresql-error-fatal-could-not-create-shared-memory-segment-cannot-allocate-memory).
172167

173168
#### Reconfigure complains about the GLIBC version
174169

175-
See [doc/common_installation_problems/README.md](doc/common_installation_problems/README.md#reconfigure-complains-about-the-glibc-version).
170+
See [doc/troubleshooting.md](doc/troubleshooting.md#reconfigure-complains-about-the-glibc-version).
176171

177172
#### Reconfigure fails to create the git user
178173

179-
See [doc/common_installation_problems/README.md](doc/common_installation_problems/README.md#reconfigure-fails-to-create-the-git-user).
174+
See [doc/troubleshooting.md](doc/troubleshooting.md#reconfigure-fails-to-create-the-git-user).
180175

181176
#### Failed to modify kernel parameters with sysctl
182177

183-
See [doc/common_installation_problems/README.md](doc/common_installation_problems/README.md#failed-to-modify-kernel-parameters-with-sysctl).
178+
See [doc/troubleshooting.md](doc/troubleshooting.md#failed-to-modify-kernel-parameters-with-sysctl).
184179

185180
#### I am unable to install omnibus-gitlab without root access
186181

187-
See [doc/common_installation_problems/README.md](doc/common_installation_problems/README.md#i-am-unable-to-install-omnibus-gitlab-without-root-access).
182+
See [doc/troubleshooting.md](doc/troubleshooting.md#i-am-unable-to-install-omnibus-gitlab-without-root-access).
188183

189184
#### gitlab-rake assets:precompile fails with 'Permission denied'
190185

191-
See [doc/common_installation_problems/README.md](doc/common_installation_problems/README.md#gitlab-rake-assetsprecompile-fails-with-permission-denied).
186+
See [doc/troubleshooting.md](doc/troubleshooting.md#gitlab-rake-assetsprecompile-fails-with-permission-denied).
192187

193188
#### 'Short read or OOM loading DB' error
194189

195-
See [doc/common_installation_problems/README.md](doc/common_installation_problems/README.md#short-read-or-oom-loading-db-error).
190+
See [doc/troubleshooting.md](doc/troubleshooting.md#short-read-or-oom-loading-db-error).
196191

197192
### Backups
198193

0 commit comments

Comments
 (0)