Skip to content
Snippets Groups Projects
Commit 111799ec authored by Mikhail Svechnikov's avatar Mikhail Svechnikov
Browse files

[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!1885Move #699 to webdoc
Pipeline #109451 passed
......@@ -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`.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment