summaryrefslogtreecommitdiffstats
path: root/docs/07_How_To_Contribute
diff options
context:
space:
mode:
authorJan-Simon Moeller <jsmoeller@linuxfoundation.org>2025-01-13 12:01:36 +0100
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2025-01-14 09:02:26 +0000
commit3c3ba5e5927ac5607439f18f95f09592519053a1 (patch)
treeaf4c00d740033dc8a623148a108cca43fbb75811 /docs/07_How_To_Contribute
parentd511041028a87e8569c98dfb2f4e034563973f3f (diff)
Update the documentation after branching for Milestone 3. Bug-AGL: SPEC-5333 Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Change-Id: I04aa470eb53ed937e893445b4b029e24a7b8d12b Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/30759
Diffstat (limited to 'docs/07_How_To_Contribute')
-rw-r--r--docs/07_How_To_Contribute/03_Working_with_Gerrit.md4
-rw-r--r--docs/07_How_To_Contribute/08_Adding_Documentation.md3
2 files changed, 4 insertions, 3 deletions
diff --git a/docs/07_How_To_Contribute/03_Working_with_Gerrit.md b/docs/07_How_To_Contribute/03_Working_with_Gerrit.md
index e04fe17..a42f648 100644
--- a/docs/07_How_To_Contribute/03_Working_with_Gerrit.md
+++ b/docs/07_How_To_Contribute/03_Working_with_Gerrit.md
@@ -103,7 +103,7 @@ repeat the ``git review`` command.
```sh
$ cd documentation # Working Repository
$ git remote -v update # Updating wrt remote
- $ git checkout -b mytopicbranch origin/master # Creating new branch
+ $ git checkout -b mytopicbranch origin/salmon # Creating new branch
### CODE the CHANGES
$ git add  <file> # Track the changed files
$ git commit -s # Signed Commit Message
@@ -119,7 +119,7 @@ repeat the ``git review`` command.
$ git add  <file> # Track the changed files
$ git commit -s # Signed Commit Message
$ git review # Submit Changes to review
- $ git checkout master # Return to master branch
+ $ git checkout salmon # Return to salmon branch
```
## Reviewing Using Gerrit
diff --git a/docs/07_How_To_Contribute/08_Adding_Documentation.md b/docs/07_How_To_Contribute/08_Adding_Documentation.md
index 4da6165..2b5b261 100644
--- a/docs/07_How_To_Contribute/08_Adding_Documentation.md
+++ b/docs/07_How_To_Contribute/08_Adding_Documentation.md
@@ -26,6 +26,7 @@ $ git clone "ssh://<LFID>@gerrit.automotivelinux.org:29418/AGL/documentation" &&
```sh
$ cd documentation
+ $ git checkout salmon || git checkout -b salmon origin/salmon
```
2. Install MkDocs and rtd-dropdown theme
@@ -106,7 +107,7 @@ $ blc http://localhost:8000 -ro
For testing hyperlinks of live website do:
```sh
-$ blc https://docs.automotivelinux.org/en/master/ -ro
+$ blc https://docs.automotivelinux.org/en/salmon/ -ro
```
The ```Broken Link Checker``` output will display the broken link and there location in