TheDude
/
openproject
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
63357 Commits
139 Branches
203 Tags
1.2 GiB
Tag: Branch: Tree: f1e825991f
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f1e825991f'
${ noResults }
openproject/docs/README.md

58 lines
2.5 KiB
Raw Normal View History Unescape

Move help into docs
5 years ago
---
sidebar_navigation:
title: OpenProject Documentation
priority: 999
Documentation for 11.1.0 rebased (#8897) * for WP 35436 * changes for WPs 34943 and 35334 * docs changes for WP 34943 and 35334 * docs changes (unrelated to 11.1 features) * Make documentation for feature requests and bug reports easier findable (unrelated to 11.1 features) * docs: explanation of work packages (not related to features from 11.1) * small docs changes for projects handling (unrelated to 11.1 features) * resolving comments * resolvng comments by RW * resolving comment by RW * docs changes for WP 34849 * docs changes for WP 35642 Co-authored-by: ML-OpenP <m.laux@openproject.com> Co-authored-by: ML-OpenP <70652047+ML-OpenP@users.noreply.github.com>
4 years ago
description: Help and documentation for OpenProject Community Edition, Enterprise on-premises and Enterprise cloud.
Move help into docs
5 years ago
robots: index, follow
keywords: help, documentation
---
# OpenProject Documentation
add a README-file for the doc subdirectory
10 years ago
Move help into docs
5 years ago
<div class="alert alert-info" role="alert">
fix(docs): stop using https://docs.openproject.org; fix redirected links (#9400)
3 years ago
**Note**: To better read our OpenProject Documentation, please go to [www.openproject.org/docs/](https://www.openproject.org/docs/).
Move help into docs
5 years ago
</div>
Merge documentation folders [ci skip]
8 years ago
## Installation
Make doc/README.md an entry point for developers [ci skip] Signed-off-by: Alex Coles <alex@alexbcoles.com>
10 years ago
Docs/12.1 (#10167) task/40956-update-docs-for-121 * Update to docs for 12.1 Changed user guide Established subdirectory "team-planner" Started editing README for team-planner * Docs changes for 12.1 Further edits to README of team-planner subdirectory: -Intro into functionality -getting started -more features explained * Update README.md * Update readme Team planner Additional edits to team planner readme file * Update README.md * Project status README Update for 12.1 Project status update for 12.1 (WP #34708): -Added new screenshots to reflect 3 add'l status choices: Not Started, Finished, and Discontinued Directory: docs/user-guide/projects/project-status/REAMDME.md * Calendar Module v12.1 Update Updated snapshots to most current version, explained "Visibility settings", and introduced/explained multiple calendars, Favorite, Public and Private functions [#36322] Save different views in calendar module https://community.openproject.org/work_packages/36322 * Update to the Team Planner Update to the Team Planner as well as functionality of the Planning Calendar. There were several additional features that were added to the Team Planner that were not captured in the last edit, such as the "include projects" filter button. [#40956] Update Docs for 12.1 https://community.openproject.org/work_packages/40956 * Use Cases I added a new folder/repository called "Use Cases". Use cases are frequently asked for how-to scenarios and workarounds. The main README is basically a Table of Contents with links. I have also added 2 use cases, Portfolio Management and Resource Management. This is is not associated with a specific work package, but rather a value-add to customers * Update Images Updated images included in initial edits, from randomly generated, numerical file names created by pasting, to more descriptive image names and description. This was done for updates triggered by v12.1: - User guide -> Modules (update) - Team planner (new) - Calendar (update) - Use cases (new) * Style guide related changes Style Guide related changes/adjustments to: - Docs/User Guide/Team Planner - Docs/User Guide/Calendar - Docs/Use Cases/* Detail: Corrected inverted quotation marks use for buttons, and replaced by bold font instead * fix(docs-12.1): typofix in name & url for new section * fix(docs12.1): resolve review issues * fix(docs12.1): use relative links for internal doc links Co-authored-by: as-op <a.sandorf@openproject.com>
3 years ago
Get started with installing and upgrading OpenProject using [our Installation Guide starting point](./installation-and-operations/).
Make doc/README.md an entry point for developers [ci skip] Signed-off-by: Alex Coles <alex@alexbcoles.com>
10 years ago
Fix some broken links in docs/ [ci skip]
3 years ago
The guides for [manual](./installation-and-operations/installation/manual), [packaged](./installation-and-operations/installation/packaged) and [Docker-based](./installation-and-operations/installation/docker) installations are provided.
Merge documentation folders [ci skip]
8 years ago
## Upgrading
feat(docs): changes & cleanup [skip ci] (#9941) * Change of the integrations and community plugin page * fix(docs): adjust links to moved pages; decrease image file sizes * fix(docs): use https:// links where possible, remove unused images, unify lowercase file extension for pngs * fix(docs): adjust links to moved pages; decrease image file sizes Co-authored-by: birthe <b.lindenthal@openproject.com>
3 years ago
The detailed upgrade instructions for our packaged installer are located on the [official website](https://www.openproject.org/download-and-installation/).
Merge documentation folders [ci skip]
8 years ago
Fix some broken links in docs/ [ci skip]
3 years ago
The guides for [upgrading](./installation-and-operations/operation/upgrading) are provided.
Found links to upgrade guides
6 years ago
Merge documentation folders [ci skip]
8 years ago
## Operation
Fix some broken links in docs/ [ci skip]
3 years ago
* [Backing up you installation](./installation-and-operations/operation/backing-up)
* [Alter configuration of OpenProject](./installation-and-operations/configuration)
* [Manual repository integration for Git and Subversion](./installation-and-operations/configuration/repositories)
* [Configure incoming mails](./installation-and-operations/configuration/incoming-emails)
* [Install custom plugins](./installation-and-operations/configuration/plugins)
Merge documentation folders [ci skip]
8 years ago
## User Guides
Docs/12.1 (#10167) task/40956-update-docs-for-121 * Update to docs for 12.1 Changed user guide Established subdirectory "team-planner" Started editing README for team-planner * Docs changes for 12.1 Further edits to README of team-planner subdirectory: -Intro into functionality -getting started -more features explained * Update README.md * Update readme Team planner Additional edits to team planner readme file * Update README.md * Project status README Update for 12.1 Project status update for 12.1 (WP #34708): -Added new screenshots to reflect 3 add'l status choices: Not Started, Finished, and Discontinued Directory: docs/user-guide/projects/project-status/REAMDME.md * Calendar Module v12.1 Update Updated snapshots to most current version, explained "Visibility settings", and introduced/explained multiple calendars, Favorite, Public and Private functions [#36322] Save different views in calendar module https://community.openproject.org/work_packages/36322 * Update to the Team Planner Update to the Team Planner as well as functionality of the Planning Calendar. There were several additional features that were added to the Team Planner that were not captured in the last edit, such as the "include projects" filter button. [#40956] Update Docs for 12.1 https://community.openproject.org/work_packages/40956 * Use Cases I added a new folder/repository called "Use Cases". Use cases are frequently asked for how-to scenarios and workarounds. The main README is basically a Table of Contents with links. I have also added 2 use cases, Portfolio Management and Resource Management. This is is not associated with a specific work package, but rather a value-add to customers * Update Images Updated images included in initial edits, from randomly generated, numerical file names created by pasting, to more descriptive image names and description. This was done for updates triggered by v12.1: - User guide -> Modules (update) - Team planner (new) - Calendar (update) - Use cases (new) * Style guide related changes Style Guide related changes/adjustments to: - Docs/User Guide/Team Planner - Docs/User Guide/Calendar - Docs/Use Cases/* Detail: Corrected inverted quotation marks use for buttons, and replaced by bold font instead * fix(docs-12.1): typofix in name & url for new section * fix(docs12.1): resolve review issues * fix(docs12.1): use relative links for internal doc links Co-authored-by: as-op <a.sandorf@openproject.com>
3 years ago
Please see our [User Guide pages](./user-guide/) for detailed documentation on the functionality of OpenProject.
## Use Cases
Please see our [Use Cases section](./use-cases/) for detailed how-to guides and step-by-step instruction on how to set up a variety of common cases and views.
Merge documentation folders [ci skip]
8 years ago
## Development
Fix some broken links in docs/ [ci skip]
3 years ago
* [Full development environment for developers on Ubuntu](./development/development-environment-ubuntu) and [Mac OS X](./development/development-environment-osx)
* [Developing plugins](./development/create-openproject-plugin)
* [Developing OmniAuth Plugins](./development/create-omniauth-plugin)
* [Running tests](./development/running-tests)
* [Code review guidelines](./development/code-review-guidelines)
* [API documentation](./api)
Make doc/README.md an entry point for developers [ci skip] Signed-off-by: Alex Coles <alex@alexbcoles.com>
10 years ago
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
## APIv3 documentation sources
Make doc/README.md an entry point for developers [ci skip] Signed-off-by: Alex Coles <alex@alexbcoles.com>
10 years ago
feat(docs): changes & cleanup [skip ci] (#9941) * Change of the integrations and community plugin page * fix(docs): adjust links to moved pages; decrease image file sizes * fix(docs): use https:// links where possible, remove unused images, unify lowercase file extension for pngs * fix(docs): adjust links to moved pages; decrease image file sizes Co-authored-by: birthe <b.lindenthal@openproject.com>
3 years ago
The documentation for APIv3 is written in the [OpenAPI Format](https://www.openapis.org/) and its sources are being built from the entry point `openapi-spec.yml`.