Added pull request description into documentation workflow #4
|
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 47 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 39 KiB |
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 27 KiB |
|
After Width: | Height: | Size: 30 KiB |
|
After Width: | Height: | Size: 30 KiB |
|
After Width: | Height: | Size: 23 KiB |
|
After Width: | Height: | Size: 67 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
@@ -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.
|
||||
|
||||

|
||||
|
||||
In the following window you should add a one-line comment that summarizes you commit messages.
|
||||
Afterwards you create the pull request.
|
||||
|
||||

|
||||
|
||||
Now you can see your pull request in the tab of the original repository `Controls/gitea-pages`.
|
||||
|
||||

|
||||
|
||||
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`
|
||||
|
||||

|
||||
|
||||
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
|
||||
|
||||