From 3c3ba5e5927ac5607439f18f95f09592519053a1 Mon Sep 17 00:00:00 2001 From: Jan-Simon Moeller Date: Mon, 13 Jan 2025 12:01:36 +0100 Subject: Batch update for Super Salmon M3 Update the documentation after branching for Milestone 3. Bug-AGL: SPEC-5333 Signed-off-by: Jan-Simon Moeller Change-Id: I04aa470eb53ed937e893445b4b029e24a7b8d12b Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/30759 --- docs/07_How_To_Contribute/03_Working_with_Gerrit.md | 4 ++-- docs/07_How_To_Contribute/08_Adding_Documentation.md | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) (limited to 'docs/07_How_To_Contribute') 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  # Track the changed files $ git commit -s # Signed Commit Message @@ -119,7 +119,7 @@ repeat the ``git review`` command. $ git add  # 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://@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 -- cgit