Skip to content

Commit

Permalink
Many words corrected to lower case
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
bluedeepimpact committed Feb 25, 2021
1 parent 9c06fd9 commit af89682
Show file tree
Hide file tree
Showing 15 changed files with 57 additions and 48 deletions.
2 changes: 1 addition & 1 deletion docs/development/accessibility-checklist/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Accessibility Checklist
# Accessibility checklist

Web sites should be:

Expand Down
2 changes: 1 addition & 1 deletion docs/development/concepts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ robots: index, follow
keywords: development concepts, big picture
---

# OpenProject Development Concepts
# OpenProject development concepts

OpenProject development encompasses a large number of complex topics and terminologies.
This guide will introduce some concepts and give you a big picture of the development processes.
Expand Down
6 changes: 3 additions & 3 deletions docs/development/product-development-handbook/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
sidebar_navigation:
title: Product Development
title: Product development
priority: 100
description: Learn about OpenProject's product development process and the RICE score
robots: index, follow
keywords: product development, requirement process, RICE score
---

<h1>OpenProject Product Development Handbook</h1>
# OpenProject product development handbook



## 1. Overview & Objectives
## 1. Overview & objectives

OpenProject aims to connect distributed teams and organizations and make project management intuitive and fun. The open source software supports classical project management and team collaboration as well as agile project management methodologies. OpenProject is continuously developed and maintained by an active international community to provide a powerful feature set and yet intuitive user interface. The overall purpose is to create customer benefit. To achieve this, OpenProject follows a requirements and product development process that empathizes identifying and building the functionality which most aligns with OpenProject’s product vision and delivers customer value.

Expand Down
8 changes: 4 additions & 4 deletions docs/development/security/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Statement on Security
## Statement on security

