From ee4a99908f05d05244df9b44f0e521bdab0de24a Mon Sep 17 00:00:00 2001 From: Martin Tobias Degner Date: Wed, 4 Sep 2024 15:44:27 +0200 Subject: [PATCH] refactored documentation and categories files in dev and gereral category --- .../{contentSecurityPolicy.md => dev/csp.md} | 0 .../{loadProfiles.md => dev/load_profiles.md} | 0 .../{plotlyApps.md => dev/plotly_apps.md} | 0 .../source/{ => dev}/save_page_views.md | 0 .../source/{ => dev}/static_code_analysis.md | 0 .../source/{useCases.md => dev/use_cases.md} | 0 .../source/{ => general}/migrations.md | 0 .../source/{ => general}/production.md | 0 webcentral/doc/06_sphinx/source/index.rst | 40 +++++++++++++++---- 9 files changed, 32 insertions(+), 8 deletions(-) rename webcentral/doc/06_sphinx/source/{contentSecurityPolicy.md => dev/csp.md} (100%) rename webcentral/doc/06_sphinx/source/{loadProfiles.md => dev/load_profiles.md} (100%) rename webcentral/doc/06_sphinx/source/{plotlyApps.md => dev/plotly_apps.md} (100%) rename webcentral/doc/06_sphinx/source/{ => dev}/save_page_views.md (100%) rename webcentral/doc/06_sphinx/source/{ => dev}/static_code_analysis.md (100%) rename webcentral/doc/06_sphinx/source/{useCases.md => dev/use_cases.md} (100%) rename webcentral/doc/06_sphinx/source/{ => general}/migrations.md (100%) rename webcentral/doc/06_sphinx/source/{ => general}/production.md (100%) diff --git a/webcentral/doc/06_sphinx/source/contentSecurityPolicy.md b/webcentral/doc/06_sphinx/source/dev/csp.md similarity index 100% rename from webcentral/doc/06_sphinx/source/contentSecurityPolicy.md rename to webcentral/doc/06_sphinx/source/dev/csp.md diff --git a/webcentral/doc/06_sphinx/source/loadProfiles.md b/webcentral/doc/06_sphinx/source/dev/load_profiles.md similarity index 100% rename from webcentral/doc/06_sphinx/source/loadProfiles.md rename to webcentral/doc/06_sphinx/source/dev/load_profiles.md diff --git a/webcentral/doc/06_sphinx/source/plotlyApps.md b/webcentral/doc/06_sphinx/source/dev/plotly_apps.md similarity index 100% rename from webcentral/doc/06_sphinx/source/plotlyApps.md rename to webcentral/doc/06_sphinx/source/dev/plotly_apps.md diff --git a/webcentral/doc/06_sphinx/source/save_page_views.md b/webcentral/doc/06_sphinx/source/dev/save_page_views.md similarity index 100% rename from webcentral/doc/06_sphinx/source/save_page_views.md rename to webcentral/doc/06_sphinx/source/dev/save_page_views.md diff --git a/webcentral/doc/06_sphinx/source/static_code_analysis.md b/webcentral/doc/06_sphinx/source/dev/static_code_analysis.md similarity index 100% rename from webcentral/doc/06_sphinx/source/static_code_analysis.md rename to webcentral/doc/06_sphinx/source/dev/static_code_analysis.md diff --git a/webcentral/doc/06_sphinx/source/useCases.md b/webcentral/doc/06_sphinx/source/dev/use_cases.md similarity index 100% rename from webcentral/doc/06_sphinx/source/useCases.md rename to webcentral/doc/06_sphinx/source/dev/use_cases.md diff --git a/webcentral/doc/06_sphinx/source/migrations.md b/webcentral/doc/06_sphinx/source/general/migrations.md similarity index 100% rename from webcentral/doc/06_sphinx/source/migrations.md rename to webcentral/doc/06_sphinx/source/general/migrations.md diff --git a/webcentral/doc/06_sphinx/source/production.md b/webcentral/doc/06_sphinx/source/general/production.md similarity index 100% rename from webcentral/doc/06_sphinx/source/production.md rename to webcentral/doc/06_sphinx/source/general/production.md diff --git a/webcentral/doc/06_sphinx/source/index.rst b/webcentral/doc/06_sphinx/source/index.rst index 38c51f05b..6af403766 100644 --- a/webcentral/doc/06_sphinx/source/index.rst +++ b/webcentral/doc/06_sphinx/source/index.rst @@ -9,26 +9,50 @@ Welcome to webcentral's documentation! Here you can find the documentation of the page source. The source code can be found on Github (insert link). If you would like to do some development or host the Wissensplattform, please find information on the get started (insert link) page +End user guide +============== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + general/getting_started + general/data_import + general/migrations + general/production + +Develop guide +============= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + dev/style_guide + dev/static_code_analysis + dev/pyproject_toml + dev/testing + dev/load_profiles + dev/plotly_apps + dev/csp + dev/use_cases + dev/save_page_views + .. toctree:: :maxdepth: 2 :caption: Contents: - quickstart - migrations installtion_basics - pyproject_toml - contentSecurityPolicy dataImportDjango insertLinksInDatabase templateStructure translation - loadProfiles - plotlyApps - useCases listing_pages testing - production + + + Indices and tables ==================