From ecff326fbda93398ff7a737ccabf95c9c9f8fdec Mon Sep 17 00:00:00 2001 From: Niels Lindenthal Date: Tue, 24 May 2022 20:07:17 +0200 Subject: [PATCH] First draft --- .../documentation-tool-setup/README.md | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 docs/development/contribution-documentation/documentation-tool-setup/README.md diff --git a/docs/development/contribution-documentation/documentation-tool-setup/README.md b/docs/development/contribution-documentation/documentation-tool-setup/README.md new file mode 100644 index 0000000000..d496ec3c1a --- /dev/null +++ b/docs/development/contribution-documentation/documentation-tool-setup/README.md @@ -0,0 +1,34 @@ +--- +sidebar_navigation: + title: Tool setup for non-techies + priority: 999 +description: Setup the tools to easily contribute to the OpenProject documentation +robots: index, follow +keywords: contribution, documentation, documentation process +--- + +# Setup the tools to easily contribute to the OpenProject documentation + +This how-to guide aims to help users that are new to Git and Markdown to contribute to the OpenProject documentation. There are a two of very helpful tools that makes it extremely easy to contribute to OpenProject: + +| Tool | Purpose of this tool | Website and download | +| --------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | +| Git | Git is a software for tracking changes in any set of files, usually used for coordinating work among programmers collaboratively developing source code during software development. | [https://git-scm.com/downloads](https://git-scm.com/downloads) | +| Typora | Typora is an application that enables you to easily edit markdown files. The markdown file format is used used for the OpenProject documentation which allows you to focus on the content instead of the formatting. Typora is referred to as "What-You-See-Is-What-You-Mean". | https://desktop.github.com/ | +| GitHub desktop client | Desktop is an application that enables you to interact with GitHub using a GUI instead of the command line or a web browser. GitHub Desktop encourages you and your team to collaborate using best practices with Git and GitHu | https://typora.io/ | + +## Step 1: Install Git + +If you do not already have Git installed, you can download and install the latest version of Git from [https://git-scm.com/downloads](https://git-scm.com/downloads). + +## Step 2: Install Typora + +You can download the installer from the website https://typora.io/#download. Follow the prompts to complete the installation. In case you need more information there are very detailed [help](https://support.typora.io/) for each supported operating systems [Linux](https://support.typora.io/Typora-on-Linux/), [macOS](https://support.typora.io/Typora-on-macOS/) and [Windows](https://support.typora.io/Typora-on-Windows/). + +## Step 3: Install GitHub desktop client + +You can install the GitHub desktop client on any [supported operating systems](/desktop/getting-started-with-github-desktop/supported-operating-systems). To install GitHub Desktop client navigate to [https://desktop.github.com/](https://desktop.github.com/) and download the appropriate version for your operating system. Follow the prompts to complete the installation. + +## Step 4: Sign in into Github.com in GitHub desktop client + +You need an account on GitHub.com to contribute to the OpenProject documentation. To exchange data between your local and remote repositories you need to first sign. After authenticating your account, you are ready to manage and contribute to projects with the GitHub desktop client.