Added pull request description into documentation workflow (#4)

Reviewed-on: #4 Co-authored-by: Elke Zimoch <elke.zimoch@psi.ch>
2026-07-03 11:52:34 +02:00
parent c3e1ffa3f3
commit 4a0a6fe152
11 changed files with 32 additions and 1 deletions
@@ -10,7 +10,7 @@ Everything is automated. The changes are rendered as soon as you push to the git
 repository [https://gitea.psi.ch/Controls/gitea-pages](https://gitea.psi.ch/Controls/gitea-pages).

 The webpage is generated from markdown files using Zensical together with Gitea Actions. 
-The process to setup such page is described here 
+The process to setup such page is described here <br>
 [https://linux.psi.ch/documentation/services/gitea/gitea-pages/](https://linux.psi.ch/documentation/services/gitea/gitea-pages/)

 ## How to work with your own fork
@@ -76,6 +76,37 @@ changes were mostly cosmetically (e.g. typos, better rendering, inserting subtit

 First you make sure that all changes are pushed to your forked repository.

+Now you should have a button on the webinterface that will create a *New Pull Request*. Otherwise you can 
+initiate a pull request from the original repository `Controls/gitea-pages` by changing into the
+*Pull Request* tab.
+
+![Create a pull request from your forked repository](images/giteaFork_5.png)
+
+In the following window you should add a one-line comment that summarizes you commit messages.
+Afterwards you create the pull request.
+
+![Comment on the pull request](images/giteaFork_6.png)
+
+Now you can see your pull request in the tab of the original repository `Controls/gitea-pages`. 
+
+![Pull request tab](images/giteaFork_7.png)
+
+To accept the pull request (not all people might have the rights to do so), click on the listed item
+and select <br>
+`Create squash commit`
+
+![Create squash commit](images/giteaFork_8.png)
+
+This will squash all commits you did on the fork into just one commit in the master branch. It
+is requested to do so in case all your commits were creating just one documentation page and committed
+several times to save intermedite results or correct typos and wrong formatting.
+
+After your changes were merged into the master branch you can either delete your forked repository
+and checked out directory (be very sure that you delete the inteded stuff!) or you can later
+reuse your fork for creating another documentation. In the second case use the commands <br>
+`git fetch upstream master` <br>
+`git reset --hard upstream/master` <br>
+`git push --force origin master` <br>


 ## Debugging Problems