Skip to content

Commit 4c6b3f7

Browse files
Merge remote-tracking branch 'origin/release/10.3' into dev
[ci skip]
2 parents 4ca6b59 + 917af50 commit 4c6b3f7

File tree

103 files changed

+720
-259
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

103 files changed

+720
-259
lines changed

help/README.md

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
sidebar_navigation:
3+
title: OpenProject Documentation
4+
priority: 999
5+
description: Help and documentation for OpenProject Community, Enterprise Edition and Cloud Edition.
6+
robots: index, follow
7+
keywords: help, documentation
8+
---
9+
# OpenProject Documentation
10+
11+
<div class="alert alert-info" role="alert">
12+
**Note**: To better read our OpenProject Documentation, please go to [docs.openproject.org](https://docs.openproject.org).
13+
</div>
14+
15+
ToDo: check all links.
16+
17+
## Installation
18+
19+
Get started with installing and upgrading OpenProject using [our Installation Guide starting point](https://docs.openproject.org/installation-and-operations/).
20+
21+
The guides for [manual](./installation/manual/README.md), [packaged](./installation/packaged/) and [Docker-based](./installation/docker/README.md) installations are provided.
22+
23+
## Upgrading
24+
25+
The detailed upgrade instructions for our packaged installer are located on the [official website](https://www.openproject.org/download/upgrade-guides/).
26+
27+
The guides for [manual](./operations/upgrading/manual/upgrading.md), [packaged](./operations/upgrading/packaged/upgrading.md) and [Docker-based](./operations/upgrading/docker/upgrading.md) upgrading are provided.
28+
29+
## Operation
30+
31+
* Backup guides for [manual](./operations/backup/manual/backup.md), [packaged](./operations/backup/packaged/backup.md) and [Docker-based](./operations/backup/docker/backup.md) installations
32+
* [Alter configuration of OpenProject](./configuration/configuration.md)
33+
* [Manual repository integration for Git and Subversion](./repositories/README.md)
34+
* [Configure incoming mails](./configuration/incoming-emails.md)
35+
* [Install custom plugins](./plugins/plugins.md)
36+
37+
38+
## User Guides
39+
40+
Please see our [User Guide pages](https://docs.openproject.org/user-guide/) for detailed documentation on the functionality of OpenProject.
41+
42+
43+
## Development
44+
45+
* [Quick Start for developers](./development/quick-start.md)
46+
* [Full development environment for developers on Ubuntu](./development/development-environment-ubuntu.md) and [Mac OS X](./development/development-environment-osx.md)
47+
* [Developing plugins](./development/create-openproject-plugin.md)
48+
* [Developing OmniAuth Plugins](./development/create-omniauth-plugin.md)
49+
* [Running tests](./development/running-tests.md)
50+
* [Code review guidelines](./development/code-review-guidelines.md)
51+
* [API documentation](./api/README.md)
52+
53+
54+
## APIv3 documentation sources
55+
56+
The documentation for APIv3 is written in the [API Blueprint Format](http://apiblueprint.org/) and its sources are being built from the entry point `apiv3-documentation.apib`.
57+
58+
You can use [aglio](https://github.com/danielgtaylor/aglio) to generate HTML documentation, e.g. using the following command:
59+
60+
```bash
61+
aglio -i apiv3-documentation.apib -o api.html
62+
```
63+
64+
The output of the API documentation at `dev` branch is continuously built and pushed to Github Pages at [opf.github.io/apiv3-doc/](opf.github.io/apiv3-doc/).

help/enterprise-edition-guide/README.md

+2-7
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,7 @@ The Enterprise Edition builds on top of the free Community Edition. An upgrade i
1616
| ------------------------------------------------------------ | :----------------------------------------------------------- |
1717
| [Enterprise Edition trial](#create-an-enterprise-edition-trial) | Can I test the Enterprise Edition for free? |
1818
| [Activate the Enterprise Edition](#activate-the-enterprise-edition) | How can I upgrade my Community Edition to an Enterprise Edition? |
19-
| Installation support | How can I get installation support? |
20-
| | |
21-
| | |
22-
| | |
23-
| | |
24-
| | |
25-
| | |
19+
| [Installation support](installation-support) | How can I get installation support? |
2620

21+
<iframe width="560" height="315" src="https://www.youtube.com/embed/YRF_bavXBts" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
2722

help/enterprise-edition-guide/installation-support/README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ keywords: installation support
88
---
99
# Installation support for the Enterprise Edition
1010

11+
We deliver the confidence of a tested, supported and certified enterprise-class business application.
12+
1113
If you want to work with the on premise OpenProject Enterprise Edition but do not have a Community version running, you can order **installation support** during the [booking process of your Enterprise Edition](../activate-enterprise-edition).
1214

13-
The cost for the installation support of a Community version is 150 €. In the price there is no migration included. If you need migration support, please [contact us](mailto:info@openproject.com) for a detailed quotation.
15+
The cost for the installation support of a Community version is 150 €. In the price there is no migration included. If you need migration support, please [contact us](mailto:info@openproject.com) for a detailed quotation.
16+
17+
18+
19+
## Installation checklist
20+
21+
Please have a look at our [installation checklist](https://1t1rycb9er64f1pgy2iuseow-wpengine.netdna-ssl.com/wp-content/uploads/2019/06/OpenProject_Installation_Checklist_v1.4.pdf) and send us the completed document prior to the on premise installation.

help/getting-started/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,8 @@ Watch a short 3 minute introduction video to get started with OpenProject in 5 e
3838
5. Filter, group and create reports
3939

4040
<iframe width="560" height="315" src="https://www.youtube.com/embed/Fk4papnAzMw" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
41+
## OpenProject product demo video
42+
43+
Watch a **comprehensive OpenProject product introduction** video to learn how to work with OpenProject using traditional and agile project management.
44+
45+
<iframe width="560" height="315" src="https://www.youtube.com/embed/ebc3lcSmncA" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
Loading

help/getting-started/projects/README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Get an introduction how to work with projects in OpenProject. To start collabora
1212

1313
<div class="alert alert-info" role="alert">
1414
**Note**: In order to see a project and work in it, you have to be a [member of a project](../invite-members).
15-
15+
< div />
1616

1717
| Feature | Documentation for |
1818
| ------------------------------------------------------- | ----------------------------------------------------- |
@@ -45,7 +45,7 @@ Also, you will see your newest projects on the application landing page in the *
4545

4646
To create a new project, click the **Select a project** button in the top left corner of the header and select **+ Project**.
4747

48-
![create-project](1566213921784.png)
48+
![Getting-started-create-project](Getting-started-create-project.png)
4949

5050
Also, you can click the green button **+ Project** directly on the system's home screen in the **Project** section.
5151

@@ -74,3 +74,4 @@ You will see a list with all your projects and its details.
7474
## Advanced Project Settings
7575

7676
In our detailed user guide you can find out how to configure further [advanced project settings](../../user-guide/projects/) for your projects, e.g. description, project hierarchy or setting it to public.
77+

help/release-notes/3-0-0/README.md

+9-18
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@
1919
- New work package form
2020
- Design customization via Themes
2121

22-
[Read
23-
more](https://www.openproject.org/release-notes/openproject-3-0-0/design-changes/)
22+
2423

2524

2625

@@ -32,8 +31,7 @@ more](https://www.openproject.org/release-notes/openproject-3-0-0/design-changes
3231
- Form elements linked to their labels
3332
- Screen reader support for multiple languages (English, German)
3433

35-
[Read
36-
more](https://www.openproject.org/release-notes/openproject-3-0-0/accessibility-improvements/)
34+
3735

3836

3937

@@ -42,8 +40,7 @@ more](https://www.openproject.org/release-notes/openproject-3-0-0/accessibility-
4240
-  Implementation of keyboard shortcuts for power users
4341
- Shortcuts can be accessed by pressing “?” on the keyboard
4442

45-
[Read
46-
more](https://www.openproject.org/release-notes/openproject-3-0-0/shortcuts/)
43+
4744

4845

4946

@@ -59,8 +56,7 @@ more](https://www.openproject.org/release-notes/openproject-3-0-0/shortcuts/)
5956
longer supported)
6057
- Performance improvements
6158

62-
[Read
63-
more](https://www.openproject.org/release-notes/openproject-3-0-0/adaptive-timelines/)
59+
6460

6561

6662

@@ -72,8 +68,7 @@ more](https://www.openproject.org/release-notes/openproject-3-0-0/adaptive-timel
7268
- Responible can be assigned via context menu and bulk edit
7369
- Easier navigation to work packages through shorter URL
7470

75-
[Read
76-
more](https://www.openproject.org/release-notes/openproject-3-0-0/work-package-functionality/)
71+
7772

7873

7974

@@ -83,8 +78,7 @@ more](https://www.openproject.org/release-notes/openproject-3-0-0/work-package-f
8378
navigation
8479
- Subsequently, query pages can be renamed or deleted
8580

86-
[Read
87-
more](https://www.openproject.org/release-notes/openproject-3-0-0/work-package-queries/)
81+
8882

8983

9084

@@ -94,8 +88,7 @@ more](https://www.openproject.org/release-notes/openproject-3-0-0/work-package-q
9488
templates
9589
- Select different project settings to be copied (e.g. work packages)
9690

97-
[Read
98-
more](https://www.openproject.org/release-notes/openproject-3-0-0/copy-projects/)
91+
9992

10093

10194

@@ -104,8 +97,7 @@ more](https://www.openproject.org/release-notes/openproject-3-0-0/copy-projects/
10497
- Improved member configuration
10598
- Improved and extended type configuration
10699

107-
[Read
108-
more](https://www.openproject.org/release-notes/openproject-3-0-0/improved-project-settings/)
100+
109101

110102

111103

@@ -119,8 +111,7 @@ more](https://www.openproject.org/release-notes/openproject-3-0-0/improved-proje
119111
attempts
120112
- Automated logout on inactivity
121113

122-
[Read
123-
more](https://www.openproject.org/release-notes/openproject-3-0-0/security-features/ "Security")
114+
124115

125116

126117

help/release-notes/3-0-1/README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@
1010
# OpenProject 3.0.1
1111

1212
This release mostly fixed the bugs for [3.0.0 major
13-
release](/release-notes/openproject-3-0/ "OpenProject 3.0").
14-
13+
release](/release-notes/3-0-0/).
1514

1615
Specifically the error in adding a work package process was fixed, as
1716
well as the duplication of file content display.

help/release-notes/4-0-0/README.md

+7-14
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ easy integration with OmniAuth strategy providers such as Google.
2323
- Multiple authentication provider can be integrated and are shown in
2424
the login screen
2525

26-
[Read
27-
more](https://www.openproject.org/release-notes/openproject-4-0/omniauth-integration/)
26+
2827

2928

3029

@@ -46,8 +45,7 @@ more intuitive.
4645
- Two different views: Work package table and split-screen
4746
- Create new queries based on existing ones (Save as)
4847

49-
[Read
50-
more](https://www.openproject.org/release-notes/openproject-4-0/integrated-toolbar/)
48+
5149

5250

5351

@@ -60,8 +58,7 @@ are being persisted.
6058
- Auto-completion of queries is supported
6159
- Selected query is persisted
6260

63-
[Read
64-
more](https://www.openproject.org/release-notes/openproject-4-0/integrated-query-title/)
61+
6562

6663

6764

@@ -77,8 +74,7 @@ package table right on a column header.
7774
- Hide / Remove column
7875
- Add new column
7976

80-
[Read
81-
more](https://www.openproject.org/release-notes/openproject-4-0/column-header/ "Column header functions in work package table")
77+
8278

8379

8480

@@ -99,8 +95,7 @@ allowing users to see the most important information at a glance.
9995
- “Watchers” tab to follow work package
10096
- “Attachments” tab showing attached documents
10197

102-
[Read
103-
more](https://www.openproject.org/release-notes/openproject-4-0/split-screen-mode/ "Split screen mode")
98+
10499

105100

106101

@@ -116,8 +111,7 @@ overall usability of OpenProject.
116111
- Changed headlines
117112
- Round avatars
118113

119-
[Read
120-
more](https://www.openproject.org/release-notes/openproject-4-0/improved-design/ "Improved Design")
114+
121115

122116

123117

@@ -132,8 +126,7 @@ page.
132126
- Keyboard shortcuts and access key fully functional in work package
133127
page
134128

135-
[Read
136-
more](https://www.openproject.org/release-notes/openproject-4-0/accessibility-improvements-4-0/ "Accessibility improvements")
129+
137130

138131

139132

help/release-notes/4-1-0/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ implemented to the split screen:
2525
attributes are clustered into separate groups (Details, People,
2626
Estimates & Time, Costs, Other).
2727

28-
**[Read more](http://openproject.org/?p=5016)
28+
2929

3030
## **In-place editing on work package split screen**
3131

@@ -40,7 +40,7 @@ as:
4040

4141
Several work package values can be edited at once.
4242

43-
**[Read more](http://openproject.org/?p=5025)
43+
4444

4545
## **Improved work package list and filters**
4646

@@ -53,7 +53,7 @@ configured as the other columns in the work package list:
5353
- Work package ID in work package list can be added, removed, changed
5454
in order
5555

56-
**[Read more](http://openproject.org/?p=5032)
56+
5757

5858
## **Improved work package full screen**
5959

@@ -66,7 +66,7 @@ updated:
6666
- The work package hierarchy, related work packages and watchers have
6767
been styled more prominently.
6868

69-
**[Read more](http://openproject.org/?p=5042)
69+
7070

7171
## **New design through Foundation framework**
7272

@@ -76,7 +76,7 @@ adaptability in the future and allows a more responsive design. As a
7676
result, the overall design of the application has been changed
7777
with OpenProject 4.1.
7878

79-
**[Read more](http://openproject.org/?p=5049)
79+
8080

8181
## **Many accessibility improvements**
8282

@@ -91,7 +91,7 @@ on the work package page.
9191
split screen
9292
- Contrast for watcher icon improved
9393

94-
**[Read more](http://openproject.org/?p=5062)
94+
9595

9696
## **Substantial number of bug fixes**
9797

help/release-notes/4-2-0/README.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ Users of the manual installation should remove the translations plugin
2929
from their Gemfile.plugins since Translations are now provided by the
3030
core (Gemfile).
3131

32-
[Read
33-
more](https://www.openproject.org/release-notes/openproject-4-2-0/language-support-for-openproject-plugins/)
32+
3433

3534
## **Improved navigation**
3635

@@ -53,8 +52,7 @@ administration navigation
5352
The option “Spent time” has been renamed “Time sheet”
5453
([\#20219](https://community.openproject.org/work_packages/20219)).
5554

56-
**[Read
57-
more](https://www.openproject.org/release-notes/openproject-4-2-0/improved-navigation/)
55+
5856

5957
## **Improved design**
6058

0 commit comments

Comments
 (0)