At its core, OpenProject is an open-source software that is [developed and published on GitHub](https://github.com/opf/openproject). Every change to the OpenProject code base ends up in an open repository accessible to everyone. This results in a transparent software where every commit can be traced back to the contributor.

Expand Down Expand Up @@ -28,13 +28,13 @@ Please include a description on how to reproduce the issue if possible. Our secu



## OpenProject Security features
## OpenProject security features

### Authentication.
### Authentication

OpenProject administrators can enforce [authentication mechanisms and password rules]() to ensure users choose secure passwords according to current industry standards. Passwords stored by OpenProject are securely stored using salted bcrypt. Alternatively, external authentication providers and protocols (such as LDAP, SAML) can be enforced to avoid using and exposing passwords within OpenProject.

### User management and access control.
### User management and access control

Administrators are provided with [fine-grained role-based access control mechanisms]() to ensure that users are only seeing and accessing the data they are allowed to on an individual project level.

Expand Down
8 changes: 8 additions & 0 deletions docs/enterprise-edition-guide/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
sidebar_navigation:
title: Enterprise on-premises edition guide
priority: 999
description: OpenProject Enterprise on-premises guide.
robots: index, follow
keywords: enterprise edition, enterprise on-premises, self-hosted version, server
---
# Enterprise on-premises edition guide

Welcome to the OpenProject **Enterprise on-premises edition guide**.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_navigation:
title: Activate the Enterprise Edition
title: Activate Enterprise on-premises
priority: 990
description: Activate the OpenProject Enterprise Edition.
description: Activate the OpenProject Enterprise on-premises edition.
robots: index, follow
keywords: Activate Enterprise Edition
keywords: Activate Enterprise Edition, token, license key
---
# Activate the Enterprise on-premises edition

Expand Down
4 changes: 2 additions & 2 deletions docs/enterprise-edition-guide/enterprise-trial/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_navigation:
title: Enterprise Edition trial
title: Enterprise on-premises trial
priority: 999
description: Create an OpenProject Enterprise Edition trial installation.
robots: index, follow
keywords: Enterprise Edition trial
keywords: Enterprise Edition trial, EOP
---
# Create an Enterprise on-premises edition trial

Expand Down
4 changes: 2 additions & 2 deletions docs/enterprise-edition-guide/support/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
sidebar_navigation:
title: Support
priority: 981
description: OpenProject Enterprise Edition support.
description: OpenProject Enterprise on-premises support.
robots: index, follow
keywords: enterprise edition support
keywords: enterprise edition support, ticket
---
# Enterprise on-premises edition support

Expand Down
11 changes: 6 additions & 5 deletions docs/getting-started/boards-introduction/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
---
sidebar_navigation:
title: Agile Boards introduction
title: Agile boards introduction
priority: 500
description: Introduction to agile Boards in OpenProject.
robots: index, follow
keywords: Agile Boards
---

# Introduction to agile Boards (premium feature)
# Introduction to agile boards (premium feature)

In this document you will get a first introduction to the Boards in OpenProject, i.e. how to use a Kanban board to manage your tasks in an agile way.
In this document you will get a first introduction to the boards in OpenProject, i.e. how to use a Kanban board to manage your tasks in an agile way.

<div class="alert alert-info" role="alert">
**Note**: The agile Board is a premium feature and only available for [OpenProject Cloud Edition](https://www.openproject.org/hosting/) and [Enterprise Edition](https://www.openproject.org/enterprise-edition/) customers.
**Note**: The agile board is a premium feature and only available for [OpenProject Cloud Edition](https://www.openproject.org/hosting/) and [Enterprise Edition](https://www.openproject.org/enterprise-edition/) customers.
</div>


<div class="glossary">
**Boards** in OpenProject enable agile project management, i.e. Kanban. Boards consist of lists (columns) with cards (work packages) on it. They help to visualize work, limit work-in-progress, and maximize efficiency (or flow).
</div>
Expand All @@ -24,7 +25,7 @@ To find out more about the detailed functionalities of Boards, please visit our
Agile boards is only one of OpenProject's features. Find a comprehensive comparison between OpenProject and Trello [here](https://www.openproject.org/alternatives/best-trello-alternative/).


| Feature | Documentation for |
| Topic | Content |
| ----------------------------------------------------------- | ------------------------------------------ |
| [What is a Board?](#what-is-a-board?) | Find out what a Board in OpenProject is. |
| [Manage your work in a Board](#manage-your-work-in-a-board) | How to manage your work in an agile Board? |
Expand Down
22 changes: 11 additions & 11 deletions docs/getting-started/my-account/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
---
sidebar_navigation:
title: My Account
title: My account
priority: 400
description: Learn how to configure account settings.
robots: index, follow
keywords: my account, account settings, change language, Deutsch
---

# My Account
# My account

Change your personal settings in My Account. Here you can adapt, e.g. the language, edit notifications, or add an avatar.
Change your personal settings in My account. Here you can adapt, e.g. the language, edit notifications, or add an avatar.

| Topic | Content |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| [Open My Account settings](#open-my-account-settings) | How to open your personal settings in OpenProject? |
| [Open My account settings](#open-my-account-settings) | How to open your personal settings in OpenProject? |
| [Change password](#change-password) | How to change my password? |
| [Edit your user information](#edit-your-user-information) | How to change the name or email address in OpenProject? |
| [Profile settings: change your language, time zone or display of comments](#profile-settings) | How to change the language, time zone or display of comments in OpenProject? |
| [Two-factor authentication](#two-factor-authentication-premium-feature) | How to set up a two-factor authentication? |
| [Email notifications](#email-notifications) | How to change email notifications sent by OpenProject? |
| [Set an Avatar](#set-an-avatar) | How to set an Avatar in OpenProject and change the profile picture? |
| [Set anaAvatar](#set-an-avatar) | How to set an avatar in OpenProject and change the profile picture? |
| [Delete account](#delete-account) | How to delete my own account? |

## Open My Account settings
## Open My account settings

To open your personal settings in OpenProject, click on your user icon in the top right corner in the header of the application.

Expand All @@ -32,7 +32,7 @@ Choose **My account**.

## Change password

In order to reset your password, navigate to the My Account section and choose **Change password** in the menu.
In order to reset your password, navigate to the My account section and choose **Change password** in the menu.

Enter your current password.

Expand Down Expand Up @@ -78,7 +78,7 @@ If you want to help us to add further languages or to add the translations in yo

### Change your time zone

You can choose a Time zone in which you work and how the comments and changes will be saved.
You can choose a time zone in which you work and how the comments and changes will be saved.

![time zone](1572882881007.png)

Expand Down Expand Up @@ -159,11 +159,11 @@ By default you do not receive any email notifications about your own changes. If



## Set an Avatar
## Set an avatar

To change your profile picture in OpenProject you can set an Avatar in your My account settings. Navigate to **Avatar** in the menu.
To change your profile picture in OpenProject you can set an avatar in your My account settings. Navigate to **Avatar** in the menu.

OpenProject uses Gravatar as default profile image. It displays a preview of your Avatar.
OpenProject uses Gravatar as default profile image. It displays a preview of your avatar.

Also, you can upload a **Custom Avatar** by choosing a Avatar to be uploaded from a file. Press the blue **Update** button to change your profile picture.

Expand Down
24 changes: 12 additions & 12 deletions docs/system-admin-guide/github-integration/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
sidebar_navigation:
title: Github Integration
title: Github integration
priority: 600
description: Integrate the Github pull request workflow into OpenProject.
robots: index, follow
keywords: github integration
---
# Github Integration
# GitHub integration

OpenProject offers are very basic Github integration for pull requests.
You create a pull request in Github and link to an OpenProject work package.
OpenProject offers are very basic GitHub integration for pull requests.
You create a pull request in GitHub and link to an OpenProject work package.

![New pull request linking to an OpenProject work package](github-pr-workpackage-reference.png)

Expand All @@ -25,14 +25,14 @@ the pull request is
![Github comments on work package](workpackage-github-comments.png)

Mind that editing an existing pull request's description to add a work package link will
not add a comment in OpenProject. Github does not send webhook events for that.
not add a comment in OpenProject. GitHub does not send webhook events for that.

If you still want a comment in OpenProject you will have to reference the
work package in a comment on the pull request in Github.
work package in a comment on the pull request in GitHub.

## Configuration

You will have to configure both OpenProject and Github for the integration to work.
You will have to configure both OpenProject and GitHub for the integration to work.

### OpenProject

Expand All @@ -47,24 +47,24 @@ The role needs two permissions and should only receive those two: "View work pac
![Github user added as member to project with respective role](github-project-member.png)

Once the user is created you need to generate an OpenProject API token for it
to use later on the Github side of things. For this you have to:
to use later on the GitHub side of things. For this you have to:

1. Login as the newly created user
2. Go to My Account (click on Avatar in top right corner)
3. Go to Access Token
4. Click on generate in the API row

Copy the generated key. You can now configure the necessary webhook in Github.
Copy the generated key. You can now configure the necessary webhook in GitHub.

### Github
### GitHub

In Github you have to set up a webhook in each repository to be integrated with OpenProject.
In GitHub you have to set up a webhook in each repository to be integrated with OpenProject.

![Create the webhook in Github](create-github-webhook.png)

You need to configure just two things in the webhook.
The **Content Type** has to be `application/json`.
The **Payload URL** must point to your OpenProject server's github webhook endpoint (`/webhooks/github`).
The **Payload URL** must point to your OpenProject server's GitHub webhook endpoint (`/webhooks/github`).

Now you need the API key you copied earlier. Append it to the *Payload URL* as a simple GET parameter named `key`. In the end the URL should look something like this:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_navigation:
title: Roles & Permissions
title: Roles and permissions
priority: 970
description: Manage roles and permissions in OpenProject.
robots: index, follow
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/gantt-chart/scheduling/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_navigation:
title: Automatic and Manual Scheduling
title: Automatic and manual scheduling
priority: 999
description: Use manual or automatic scheduling mode in OpenProject
robots: index, follow
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_navigation:
title: Create Work packages
title: Create work packages
priority: 990
description: How to create Work packages in OpenProject?
robots: index, follow
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/work-packages/edit-work-package/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_navigation:
title: Edit Work packages
title: Edit work packages
priority: 900
description: How to edit work packages in OpenProject?
robots: index, follow
Expand Down

0 comments on commit af89682

Please sign in to comment.