[Docs]: move to readthedocs documentation (#1880)

Kunstmaan · Apr 3, 2018 · 5225d54 · 5225d54
1 parent f6cb020
commit 5225d54
Show file tree

Hide file tree

Showing 71 changed files with 171 additions and 94 deletions.
diff --git a/docs/03-00-installation.md b/docs/03-00-installation.md
diff --git a/docs/04-00-content-management.md b/docs/04-00-content-management.md
diff --git a/docs/05-00-cookbook.md b/docs/05-00-cookbook.md
diff --git a/docs/05-01-intro.md b/docs/05-01-intro.md
diff --git a/docs/06-00-bundles.md b/docs/06-00-bundles.md
diff --git a/docs/06-01-admin-bundle.md b/docs/06-01-admin-bundle.md
diff --git a/docs/06-02-adminlist-bundle.md b/docs/06-02-adminlist-bundle.md
diff --git a/docs/06-08-node-bundle.md b/docs/06-08-node-bundle.md
diff --git a/docs/99-00-contributing.md b/docs/99-00-contributing.md
diff --git a/docs/99-09-groundcontrol.md b/docs/99-09-groundcontrol.md
diff --git a/docs/04-07-adding-admin-menu-items.md → ...s/admin-bundle/adding-admin-menu-items.md b/docs/04-07-adding-admin-menu-items.md → ...s/admin-bundle/adding-admin-menu-items.md
diff --git a/docs/06-01_01-customizing-the-top-menu.md → .../admin-bundle/customizing-the-top-menu.md b/docs/06-01_01-customizing-the-top-menu.md → .../admin-bundle/customizing-the-top-menu.md
diff --git a/docs/06-01_02-form-collection-additions.md → ...admin-bundle/form-collection-additions.md b/docs/06-01_02-form-collection-additions.md → ...admin-bundle/form-collection-additions.md
diff --git a/docs/06-01_03-permissions.md → docs/bundles/admin-bundle/permissions.md b/docs/06-01_03-permissions.md → docs/bundles/admin-bundle/permissions.md
diff --git a/docs/06-02_03-configuring-adminlists.md → ...dminlist-bundle/configuring-adminlists.md b/docs/06-02_03-configuring-adminlists.md → ...dminlist-bundle/configuring-adminlists.md
diff --git a/docs/06-02_02-creating-an-adminlist.md → ...adminlist-bundle/creating-an-adminlist.md b/docs/06-02_02-creating-an-adminlist.md → ...adminlist-bundle/creating-an-adminlist.md
diff --git a/docs/06-02_01-intro.md → docs/bundles/adminlist-bundle/intro.md b/docs/06-02_01-intro.md → docs/bundles/adminlist-bundle/intro.md
diff --git a/docs/06-03-article-bundle.md → docs/bundles/article-bundle.md b/docs/06-03-article-bundle.md → docs/bundles/article-bundle.md
diff --git a/docs/06-04-config-bundle.md → docs/bundles/config-bundle.md b/docs/06-04-config-bundle.md → docs/bundles/config-bundle.md
diff --git a/docs/06-05-form-bundle.md → docs/bundles/form-bundle.md b/docs/06-05-form-bundle.md → docs/bundles/form-bundle.md
diff --git a/docs/06-06-generator-bundle.md → docs/bundles/generator-bundle.md b/docs/06-06-generator-bundle.md → docs/bundles/generator-bundle.md
diff --git a/docs/06-07-media-bundle.md → docs/bundles/media-bundle.md b/docs/06-07-media-bundle.md → docs/bundles/media-bundle.md
diff --git a/docs/06-08_02-chainrouter.md → docs/bundles/node-bundle/chainrouter.md b/docs/06-08_02-chainrouter.md → docs/bundles/node-bundle/chainrouter.md
diff --git a/docs/06-08_03-configurable-action-menu.md → ...s/node-bundle/configurable-action-menu.md b/docs/06-08_03-configurable-action-menu.md → ...s/node-bundle/configurable-action-menu.md
diff --git a/docs/06-08_01-intro.md → docs/bundles/node-bundle/intro.md b/docs/06-08_01-intro.md → docs/bundles/node-bundle/intro.md
diff --git a/docs/06-08_04-locking.md → docs/bundles/node-bundle/locking.md b/docs/06-08_04-locking.md → docs/bundles/node-bundle/locking.md
diff --git a/docs/06-08_05-pages-configuration.md → ...undles/node-bundle/pages-configuration.md b/docs/06-08_05-pages-configuration.md → ...undles/node-bundle/pages-configuration.md
diff --git a/...06-08_06-programmatically-create-nodes.md → ...e-bundle/programmatically-create-nodes.md b/...06-08_06-programmatically-create-nodes.md → ...e-bundle/programmatically-create-nodes.md
diff --git a/docs/06-09-search-bundle.md → docs/bundles/search-bundle.md b/docs/06-09-search-bundle.md → docs/bundles/search-bundle.md
diff --git a/docs/06-10-sitemap-bundle.md → docs/bundles/sitemap-bundle.md b/docs/06-10-sitemap-bundle.md → docs/bundles/sitemap-bundle.md
diff --git a/docs/06-11-tagging-bundle.md → docs/bundles/tagging-bundle.md b/docs/06-11-tagging-bundle.md → docs/bundles/tagging-bundle.md
diff --git a/docs/06-12-utilities-bundle.md → docs/bundles/utilities-bundle.md b/docs/06-12-utilities-bundle.md → docs/bundles/utilities-bundle.md
diff --git a/docs/06-13-voting-bundle.md → docs/bundles/voting-bundle.md b/docs/06-13-voting-bundle.md → docs/bundles/voting-bundle.md
diff --git a/docs/04-05-adding-a-newssection-or-blog.md → ...anagement/adding-a-newssection-or-blog.md b/docs/04-05-adding-a-newssection-or-blog.md → ...anagement/adding-a-newssection-or-blog.md
diff --git a/docs/04-06-adding-a-search-engine.md → ...tent-management/adding-a-search-engine.md b/docs/04-06-adding-a-search-engine.md → ...tent-management/adding-a-search-engine.md
diff --git a/docs/06-01_04-adding-admin-menu-items.md → ...ent-management/adding-admin-menu-items.md b/docs/06-01_04-adding-admin-menu-items.md → ...ent-management/adding-admin-menu-items.md
diff --git a/docs/04-02-creating-a-page-part.md → ...ontent-management/creating-a-page-part.md b/docs/04-02-creating-a-page-part.md → ...ontent-management/creating-a-page-part.md
diff --git a/docs/04-04-creating-a-pagetype.md → ...content-management/creating-a-pagetype.md b/docs/04-04-creating-a-pagetype.md → ...content-management/creating-a-pagetype.md
@@ -4,7 +4,7 @@ There are times when a basic content page does not suffice, because you want to
 
 ## Creating your first custom page type
 
-In the [previous chapter](04-02-creating-an-adminlist.md) we created an admin list of employees, but how about displaying these on the front-end?
+In the [previous chapter](../bundles/adminlist-bundle/creating-an-adminlist.md) we created an admin list of employees, but how about displaying these on the front-end?
 
 That's what this chapter is all about. Custom page types can define pages containing a specific set of page parts or pages that need their own specific rendering or handling.
 

diff --git a/docs/04-01-intro.md → docs/content-management/index.md b/docs/04-01-intro.md → docs/content-management/index.md
@@ -4,6 +4,7 @@ Ok, so you've successfully installed the Kunstmaan Bundles CMS, and (hopefully)
 
 We'll gradually introduce all concepts, starting off with the basics. Throughout the manual we'll set up a small site for a virtual company. So if you follow all chapters, you should have a full featured site by the end of the manual.
 
-* [Creating a page part](./04-02-creating-a-page-part.md)
-* [Creating an adminlist](./06-02_02-creating-an-adminlist.md)
-* [Creating a pagetype](./04-04-creating-a-pagetype.md)
+* [Creating a page part](./creating-a-page-part.md)
+* [Creating a pagetype](./creating-a-pagetype.md)
+* [Adding a newssection or blog](./adding-a-newssection-or-blog.md)
+* [Adding admin menu items](./adding-admin-menu-items.md)
diff --git a/docs/99-03-coding-standards.md → docs/contributing/coding-standards.md b/docs/99-03-coding-standards.md → docs/contributing/coding-standards.md
diff --git a/docs/99-06-community-bundles.md → docs/contributing/community-bundles.md b/docs/99-06-community-bundles.md → docs/contributing/community-bundles.md
diff --git a/docs/99-08-contributing-translations.md → ...contributing/contributing-translations.md b/docs/99-08-contributing-translations.md → ...contributing/contributing-translations.md
diff --git a/docs/contributing/index.md b/docs/contributing/index.md
@@ -0,0 +1,12 @@
+# Contributing
+
+We follow most of the procedures for contributions from the [Symfony](http://symfony.com/doc/current/contributing/index.html) and [Sylius](http://sylius.org) project, as such much of this info will look familiar as it embodies current best practices.
+
+* [Reporting a bug or a security issue](reporting-issues.md)
+* [Submitting pull requests](pull-requests.md)
+* [Coding standards](coding-standards.md)
+* [Preparing a new release](preparing-a-new-release.md)
+* [Roadmap](roadmap.md)
+* [Community bundles](community-bundles.md)
+* [Release process](release-process.md)
+* [Translations](contributing-translations.md)
diff --git a/docs/99-04-preparing-a-new-release.md → docs/contributing/preparing-a-new-release.md b/docs/99-04-preparing-a-new-release.md → docs/contributing/preparing-a-new-release.md
diff --git a/docs/99-02-pull-requests.md → docs/contributing/pull-requests.md b/docs/99-02-pull-requests.md → docs/contributing/pull-requests.md
@@ -4,7 +4,7 @@ Pull request are the best way to provide a bug fix or to propose enhancements to
 
 ## Step 1: Setup your environment
 
-Before working on the KunstmaanBundlesCMS, setup a Symfony friendly environment like described in the [system requirements documentation](./03-02-system-requirements.md) or [work with the PuPHPet Vagrant box](./03-03-development-environment.md).
+Before working on the KunstmaanBundlesCMS, setup a Symfony friendly environment like described in the [system requirements documentation](../installation/system-requirements.md) or [work with the PuPHPet Vagrant box](../installation/development-environment.md).
 
 Make sure your git setup is complete. If you are new to git, we highly recommended you read the excellent and free [ProGit book](http://git-scm.com/book).
 
@@ -50,7 +50,7 @@ branch (check the branch you are working on with ``git branch``).
 Now work on the code as much as you want and commit as much as you want; but keep
 in mind the following:
 
-* Follow the [coding standards](./99-03-coding-standards.md)
+* Follow the [coding standards](coding-standards.md)
 * Do atomic and logically separate commits (use the power of ``git rebase`` to
   have a clean and logical history);
 * Squash irrelevant commits that are just about fixing coding standards or

diff --git a/docs/99-07-release-process.md → docs/contributing/release-process.md b/docs/99-07-release-process.md → docs/contributing/release-process.md
diff --git a/docs/99-01-reporting-issues.md → docs/contributing/reporting-issues.md b/docs/99-01-reporting-issues.md → docs/contributing/reporting-issues.md
diff --git a/docs/99-05-roadmap.md → docs/contributing/roadmap.md b/docs/99-05-roadmap.md → docs/contributing/roadmap.md
diff --git a/docs/05-12-adding-a-custom-controller.md → docs/cookbook/adding-a-custom-controller.md b/docs/05-12-adding-a-custom-controller.md → docs/cookbook/adding-a-custom-controller.md
diff --git a/docs/05-05-administer-robots-txt.md → docs/cookbook/administer-robots-txt.md b/docs/05-05-administer-robots-txt.md → docs/cookbook/administer-robots-txt.md
diff --git a/...ding-custom-filter-on-multiple-columns.md → ...ding-custom-filter-on-multiple-columns.md b/...ding-custom-filter-on-multiple-columns.md → ...ding-custom-filter-on-multiple-columns.md
diff --git a/...defining-custom-ckeditor-configuration.md → ...defining-custom-ckeditor-configuration.md b/...defining-custom-ckeditor-configuration.md → ...defining-custom-ckeditor-configuration.md
diff --git a/docs/05-14-enabling-google-auth-login.md → docs/cookbook/enabling-google-auth-login.md b/docs/05-14-enabling-google-auth-login.md → docs/cookbook/enabling-google-auth-login.md
diff --git a/docs/05-02-going-single-language.md → docs/cookbook/going-single-language.md b/docs/05-02-going-single-language.md → docs/cookbook/going-single-language.md
diff --git a/docs/05-04-google-analytics-dashboard.md → docs/cookbook/google-analytics-dashboard.md b/docs/05-04-google-analytics-dashboard.md → docs/cookbook/google-analytics-dashboard.md
diff --git a/docs/cookbook/index.md b/docs/cookbook/index.md
@@ -0,0 +1,21 @@
+# Cookbook
+
+The cookbook is a continuously growing collection of recipes that explain how to correctly solve the most recurrent problems that developers face in their day to day work with the KunstmaanBundlesCMS.
+
+* [Going single language](going-single-language.md)
+* [Managing translations](manage-translations.md)
+* [Google Analytics dashboard](google-analytics-dashboard.md)
+* [Administer robots.txt](administer-robots-txt.md)
+* [Building a custom admin list filter that works on multiple columns](building-custom-filter-on-multiple-columns.md)
+* [Using the LeadGenerationBundle](using-the-leadgenerationbundle.md)
+* [Using the MenuBundle](using-the-menubundle.md)
+* [Using the MultiDomainBundle](using-the-multi-domain-bundle.md)
+* [Defining custom ckeditor configuration](defining-custom-ckeditor-configuration.md)
+* [Structure pages](structure-pages.md)
+* [Adding a custom controller](adding-a-custom-controller.md)
+* [Using a custom filesystem for the media bundle](using-a-custom-filesystem-for-the-media-bundle.md)
+* [Enabling google login](enabling-google-auth-login.md)
+* [Using the cache bundle](using-the-cache-bundle.md)
+* [Using anacrontab](using-anacrontab.md)
+
+> Have some cool insight or thing you did with the CMS? Please share it with us and other developers by [sending a pull request](../contributing/pull-requests.md)!
diff --git a/docs/05-03-manage-translations.md → docs/cookbook/manage-translations.md b/docs/05-03-manage-translations.md → docs/cookbook/manage-translations.md
diff --git a/docs/05-11-structure-pages.md → docs/cookbook/structure-pages.md b/docs/05-11-structure-pages.md → docs/cookbook/structure-pages.md
diff --git a/...custom-filesystem-for-the-media-bundle.md → ...custom-filesystem-for-the-media-bundle.md b/...custom-filesystem-for-the-media-bundle.md → ...custom-filesystem-for-the-media-bundle.md
diff --git a/docs/05-16-using-anacrontab.md → docs/cookbook/using-anacrontab.md b/docs/05-16-using-anacrontab.md → docs/cookbook/using-anacrontab.md
diff --git a/docs/05-15-using-the-cache-bundle.md → docs/cookbook/using-the-cache-bundle.md b/docs/05-15-using-the-cache-bundle.md → docs/cookbook/using-the-cache-bundle.md
diff --git a/docs/05-07-using-the-leadgenerationbundle.md → ...ookbook/using-the-leadgenerationbundle.md b/docs/05-07-using-the-leadgenerationbundle.md → ...ookbook/using-the-leadgenerationbundle.md
diff --git a/docs/05-08-using-the-menubundle.md → docs/cookbook/using-the-menubundle.md b/docs/05-08-using-the-menubundle.md → docs/cookbook/using-the-menubundle.md
diff --git a/docs/05-09-using-the-multi-domain-bundle.md → ...cookbook/using-the-multi-domain-bundle.md b/docs/05-09-using-the-multi-domain-bundle.md → ...cookbook/using-the-multi-domain-bundle.md
diff --git a/docs/02-00-getting-started.md → docs/getting-started/index.md b/docs/02-00-getting-started.md → docs/getting-started/index.md
@@ -18,35 +18,32 @@ We can also recommend investing some time in reading these books:
 
 Documentation specific to the KunstmaanBundlesCMS can be found on:
 
-* [Installation Guide](./03-00-installation.md)
-    * [System requirements](./03-02-system-requirements.md)
-    * [Development environment](./03-03-development-environment.md)
-* [Content Management Guide](./04-01-intro.md)
-    * [Creating a pagepart](./04-02-creating-a-page-part.md)
-	* [Creating an adminlist](./04-03-creating-an-adminlist.md)
-	* [Creating a pagetype](./04-04-creating-a-pagetype.md)
-	* [Adding a newssection or blog](./04-05-adding-a-newssection-or-blog.md)
-	* [Adding a search engine](./04-06-adding-a-search-engine.md)
-* [Cookbook](./05-01-intro.md)
-	* [Going single language](./05-02-going-single-language.md)
-	* [Managing translations](./05-03-manage-translations.md)
-	* [Google Analytics dashboard](./05-04-google-analytics-dashboard.md)
-
+* [Installation Guide](../installation/index.md)
+    * [System requirements](../installation/system-requirements.md)
+    * [Development environment](../installation/development-environment.md)
+* [Content Management Guide](../content-management/index.md)
+    * [Creating a pagepart](../content-management/creating-a-page-part.md)
+	* [Creating a pagetype](../content-management/creating-a-pagetype.md)
+	* [Adding a newssection or blog](../content-management/adding-a-newssection-or-blog.md)
+	* [Adding a search engine](../content-management/adding-a-search-engine.md)
+* [Cookbook](../cookbook/index.md)
+	* [Going single language](../cookbook/going-single-language.md)
+	* [Managing translations](../cookbook/manage-translations.md)
+	* [Google Analytics dashboard](../cookbook/google-analytics-dashboard.md)
 > Writing documentation is hard. Especially if the writer is fully into the topic at hand. This results in the glossing over of obvious information for the writer, that might not be obvious for everyone else. We wholeheartedly appreciate pull requests or suggestions for this documentation.
 
 ## Contribute
 
 We follow most of the procedures for contributions from the [Symfony](http://symfony.com/doc/current/contributing/index.html) and [Sylius](http://sylius.org) project, as such much of this info will look familiar as it embodies current best practices.
 
-* [Reporting a bug or a security issue](./99-01-reporting-issues.md)
-* [Submitting pull requests](./99-02-pull-requests.md)
-* [Coding standards](./99-03-coding-standards.md)
-* [Preparing a new release](./99-04-preparing-a-new-release.md)
-
+* [Reporting a bug or a security issue](../contributing/reporting-issues.md)
+* [Submitting pull requests](../contributing/pull-requests.md)
+* [Coding standards](../contributing/coding-standards.md)
+* [Preparing a new release](../contributing/preparing-a-new-release.md)
 ## Support
 
-For questions you can always ask your question via a Github Issue ([following the same guidelines as bug reporting](./99-01-reporting-issues.md)) or shoot us an email at bundles AT kunstmaan.be.
+For questions you can always ask your question via a Github Issue ([following the same guidelines as bug reporting](../contributing/reporting-issues.md)) or shoot us an email at bundles AT kunstmaan.be.
 
 ## Installation Guide
 
-Installing the KunstmaanBundlesCMS is a short process that is almost fully automated by `composer` and generators. [Check out the in depth guide in the next chapter](./03-00-installation.md).
+Installing the KunstmaanBundlesCMS is a short process that is almost fully automated by `composer` and generators. [Check out the in depth guide in the next chapter](../installation/index.md).
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,33 @@
+Kunstmaan Bundles CMS
+=====================
+
+The Kunstmaan Bundles CMS is an advanced yet user-friendly content management system, based on the full stack Symfony framework combined with a whole host of community bundles. It provides a full featured, multi-language CMS system with
+an innovative page and form assembling process, versioning, workflow, translation and media managers and much much more.
+
+Please refer to the documentation at [https://bundles.kunstmaan.be/documentation](https://bundles.kunstmaan.be/documentation) to get your CMS up and running.
+
+![Screenshot](https://bundles.kunstmaan.be/bundles/kunstmaanbundlewebsite/img/general/content-management-system-kunstmaan.jpg)
+
+### Contributing
+
+We love contributions! We've provide you with a [Contribution Guide](./contributing/index.md) to get you started.
+If you're submitting a pull request, please follow the guidelines in the [Submitting pull requests](./contributing/pull-requests.md)
+documentation and be sure to read our [Coding Standards](./contributing/coding-standards.md) as well.
+
+### Browser support
+
+We support at least the 2 last versions of Chrome / Firefox / Safari and IE9 or up. We also support the most current mobile browsers.
+
+Enjoy!
+
+
+[![Build Status](https://travis-ci.org/Kunstmaan/KunstmaanBundlesCMS.svg?branch=master)](https://travis-ci.org/Kunstmaan/KunstmaanBundlesCMS)
+[![Latest Stable Version](https://poser.pugx.org/kunstmaan/bundles-cms/v/stable)](https://packagist.org/packages/kunstmaan/bundles-cms)
+[![Latest Unstable Version](https://poser.pugx.org/kunstmaan/bundles-cms/v/unstable)](https://packagist.org/packages/kunstmaan/bundles-cms)
+[![Total Downloads](https://poser.pugx.org/kunstmaan/bundles-cms/downloads)](https://packagist.org/packages/kunstmaan/bundles-cms)
+[![Monthly Downloads](https://poser.pugx.org/kunstmaan/bundles-cms/d/monthly)](https://packagist.org/packages/kunstmaan/bundles-cms)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Kunstmaan/KunstmaanBundlesCMS/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Kunstmaan/KunstmaanBundlesCMS/?branch=master)
+[![Code Coverage](https://scrutinizer-ci.com/g/Kunstmaan/KunstmaanBundlesCMS/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/Kunstmaan/KunstmaanBundlesCMS/?branch=master)
+[![SensioLabsInsight](https://insight.sensiolabs.com/projects/34aece18-3640-47ea-8e9f-96b79919905b/mini.png)](https://insight.sensiolabs.com/projects/34aece18-3640-47ea-8e9f-96b79919905b)
+[![Crowdin](https://d322cqt584bo4o.cloudfront.net/kunstmaanbundlescms/localized.svg)](http://translatebundles.kunstmaan.be/project/kunstmaanbundlescms)
+[![License](https://poser.pugx.org/kunstmaan/bundles-cms/license)](https://packagist.org/packages/kunstmaan/bundles-cms)
diff --git a/docs/03-03-development-environment.md → docs/installation/development-environment.md b/docs/03-03-development-environment.md → docs/installation/development-environment.md
diff --git a/docs/03-01-intro.md → docs/installation/index.md b/docs/03-01-intro.md → docs/installation/index.md
@@ -1,6 +1,6 @@
 # Installation
 
-> For the sake of clarity we will perform this installation in a preconfigured Vagrant box built with [PuPHPet](https://puphpet.com). More info in [this chapter about the PuPHPet development environment](./03-03-development-environment.md). If you have a development environment, just adjust to match your specifics.
+> For the sake of clarity we will perform this installation in a preconfigured Vagrant box built with [PuPHPet](https://puphpet.com). More info in [this chapter about the PuPHPet development environment](development-environment.md). If you have a development environment, just adjust to match your specifics.
 >
 > This chapter assumes you have started the box (`vagrant up`), ssh'ed into it (`vagrant ssh`) and have navigated to the `/var/www` folder (`cd /var/www`). If there is a folder there called `myprojectname` you should delete it by running: `rm -Rf myprojectname`
 

diff --git a/docs/03-02-system-requirements.md → docs/installation/system-requirements.md b/docs/03-02-system-requirements.md → docs/installation/system-requirements.md
diff --git a/docs/01-00-introduction.md → docs/introduction/index.md b/docs/01-00-introduction.md → docs/introduction/index.md