Merge documentation folders

[ci skip]
pull/5269/head
Oliver Günther 8 years ago
parent 8b53a7d1a2
commit 8023a8f558
No known key found for this signature in database
GPG Key ID: 88872239EB414F99
  1. 40
      doc/README.md
  2. 0
      doc/api/README.md
  3. 0
      doc/api/api_documentation_layouts/README.md
  4. 0
      doc/api/api_documentation_layouts/openproject-includes.jade
  5. 0
      doc/api/api_documentation_layouts/openproject-layout.jade
  6. 0
      doc/api/apiv3-documentation.apib
  7. 0
      doc/api/apiv3/basic-objects.apib
  8. 0
      doc/api/apiv3/endpoints/activities.apib
  9. 0
      doc/api/apiv3/endpoints/attachments.apib
  10. 0
      doc/api/apiv3/endpoints/categories.apib
  11. 0
      doc/api/apiv3/endpoints/configuration.apib
  12. 0
      doc/api/apiv3/endpoints/forms.apib
  13. 0
      doc/api/apiv3/endpoints/priorities.apib
  14. 0
      doc/api/apiv3/endpoints/projects.apib
  15. 0
      doc/api/apiv3/endpoints/queries.apib
  16. 0
      doc/api/apiv3/endpoints/relations.apib
  17. 0
      doc/api/apiv3/endpoints/render.apib
  18. 0
      doc/api/apiv3/endpoints/revisions.apib
  19. 0
      doc/api/apiv3/endpoints/root.apib
  20. 0
      doc/api/apiv3/endpoints/schemas.apib
  21. 0
      doc/api/apiv3/endpoints/statuses.apib
  22. 0
      doc/api/apiv3/endpoints/string-objects.apib
  23. 0
      doc/api/apiv3/endpoints/types.apib
  24. 0
      doc/api/apiv3/endpoints/user-preferences.apib
  25. 0
      doc/api/apiv3/endpoints/users.apib
  26. 0
      doc/api/apiv3/endpoints/versions.apib
  27. 0
      doc/api/apiv3/endpoints/work-packages.apib
  28. 0
      doc/api/apiv3/group-objects.apib
  29. 0
      doc/api/apiv3/introduction.apib
  30. 2
      doc/backup/README.md
  31. 0
      doc/backup/docker/README.md
  32. 0
      doc/backup/manual/README.md
  33. 0
      doc/backup/packaged/README.md
  34. 2
      doc/configuration/README.md
  35. 0
      doc/configuration/configuration.md
  36. 0
      doc/configuration/incoming-mails.md
  37. 0
      doc/development/README.md
  38. 0
      doc/development/accessibility-checklist.md
  39. 0
      doc/development/code-review-guidelines.md
  40. 0
      doc/development/create-omniauth-plugin.md
  41. 0
      doc/development/create-openproject-plugin.md
  42. 0
      doc/development/quick-start.md
  43. 0
      doc/development/release-process.md
  44. 0
      doc/development/report-a-bug.md
  45. 0
      doc/development/running-tests.md
  46. 0
      doc/development/setting-up-development-environment.md
  47. 0
      doc/installation/README.md
  48. 3
      doc/installation/alternative-methods.md
  49. 10
      doc/installation/docker/README.md
  50. 0
      doc/installation/manual/README.md
  51. 0
      doc/installation/packaged/0-preparation.md
  52. 0
      doc/installation/packaged/1-installation.md
  53. 0
      doc/installation/packaged/2-configuration.md
  54. 0
      doc/installation/packaged/3-customization.md
  55. 0
      doc/installation/packaged/centos-7/steps.md
  56. 0
      doc/installation/packaged/debian-7/steps.md
  57. 0
      doc/installation/packaged/debian-8/steps.md
  58. 0
      doc/installation/packaged/sles-11/steps.md
  59. 0
      doc/installation/packaged/sles-12/steps.md
  60. 0
      doc/installation/packaged/ubuntu-14.04/steps.md
  61. 0
      doc/installation/packaged/ubuntu-16.04/steps.md
  62. 0
      doc/installation/system_requirements.md
  63. 0
      doc/repositories/README.md
  64. 0
      doc/upgrading/README.md
  65. 0
      doc/upgrading/docker/README.md
  66. 0
      doc/upgrading/manual/README.md
  67. 0
      doc/upgrading/packaged/upgrade-guide-legacy.md
  68. 0
      doc/upgrading/packaged/upgrade-guide.md
  69. 38
      guides/README.md

@ -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

@ -0,0 +1,2 @@
- [Configuration](./configuration.md)
- [Incoming Mails](./incoming-mails.md)

@ -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?

@ -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)
Loading…
Cancel
Save