diff --git a/doc/README.md b/doc/README.md index cd332c663b..2d9a5f5932 100644 --- a/doc/README.md +++ b/doc/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 diff --git a/guides/api/README.md b/doc/api/README.md similarity index 100% rename from guides/api/README.md rename to doc/api/README.md diff --git a/doc/api_documentation_layouts/README.md b/doc/api/api_documentation_layouts/README.md similarity index 100% rename from doc/api_documentation_layouts/README.md rename to doc/api/api_documentation_layouts/README.md diff --git a/doc/api_documentation_layouts/openproject-includes.jade b/doc/api/api_documentation_layouts/openproject-includes.jade similarity index 100% rename from doc/api_documentation_layouts/openproject-includes.jade rename to doc/api/api_documentation_layouts/openproject-includes.jade diff --git a/doc/api_documentation_layouts/openproject-layout.jade b/doc/api/api_documentation_layouts/openproject-layout.jade similarity index 100% rename from doc/api_documentation_layouts/openproject-layout.jade rename to doc/api/api_documentation_layouts/openproject-layout.jade diff --git a/doc/apiv3-documentation.apib b/doc/api/apiv3-documentation.apib similarity index 100% rename from doc/apiv3-documentation.apib rename to doc/api/apiv3-documentation.apib diff --git a/doc/apiv3/basic-objects.apib b/doc/api/apiv3/basic-objects.apib similarity index 100% rename from doc/apiv3/basic-objects.apib rename to doc/api/apiv3/basic-objects.apib diff --git a/doc/apiv3/endpoints/activities.apib b/doc/api/apiv3/endpoints/activities.apib similarity index 100% rename from doc/apiv3/endpoints/activities.apib rename to doc/api/apiv3/endpoints/activities.apib diff --git a/doc/apiv3/endpoints/attachments.apib b/doc/api/apiv3/endpoints/attachments.apib similarity index 100% rename from doc/apiv3/endpoints/attachments.apib rename to doc/api/apiv3/endpoints/attachments.apib diff --git a/doc/apiv3/endpoints/categories.apib b/doc/api/apiv3/endpoints/categories.apib similarity index 100% rename from doc/apiv3/endpoints/categories.apib rename to doc/api/apiv3/endpoints/categories.apib diff --git a/doc/apiv3/endpoints/configuration.apib b/doc/api/apiv3/endpoints/configuration.apib similarity index 100% rename from doc/apiv3/endpoints/configuration.apib rename to doc/api/apiv3/endpoints/configuration.apib diff --git a/doc/apiv3/endpoints/forms.apib b/doc/api/apiv3/endpoints/forms.apib similarity index 100% rename from doc/apiv3/endpoints/forms.apib rename to doc/api/apiv3/endpoints/forms.apib diff --git a/doc/apiv3/endpoints/priorities.apib b/doc/api/apiv3/endpoints/priorities.apib similarity index 100% rename from doc/apiv3/endpoints/priorities.apib rename to doc/api/apiv3/endpoints/priorities.apib diff --git a/doc/apiv3/endpoints/projects.apib b/doc/api/apiv3/endpoints/projects.apib similarity index 100% rename from doc/apiv3/endpoints/projects.apib rename to doc/api/apiv3/endpoints/projects.apib diff --git a/doc/apiv3/endpoints/queries.apib b/doc/api/apiv3/endpoints/queries.apib similarity index 100% rename from doc/apiv3/endpoints/queries.apib rename to doc/api/apiv3/endpoints/queries.apib diff --git a/doc/apiv3/endpoints/relations.apib b/doc/api/apiv3/endpoints/relations.apib similarity index 100% rename from doc/apiv3/endpoints/relations.apib rename to doc/api/apiv3/endpoints/relations.apib diff --git a/doc/apiv3/endpoints/render.apib b/doc/api/apiv3/endpoints/render.apib similarity index 100% rename from doc/apiv3/endpoints/render.apib rename to doc/api/apiv3/endpoints/render.apib diff --git a/doc/apiv3/endpoints/revisions.apib b/doc/api/apiv3/endpoints/revisions.apib similarity index 100% rename from doc/apiv3/endpoints/revisions.apib rename to doc/api/apiv3/endpoints/revisions.apib diff --git a/doc/apiv3/endpoints/root.apib b/doc/api/apiv3/endpoints/root.apib similarity index 100% rename from doc/apiv3/endpoints/root.apib rename to doc/api/apiv3/endpoints/root.apib diff --git a/doc/apiv3/endpoints/schemas.apib b/doc/api/apiv3/endpoints/schemas.apib similarity index 100% rename from doc/apiv3/endpoints/schemas.apib rename to doc/api/apiv3/endpoints/schemas.apib diff --git a/doc/apiv3/endpoints/statuses.apib b/doc/api/apiv3/endpoints/statuses.apib similarity index 100% rename from doc/apiv3/endpoints/statuses.apib rename to doc/api/apiv3/endpoints/statuses.apib diff --git a/doc/apiv3/endpoints/string-objects.apib b/doc/api/apiv3/endpoints/string-objects.apib similarity index 100% rename from doc/apiv3/endpoints/string-objects.apib rename to doc/api/apiv3/endpoints/string-objects.apib diff --git a/doc/apiv3/endpoints/types.apib b/doc/api/apiv3/endpoints/types.apib similarity index 100% rename from doc/apiv3/endpoints/types.apib rename to doc/api/apiv3/endpoints/types.apib diff --git a/doc/apiv3/endpoints/user-preferences.apib b/doc/api/apiv3/endpoints/user-preferences.apib similarity index 100% rename from doc/apiv3/endpoints/user-preferences.apib rename to doc/api/apiv3/endpoints/user-preferences.apib diff --git a/doc/apiv3/endpoints/users.apib b/doc/api/apiv3/endpoints/users.apib similarity index 100% rename from doc/apiv3/endpoints/users.apib rename to doc/api/apiv3/endpoints/users.apib diff --git a/doc/apiv3/endpoints/versions.apib b/doc/api/apiv3/endpoints/versions.apib similarity index 100% rename from doc/apiv3/endpoints/versions.apib rename to doc/api/apiv3/endpoints/versions.apib diff --git a/doc/apiv3/endpoints/work-packages.apib b/doc/api/apiv3/endpoints/work-packages.apib similarity index 100% rename from doc/apiv3/endpoints/work-packages.apib rename to doc/api/apiv3/endpoints/work-packages.apib diff --git a/doc/apiv3/group-objects.apib b/doc/api/apiv3/group-objects.apib similarity index 100% rename from doc/apiv3/group-objects.apib rename to doc/api/apiv3/group-objects.apib diff --git a/doc/apiv3/introduction.apib b/doc/api/apiv3/introduction.apib similarity index 100% rename from doc/apiv3/introduction.apib rename to doc/api/apiv3/introduction.apib diff --git a/guides/backup/README.md b/doc/backup/README.md similarity index 57% rename from guides/backup/README.md rename to doc/backup/README.md index ec9304babf..26497b9875 100644 --- a/guides/backup/README.md +++ b/doc/backup/README.md @@ -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 diff --git a/guides/backup/docker/README.md b/doc/backup/docker/README.md similarity index 100% rename from guides/backup/docker/README.md rename to doc/backup/docker/README.md diff --git a/guides/backup/manual/README.md b/doc/backup/manual/README.md similarity index 100% rename from guides/backup/manual/README.md rename to doc/backup/manual/README.md diff --git a/doc/backup/backup-guide.md b/doc/backup/packaged/README.md similarity index 100% rename from doc/backup/backup-guide.md rename to doc/backup/packaged/README.md diff --git a/doc/configuration/README.md b/doc/configuration/README.md new file mode 100644 index 0000000000..85dd436521 --- /dev/null +++ b/doc/configuration/README.md @@ -0,0 +1,2 @@ +- [Configuration](./configuration.md) +- [Incoming Mails](./incoming-mails.md) \ No newline at end of file diff --git a/guides/configuration/README.md b/doc/configuration/configuration.md similarity index 100% rename from guides/configuration/README.md rename to doc/configuration/configuration.md diff --git a/guides/incoming-mails/README.md b/doc/configuration/incoming-mails.md similarity index 100% rename from guides/incoming-mails/README.md rename to doc/configuration/incoming-mails.md diff --git a/guides/development/README.md b/doc/development/README.md similarity index 100% rename from guides/development/README.md rename to doc/development/README.md diff --git a/guides/development/accessibility-checklist.md b/doc/development/accessibility-checklist.md similarity index 100% rename from guides/development/accessibility-checklist.md rename to doc/development/accessibility-checklist.md diff --git a/guides/development/code-review-guidelines.md b/doc/development/code-review-guidelines.md similarity index 100% rename from guides/development/code-review-guidelines.md rename to doc/development/code-review-guidelines.md diff --git a/guides/development/create-omniauth-plugin.md b/doc/development/create-omniauth-plugin.md similarity index 100% rename from guides/development/create-omniauth-plugin.md rename to doc/development/create-omniauth-plugin.md diff --git a/guides/development/create-openproject-plugin.md b/doc/development/create-openproject-plugin.md similarity index 100% rename from guides/development/create-openproject-plugin.md rename to doc/development/create-openproject-plugin.md diff --git a/guides/development/quick-start.md b/doc/development/quick-start.md similarity index 100% rename from guides/development/quick-start.md rename to doc/development/quick-start.md diff --git a/guides/development/release-process.md b/doc/development/release-process.md similarity index 100% rename from guides/development/release-process.md rename to doc/development/release-process.md diff --git a/guides/development/report-a-bug.md b/doc/development/report-a-bug.md similarity index 100% rename from guides/development/report-a-bug.md rename to doc/development/report-a-bug.md diff --git a/guides/development/running-tests.md b/doc/development/running-tests.md similarity index 100% rename from guides/development/running-tests.md rename to doc/development/running-tests.md diff --git a/guides/development/setting-up-development-environment.md b/doc/development/setting-up-development-environment.md similarity index 100% rename from guides/development/setting-up-development-environment.md rename to doc/development/setting-up-development-environment.md diff --git a/guides/installing/README.md b/doc/installation/README.md similarity index 100% rename from guides/installing/README.md rename to doc/installation/README.md diff --git a/doc/installation/alternative-methods.md b/doc/installation/alternative-methods.md deleted file mode 100644 index 290fc5d6be..0000000000 --- a/doc/installation/alternative-methods.md +++ /dev/null @@ -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. \ No newline at end of file diff --git a/guides/installing/docker/README.md b/doc/installation/docker/README.md similarity index 98% rename from guides/installing/docker/README.md rename to doc/installation/docker/README.md index 6ac63c3aaf..281b9aa8bf 100644 --- a/guides/installing/docker/README.md +++ b/doc/installation/docker/README.md @@ -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? diff --git a/guides/installing/manual/README.md b/doc/installation/manual/README.md similarity index 100% rename from guides/installing/manual/README.md rename to doc/installation/manual/README.md diff --git a/doc/installation/0-preparation.md b/doc/installation/packaged/0-preparation.md similarity index 100% rename from doc/installation/0-preparation.md rename to doc/installation/packaged/0-preparation.md diff --git a/doc/installation/1-installation.md b/doc/installation/packaged/1-installation.md similarity index 100% rename from doc/installation/1-installation.md rename to doc/installation/packaged/1-installation.md diff --git a/doc/installation/2-configuration.md b/doc/installation/packaged/2-configuration.md similarity index 100% rename from doc/installation/2-configuration.md rename to doc/installation/packaged/2-configuration.md diff --git a/doc/installation/3-customization.md b/doc/installation/packaged/3-customization.md similarity index 100% rename from doc/installation/3-customization.md rename to doc/installation/packaged/3-customization.md diff --git a/doc/installation/centos-7/steps.md b/doc/installation/packaged/centos-7/steps.md similarity index 100% rename from doc/installation/centos-7/steps.md rename to doc/installation/packaged/centos-7/steps.md diff --git a/doc/installation/debian-7/steps.md b/doc/installation/packaged/debian-7/steps.md similarity index 100% rename from doc/installation/debian-7/steps.md rename to doc/installation/packaged/debian-7/steps.md diff --git a/doc/installation/debian-8/steps.md b/doc/installation/packaged/debian-8/steps.md similarity index 100% rename from doc/installation/debian-8/steps.md rename to doc/installation/packaged/debian-8/steps.md diff --git a/doc/installation/sles-11/steps.md b/doc/installation/packaged/sles-11/steps.md similarity index 100% rename from doc/installation/sles-11/steps.md rename to doc/installation/packaged/sles-11/steps.md diff --git a/doc/installation/sles-12/steps.md b/doc/installation/packaged/sles-12/steps.md similarity index 100% rename from doc/installation/sles-12/steps.md rename to doc/installation/packaged/sles-12/steps.md diff --git a/doc/installation/ubuntu-14.04/steps.md b/doc/installation/packaged/ubuntu-14.04/steps.md similarity index 100% rename from doc/installation/ubuntu-14.04/steps.md rename to doc/installation/packaged/ubuntu-14.04/steps.md diff --git a/doc/installation/ubuntu-16.04/steps.md b/doc/installation/packaged/ubuntu-16.04/steps.md similarity index 100% rename from doc/installation/ubuntu-16.04/steps.md rename to doc/installation/packaged/ubuntu-16.04/steps.md diff --git a/doc/system_requirements.md b/doc/installation/system_requirements.md similarity index 100% rename from doc/system_requirements.md rename to doc/installation/system_requirements.md diff --git a/guides/repositories/README.md b/doc/repositories/README.md similarity index 100% rename from guides/repositories/README.md rename to doc/repositories/README.md diff --git a/guides/upgrading/README.md b/doc/upgrading/README.md similarity index 100% rename from guides/upgrading/README.md rename to doc/upgrading/README.md diff --git a/guides/upgrading/docker/README.md b/doc/upgrading/docker/README.md similarity index 100% rename from guides/upgrading/docker/README.md rename to doc/upgrading/docker/README.md diff --git a/guides/upgrading/manual/README.md b/doc/upgrading/manual/README.md similarity index 100% rename from guides/upgrading/manual/README.md rename to doc/upgrading/manual/README.md diff --git a/doc/upgrading/upgrade-guide-legacy.md b/doc/upgrading/packaged/upgrade-guide-legacy.md similarity index 100% rename from doc/upgrading/upgrade-guide-legacy.md rename to doc/upgrading/packaged/upgrade-guide-legacy.md diff --git a/doc/upgrading/upgrade-guide.md b/doc/upgrading/packaged/upgrade-guide.md similarity index 100% rename from doc/upgrading/upgrade-guide.md rename to doc/upgrading/packaged/upgrade-guide.md diff --git a/guides/README.md b/guides/README.md deleted file mode 100644 index f41ba213ae..0000000000 --- a/guides/README.md +++ /dev/null @@ -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) \ No newline at end of file