diff --git a/docs/5._Controls_Internal/Workflows/images/ActionsSetting.png b/docs/5._Controls_Internal/Workflows/images/ActionsSetting.png old mode 100755 new mode 100644 diff --git a/docs/5._Controls_Internal/Workflows/images/giteaFork_1.png b/docs/5._Controls_Internal/Workflows/images/giteaFork_1.png old mode 100755 new mode 100644 diff --git a/docs/5._Controls_Internal/Workflows/images/giteaFork_2.png b/docs/5._Controls_Internal/Workflows/images/giteaFork_2.png old mode 100755 new mode 100644 diff --git a/docs/5._Controls_Internal/Workflows/images/giteaFork_3.png b/docs/5._Controls_Internal/Workflows/images/giteaFork_3.png old mode 100755 new mode 100644 diff --git a/docs/5._Controls_Internal/Workflows/images/giteaFork_4.png b/docs/5._Controls_Internal/Workflows/images/giteaFork_4.png old mode 100755 new mode 100644 diff --git a/docs/5._Controls_Internal/Workflows/images/giteaFork_5.png b/docs/5._Controls_Internal/Workflows/images/giteaFork_5.png new file mode 100644 index 0000000..ed67531 Binary files /dev/null and b/docs/5._Controls_Internal/Workflows/images/giteaFork_5.png differ diff --git a/docs/5._Controls_Internal/Workflows/images/giteaFork_6.png b/docs/5._Controls_Internal/Workflows/images/giteaFork_6.png new file mode 100644 index 0000000..43aaeb4 Binary files /dev/null and b/docs/5._Controls_Internal/Workflows/images/giteaFork_6.png differ diff --git a/docs/5._Controls_Internal/Workflows/images/giteaFork_7.png b/docs/5._Controls_Internal/Workflows/images/giteaFork_7.png new file mode 100644 index 0000000..b1987f7 Binary files /dev/null and b/docs/5._Controls_Internal/Workflows/images/giteaFork_7.png differ diff --git a/docs/5._Controls_Internal/Workflows/images/giteaFork_8.png b/docs/5._Controls_Internal/Workflows/images/giteaFork_8.png new file mode 100644 index 0000000..5eabcac Binary files /dev/null and b/docs/5._Controls_Internal/Workflows/images/giteaFork_8.png differ diff --git a/docs/5._Controls_Internal/Workflows/images/giteaPush.png b/docs/5._Controls_Internal/Workflows/images/giteaPush.png old mode 100755 new mode 100644 diff --git a/docs/5._Controls_Internal/Workflows/writeDocu.md b/docs/5._Controls_Internal/Workflows/writeDocu.md index 8f83191..5ce271a 100644 --- a/docs/5._Controls_Internal/Workflows/writeDocu.md +++ b/docs/5._Controls_Internal/Workflows/writeDocu.md @@ -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
[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
+`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
+`git fetch upstream master`
+`git reset --hard upstream/master`
+`git push --force origin master`
## Debugging Problems