Merge documentation folders

[ci skip]
This commit is contained in:
Oliver Günther
2017-03-16 14:12:09 +01:00
parent 8b53a7d1a2
commit 8023a8f558
69 changed files with 42 additions and 53 deletions
+34 -6
View File
@@ -1,13 +1,41 @@
# Documention source files
# OpenProject Community Guides
This folder contains source files for various documentation formats for OpenProject.
If you are looking for help resources on OpenProject, please see [our guides page](../guides/README.md).
## openproject.org guide sources
## Installation
All guides in the `wp` folder are sources being processed and concat by Wordpress for being presented on [www.openproject.org](http://www.openproject.org).
Get started with installing and upgrading OpenProject using [our Installation Guide starting point](https://www.openproject.org/open-source/download/).
The installation guides for OpenProject [can be found on our website](https://www.openproject.org/open-source/download/).
The guides for manual and Docker-based installations [are located here](./installing/README.md).
## Upgrading
The detailed upgrade instructions for our packaged installer are located on the [official website](https://www.openproject.org/download/upgrade-guides/).
The guides for manual and Docker-based installations [are located here](./upgrading/README.md).
## Operation
* [Backup guide](./backup/README.md)
* [Alter configuration of OpenProject](./configuration/README.md)
* [Manual repository integration for Git and Subversion](./repositories/README.md)
* [Configure incoming mails](./incoming-mails/README.md)
* [Install custom plugins](./plugins/README.md)
## User Guides
Please see our [User Guide pages](https://www.openproject.org/help/user-guides/) for detailed documentation on the functionality of OpenProject.
## Development
* [Quick Start for developers](./development/quick-start.md)
* [Full development environment for developers](./development/setting-up-development-environment.md)
* [Developing plugins](./development/create-openproject-plugin.md)
* [Developing OmniAuth Plugins](./development/create-omniauth-plugin.md)
* [Running tests](./development/running-tests.md)
* [Code review guidelines](./development/code-review-guidelines.md)
* [API documentation](./api/README.md)
## APIv3 documentation sources
@@ -1,6 +1,6 @@
# Packaged installation Backup Guide
The detailed backup instructions for our packages are located on the [official website](https://www.openproject.org/open-source/upgrade-backup/).
The detailed backup instructions for our packages [can be found here](./packaged/README.md).
# Manual installation
+2
View File
@@ -0,0 +1,2 @@
- [Configuration](./configuration.md)
- [Incoming Mails](./incoming-mails.md)
-3
View File
@@ -1,3 +0,0 @@
# Alternative Installation Methods
If you cannot use our packaged installation, you can see our [community contributed user guides](https://github.com/opf/openproject/tree/dev/guides/installing) for alternative installation methods.
@@ -1,4 +1,4 @@
# Install OpenProject (Docker)
### Install OpenProject with Docker
[Docker][docker] is a way to distribute self-contained applications easily. We
provide a Docker image for the Community Edition that you can very easily
@@ -14,7 +14,7 @@ the options that the package-based or manual installation provides.
[docker]: https://www.docker.com/
[docker-install]: https://docs.docker.com/engine/installation/
## Quick Start
### Quick Start
The fastest way to get an OpenProject instance up and running is to run the
following command:
@@ -37,7 +37,7 @@ achieved with the `-d` flag:
docker run -d -p 8080:80 -e SECRET_KEY_BASE=secret openproject/community:5.0
## Recommended usage
### Recommended usage
The one-liner above is great to get started quickly, but if you want to run
OpenProject in production you will likely want to ensure that your data is not
@@ -72,7 +72,7 @@ If you want to destroy the container, run the following commands
docker stop openproject && docker rm openproject
## Configuration
### Configuration
OpenProject is usually configured through a YAML file, but with the Docker
image you need to pass all configuration through environment variables. You can
@@ -122,7 +122,7 @@ You can adjust those settings for other SMTP providers, such as GMail,
Mandrill, etc. Please refer to the documentation of the corresponding provider
to see what values should be used.
## FAQ
### FAQ
* Can I use SSL?
-38
View File
@@ -1,38 +0,0 @@
# OpenProject Community Guides
## Installation
Get started with installing and upgrading OpenProject using [our Installation Guide starting point](https://www.openproject.org/open-source/download/).
The guides for manual and Docker-based installations [are located here](./installing/README.md).
## Upgrading
The detailed upgrade instructions for our packaged installer are located on the [official website](https://www.openproject.org/download/upgrade-guides/).
The guides for manual and Docker-based installations [are located here](./upgrading/README.md).
## Operation
* [Backup guide](./backup/README.md)
* [Alter configuration of OpenProject](./configuration/README.md)
* [Manual repository integration for Git and Subversion](./repositories/README.md)
* [Configure incoming mails](./incoming-mails/README.md)
* [Install custom plugins](./plugins/README.md)
## User Guides
Please see our [User Guide pages](https://www.openproject.org/help/user-guides/) for detailed documentation on the functionality of OpenProject.
## Development
* [Quick Start for developers](./development/quick-start.md)
* [Full development environment for developers](./development/setting-up-development-environment.md)
* [Developing plugins](./development/create-openproject-plugin.md)
* [Developing OmniAuth Plugins](./development/create-omniauth-plugin.md)
* [Running tests](./development/running-tests.md)
* [Code review guidelines](./development/code-review-guidelines.md)
* [API documentation](./api/README.md)