Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
BornAgain
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
mlz
BornAgain
Commits
111799ec
Commit
111799ec
authored
1 year ago
by
Mikhail Svechnikov
Browse files
Options
Downloads
Plain Diff
[doc_linkcheck] Move
#699
to webdoc ()
Merging branch 'doc_linkcheck' into 'main'. See merge request
!1885
parents
b2ab1288
5030c3a9
No related branches found
No related tags found
1 merge request
!1885
Move #699 to webdoc
Pipeline
#109451
passed
1 year ago
Stage: build
Changes
1
Pipelines
2
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
hugo/content/dev/webdoc.md
+37
-3
37 additions, 3 deletions
hugo/content/dev/webdoc.md
with
37 additions
and
3 deletions
hugo/content/dev/webdoc.md
+
37
−
3
View file @
111799ec
...
...
@@ -54,7 +54,7 @@ content/developers-corner/contribute-to-documentation.md
Create a feature branch to work on:
```
git checkout -b my_feature
$
git checkout -b my_feature
```
where
`my_feature`
should describe what you want to improve.
...
...
@@ -62,9 +62,29 @@ Edit any source file. Your local Hugo will then update the web site within a fra
Whenever you made a significant change, commit it to your feature branch:
```
git commit
$
git commit
```
### Check all links
Run
```
$ hugo server --disableFastRender
```
to create a website under an address like
`http://localhost:1313/git-main/`
.
If checkout from the older release branch
`rVersion`
, the address will be
`http://localhost:1313/Version/`
.
Here and below
`Version`
is the version number or "git-main".
Install
[
`linkchecker`
](
https://linux.die.net/man/1/linkchecker
)
(
Debian
package has same name). Run
```
$ linkchecker http://localhost:1313/Version/
```
The operation may take few minutes.
Ignore the warnings. Resolve the errors. Submit MR against corresponding branch.
### Submit a merge request
...
...
@@ -72,7 +92,7 @@ Confine work to one topic. For other topics, start new feature branches.
When one feature branch is ready for review, push it to our git server:
```
git push
$
git push
```
This requires developer access, which we will grant you upon informal request.
...
...
@@ -83,3 +103,17 @@ remote: {{% url-jugit %}}/bornagain/-/merge_requests/new?merge_request%5Bsourc
remote:
```
Login to Jugit. Visit the indicated URL to open a Merge Request.
### Update visible pages
After the MR is merged, login to the web server and go to the hugo directory:
```
$ cd ba/Version/repo/hugo
```
Make sure you are on the right branch. Do
```
$ git pull --all
```
Run hugo. Check that the changes are online at
`bornagainproject.org/Version`
.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment