TheDude
/
openproject
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add image captions

Browse Source
pull/10718/head
Niels Lindenthal 2 years ago
parent b34d940f35
commit 25a8c8d69c
1 changed files with 16 additions and 16 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 32
      docs/development/contribution-documentation/documentation-tool-setup/README.md

32
docs/development/contribution-documentation/documentation-tool-setup/README.md
Unescape View File

@ -32,13 +32,13 @@ You can install GitHub Desktop on any [supported operating systems](/desktop/get
To exchange data between your local and remote repositories you need to first sign (File -> Options -> Sign in). To exchange data between your local and remote repositories you need to first sign (File -> Options -> Sign in).
![image-20220524201335248](image-20220524201335248.png) ![sign in into github](image-20220524201335248.png)
In the next screen click on "Continue with browser". In the next screen click on "Continue with browser".
![image-20220524201506732](image-20220524201506732.png) ![continue sign in in browser](image-20220524201506732.png)
This opens your browser. To authenticate to type your GitHub.com credentials and click **Sign in**. If you have configured two-factor authentication (2FA) for GitHub enter your 2FA code in the prompt on GitHub and click **Verify**. This opens your browser. To authenticate to type your GitHub.com credentials and click **Sign in**. If you have configured two-factor authentication (2FA) for GitHub enter your 2FA code in the prompt on GitHub and click **Verify**.
@ -50,43 +50,43 @@ After authenticating your account, you are ready to manage and contribute to pro
If you are an external contributor you don't have write permissions on the repository https://github.com/opf/openproject/. In this case you need to fork the repository first. This basically means that you have your own copy of the repository on GitHub.com. Since it is your own repository you have write privileges here. If you are an external contributor you don't have write permissions on the repository https://github.com/opf/openproject/. In this case you need to fork the repository first. This basically means that you have your own copy of the repository on GitHub.com. Since it is your own repository you have write privileges here.
![image-20220524202802004](image-20220524202802004.png) ![fork openproject](image-20220524202802004.png)
## Step 6: Clone the forked OpenProject repository in GitHub Desktop ## Step 6: Clone the forked OpenProject repository in GitHub Desktop
Before you can make changes you need to create a local clone of the OpenProject repository on your local computer. Open GitHub Desktop and navigate to "File -> Clone repository". Before you can make changes you need to create a local clone of the OpenProject repository on your local computer. Open GitHub Desktop and navigate to "File -> Clone repository".
![image-20220525075957387](image-20220525075957387.png) ![clone repository](image-20220525075957387.png)
In the modal window select the repository you forked in Step 5. Also select a folder on your computer for the cloned repository. Click "Clone". In the modal window select the repository you forked in Step 5. Also select a folder on your computer for the cloned repository. Click "Clone".
![Clone a repository](image-20220525080127187-16534605509021.png) ![select repository to be cloned](image-20220525080127187-16534605509021.png)
In the next screen select "*To contribute to the parent project*". In the next screen select "*To contribute to the parent project*".
![image-20220525074657702](image-20220525074657702.png) ![define how to use the fork](image-20220525074657702.png)
## Step 7: Create a new Git branch for your change ## Step 7: Create a new Git branch for your change
Select the latest release branch e.g.`release/12.1` as the current branch. Select the latest release branch e.g.`release/12.1` as the current branch.
![image-20220524204024162](C:\Users\nlind\AppData\Roaming\Typora\typora-user-images\image-20220524204024162.png) ![create new branch - step 1](C:\Users\nlind\AppData\Roaming\Typora\typora-user-images\image-20220524204024162.png)
In the same drop down click on "New branch". In this window insert a branch name that describes your changes and select the latest release branch e.g. `release/12.1` the created branch is based on. In the same drop down click on "New branch". In this window insert a branch name that describes your changes and select the latest release branch e.g. `release/12.1` the created branch is based on.
![image-20220524204132363](C:\Users\nlind\AppData\Roaming\Typora\typora-user-images\image-20220524204132363.png) ![create new branch - step 2](C:\Users\nlind\AppData\Roaming\Typora\typora-user-images\image-20220524204132363.png)
## Step 8: Fetch origin (update local repository) ## Step 8: Fetch origin with upstream changes (update local repository)
Every time you start editing please make sure you have fetched the latest changes from GitHub.com. First you need to update your forked repository. There you select the branch you are working on, e.g. release/12.1. If there are updates in the main repository opf/openproject click on on "Fetch upstream". Every time you start editing please make sure you have fetched the latest changes from GitHub.com. First you need to update your forked repository. There you select the branch you are working on, e.g. release/12.1. If there are updates in the main repository opf/openproject click on on "Fetch upstream".
![image-20220525091734404](image-20220525091734404.png) ![fetch upstream changes](image-20220525091734404.png)
Now you have fetched the latest changes from the main repository. Now you can fetch those changes in GitHub Desktop by clicking "Fetch origin" in the main toolbar: Now you have fetched the latest changes from the main repository. Now you can fetch those changes in GitHub Desktop by clicking "Fetch origin" in the main toolbar:
![image-20220524204624785](image-20220524204624785.png) ![fetch origin in github desktop](image-20220524204624785.png)
@ -102,7 +102,7 @@ The Typora editor makes it quite easy to make changes to the file. After you mad
Open GitHub Desktop. Here you can see all the changes you made in the local repository. Open GitHub Desktop. Here you can see all the changes you made in the local repository.
![image-20220524205416700](image-20220524205416700.png) ![commit history in github desktop](image-20220524205416700.png)
Add a commit message that best describes your change. This description should allow other users to easily understand the change you made. Add a commit message that best describes your change. This description should allow other users to easily understand the change you made.
@ -110,7 +110,7 @@ Add a commit message that best describes your change. This description should al
At the moment your change is only available in your local repository. To make it available on GitHub.com you need upload (push) by pressing the button "Push origin". At the moment your change is only available in your local repository. To make it available on GitHub.com you need upload (push) by pressing the button "Push origin".
![image-20220524205510769](image-20220524205510769.png) ![push origin in github desktop](image-20220524205510769.png)
## Step 13: Create a pull request ## Step 13: Create a pull request
@ -118,7 +118,7 @@ A pull request is a workflow to ask for a review from the OpenProject team. With
Here select the latest release branch e.g. release/12.1 in the first dropdown. In the second select the branch you have changed. Here select the latest release branch e.g. release/12.1 in the first dropdown. In the second select the branch you have changed.
![image-20220524210503915](image-20220524210503915.png) ![compare changes](image-20220524210503915.png)
In the description field of the pull request enter a summary for the changes you made. If there is already a work package on community.openproject.org you can also add this to the description. This adds a relation between your pull request and the work package. In the description field of the pull request enter a summary for the changes you made. If there is already a work package on community.openproject.org you can also add this to the description. This adds a relation between your pull request and the work package.
@ -126,11 +126,11 @@ Here select the latest release branch e.g. release/12.1 in the first dropdown. I
Select the label "documentation". Select the label "documentation".
![image-20220524210811330](image-20220524210811330.png) ![add documentation label for pull request](image-20220524210811330.png)
In the field "Reviewers" select "opf/doc-writers". In the field "Reviewers" select "opf/doc-writers".
![image-20220524211008555](image-20220524211008555.png) ![select reviewer](image-20220524211008555.png)
## Step 15: Wait for feedback from the reviewers ## Step 15: Wait for feedback from the reviewers

Write Preview
Loading…
Cancel
Save