From 9a3d315c17d32d43916a784886063591b117d809 Mon Sep 17 00:00:00 2001 From: Alex Ackermann Date: Tue, 15 Apr 2025 18:06:07 +0200 Subject: [PATCH 1/3] Remove file and folder prefixes e.G 10-server --- .../110-web-applications.md | 0 .../_category_.json | 0 .../antivirus.md} | 0 .../external-idp.md} | 0 .../index.md | 0 .../keycloak.md} | 4 +-- .../file-picker.md} | 0 .../firewall.md} | 0 .../img/app-store.png | Bin .../img/decomposeds3-with-minio.png | Bin .../img/login-page.png | Bin .../monitoring.md} | 0 .../10-office.md => configuration/office.md} | 0 .../40-search.md => configuration/search.md} | 0 .../storage}/_category_.json | 0 .../storage/cephfs.md} | 0 .../storage/decomposeds3.md} | 2 +- .../storage/posixfs.md} | 0 .../_category_.json | 0 .../docker}/_category_.json | 0 .../docker/docker-compose-local.md} | 2 +- .../docker/docker-compose.md} | 2 +- .../docker/docker.md} | 2 +- .../bare-metal/cd-opencloud-subdirectory.png | Bin .../img/bare-metal/cd-opencloud.png | Bin .../img/bare-metal/corepack-enable.png | Bin .../img/bare-metal/git-clone.png | Bin .../img/bare-metal/install-corepack.png | Bin .../img/bare-metal/install-git.png | Bin .../img/bare-metal/install-golang.png | Bin .../img/bare-metal/install-npm.png | Bin .../img/bare-metal/localhost-warnung.png | Bin .../img/bare-metal/login.png | Bin .../img/bare-metal/opencloud-init.png | Bin .../img/bare-metal/opencloud-server.png | Bin .../docker-compose/certificate-details.png | Bin .../img/docker-compose/certificate-viewer.png | Bin .../img/docker-compose/login.png | Bin .../img/docker-compose/status-secure.png | Bin .../img/docker-compose/subordinate-ca's.png | Bin .../collabora-accept-self-signed-cert.png | Bin .../img/quick-guide/docker-opencloud-init.png | Bin .../quick-guide/quick-docker-compose-up.png | Bin .../img/quick-guide/quick-login.png | Bin .../raspberrypi/change-env-for-storage.png | Bin .../img/raspberrypi/docker-compose-check.png | Bin .../img/raspberrypi/docker-user-check.png | Bin .../img/raspberrypi/error-mounting.png | Bin .../img/raspberrypi/find-external-hd.png | Bin .../img/raspberrypi/format-drive.png | Bin .../img/raspberrypi/ip-router.png | Bin .../img/raspberrypi/noip.png | Bin .../img/raspberrypi/oc-domain.png | Bin .../img/raspberrypi/portforwarding.png | Bin .../img/raspberrypi/reachable-via-URL.png | Bin .../img/raspberrypi/ssh-activate.png | Bin .../kubernetes.md} | 0 .../other}/_category_.json | 0 .../other/bare-metal.md} | 2 +- .../other/raspberry-pi.md} | 0 .../requirements.md} | 0 .../_category_.json | 0 .../20-backup.md => maintenance/backup.md} | 0 .../img/generate-pass-nc.png | Bin .../img/init-diff.png | Bin .../30-migrate.md => maintenance/migrate.md} | 0 .../10-upgrade.md => maintenance/upgrade.md} | 2 +- .../_category_.json | 0 .../common-issues.md} | 0 .../demo-user.md} | 10 +++---- .../quick-accept-security-risk.png | Bin .../img/common-issues/quick-advanced.png | Bin .../common-issues/quick-docker-running.png | Bin .../img/demo-user}/admin.png | Bin .../img/demo-user}/alan-turing.png | Bin .../img/demo-user}/dennis-ritchie.png | Bin .../img/demo-user}/lynn-conway.png | Bin .../img/demo-user}/margaret-hamilton.png | Bin .../img/demo-user}/mary-kenneth-keller.png | Bin .../lifecycle.md} | 0 .../whats-new.md} | 0 .../{10-welcome => welcome}/_category_.json | 0 .../30-datasheet.md => welcome/datasheet.md} | 0 .../{10-welcome/10-faq.md => welcome/faq.md} | 0 .../20-features.md => welcome/features.md} | 0 docs/admin/{10-welcome => welcome}/index.md | 0 docs/dev/server/_category_.json | 4 +++ docs/dev/server/diagrams/_category_.json | 9 ++++++ docs/dev/server/diagrams/specifications.md | 27 ++++++++++++++++++ docs/dev/server/index.md | 3 ++ docs/dev/web/_category_.json | 4 +++ .../development}/_category_.json | 0 .../development/conventions.md} | 2 +- .../development/repo-structure.md} | 6 ++-- .../development/tooling.md} | 0 .../embed-mode}/_category_.json | 0 .../40-embed-mode => web/embed-mode}/index.md | 0 .../extension-system}/_category_.json | 0 .../extension-types}/_category_.json | 0 .../extension-types/action-extensions.md} | 0 .../app-menu-item-extensions.md} | 0 .../custom-component-extensions.md} | 0 .../folder-view-extensions.md} | 0 .../extension-types}/index.md | 0 .../left-sidebar-menu-item-extensions.md} | 0 .../right-sidebar-panel-extensions.md} | 0 .../extension-types/search-extensions.md} | 0 .../extension-system}/index.md | 14 ++++----- .../extension-system/viewer-editor-apps.md} | 0 .../getting-started.md} | 2 +- docs/dev/{20-web => web}/index.md | 2 +- .../testing}/_category_.json | 0 .../testing/e2e-testing-standards.md} | 0 .../testing/running-tests.md} | 2 +- 114 files changed, 74 insertions(+), 27 deletions(-) rename docs/admin/{30-configuration => configuration}/110-web-applications.md (100%) rename docs/admin/{30-configuration => configuration}/_category_.json (100%) rename docs/admin/{30-configuration/50-antivirus.md => configuration/antivirus.md} (100%) rename docs/admin/{30-configuration/30-authentication-and-user-management/10-external-idp.md => configuration/authentication-and-user-management/external-idp.md} (100%) rename docs/admin/{30-configuration/30-authentication-and-user-management => configuration/authentication-and-user-management}/index.md (100%) rename docs/admin/{30-configuration/30-authentication-and-user-management/30-keycloak.md => configuration/authentication-and-user-management/keycloak.md} (92%) rename docs/admin/{30-configuration/20-file-picker.md => configuration/file-picker.md} (100%) rename docs/admin/{30-configuration/60-firewall.md => configuration/firewall.md} (100%) rename docs/admin/{30-configuration => configuration}/img/app-store.png (100%) rename docs/admin/{30-configuration => configuration}/img/decomposeds3-with-minio.png (100%) rename docs/admin/{30-configuration => configuration}/img/login-page.png (100%) rename docs/admin/{30-configuration/70-monitoring.md => configuration/monitoring.md} (100%) rename docs/admin/{30-configuration/10-office.md => configuration/office.md} (100%) rename docs/admin/{30-configuration/40-search.md => configuration/search.md} (100%) rename docs/admin/{30-configuration/80-storage => configuration/storage}/_category_.json (100%) rename docs/admin/{30-configuration/80-storage/20-cephfs.md => configuration/storage/cephfs.md} (100%) rename docs/admin/{30-configuration/80-storage/30-decomposeds3.md => configuration/storage/decomposeds3.md} (96%) rename docs/admin/{30-configuration/80-storage/10-posixfs.md => configuration/storage/posixfs.md} (100%) rename docs/admin/{20-getting-started => getting-started}/_category_.json (100%) rename docs/admin/{20-getting-started/20-docker => getting-started/docker}/_category_.json (100%) rename docs/admin/{20-getting-started/20-docker/25-docker-compose-local.md => getting-started/docker/docker-compose-local.md} (97%) rename docs/admin/{20-getting-started/20-docker/20-docker-compose.md => getting-started/docker/docker-compose.md} (99%) rename docs/admin/{20-getting-started/20-docker/30-docker.md => getting-started/docker/docker.md} (96%) rename docs/admin/{20-getting-started => getting-started}/img/bare-metal/cd-opencloud-subdirectory.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/bare-metal/cd-opencloud.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/bare-metal/corepack-enable.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/bare-metal/git-clone.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/bare-metal/install-corepack.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/bare-metal/install-git.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/bare-metal/install-golang.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/bare-metal/install-npm.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/bare-metal/localhost-warnung.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/bare-metal/login.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/bare-metal/opencloud-init.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/bare-metal/opencloud-server.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/docker-compose/certificate-details.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/docker-compose/certificate-viewer.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/docker-compose/login.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/docker-compose/status-secure.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/docker-compose/subordinate-ca's.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/quick-guide/collabora-accept-self-signed-cert.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/quick-guide/docker-opencloud-init.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/quick-guide/quick-docker-compose-up.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/quick-guide/quick-login.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/raspberrypi/change-env-for-storage.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/raspberrypi/docker-compose-check.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/raspberrypi/docker-user-check.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/raspberrypi/error-mounting.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/raspberrypi/find-external-hd.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/raspberrypi/format-drive.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/raspberrypi/ip-router.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/raspberrypi/noip.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/raspberrypi/oc-domain.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/raspberrypi/portforwarding.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/raspberrypi/reachable-via-URL.png (100%) rename docs/admin/{20-getting-started => getting-started}/img/raspberrypi/ssh-activate.png (100%) rename docs/admin/{20-getting-started/80-kubernetes.md => getting-started/kubernetes.md} (100%) rename docs/admin/{20-getting-started/30-other => getting-started/other}/_category_.json (100%) rename docs/admin/{20-getting-started/30-other/40-bare-metal.md => getting-started/other/bare-metal.md} (97%) rename docs/admin/{20-getting-started/30-other/50-raspberry-pi.md => getting-started/other/raspberry-pi.md} (100%) rename docs/admin/{20-getting-started/10-requirements.md => getting-started/requirements.md} (100%) rename docs/admin/{40-maintenance => maintenance}/_category_.json (100%) rename docs/admin/{40-maintenance/20-backup.md => maintenance/backup.md} (100%) rename docs/admin/{40-maintenance => maintenance}/img/generate-pass-nc.png (100%) rename docs/admin/{40-maintenance => maintenance}/img/init-diff.png (100%) rename docs/admin/{40-maintenance/30-migrate.md => maintenance/migrate.md} (100%) rename docs/admin/{40-maintenance/10-upgrade.md => maintenance/upgrade.md} (93%) rename docs/admin/{50-resources => resources}/_category_.json (100%) rename docs/admin/{50-resources/30-common-issues.md => resources/common-issues.md} (100%) rename docs/admin/{50-resources/40-demo-user.md => resources/demo-user.md} (87%) rename docs/admin/{50-resources => resources}/img/common-issues/quick-accept-security-risk.png (100%) rename docs/admin/{50-resources => resources}/img/common-issues/quick-advanced.png (100%) rename docs/admin/{50-resources => resources}/img/common-issues/quick-docker-running.png (100%) rename docs/admin/{50-resources/img/40-demo-user => resources/img/demo-user}/admin.png (100%) rename docs/admin/{50-resources/img/40-demo-user => resources/img/demo-user}/alan-turing.png (100%) rename docs/admin/{50-resources/img/40-demo-user => resources/img/demo-user}/dennis-ritchie.png (100%) rename docs/admin/{50-resources/img/40-demo-user => resources/img/demo-user}/lynn-conway.png (100%) rename docs/admin/{50-resources/img/40-demo-user => resources/img/demo-user}/margaret-hamilton.png (100%) rename docs/admin/{50-resources/img/40-demo-user => resources/img/demo-user}/mary-kenneth-keller.png (100%) rename docs/admin/{50-resources/20-lifecycle.md => resources/lifecycle.md} (100%) rename docs/admin/{50-resources/10-whats-new.md => resources/whats-new.md} (100%) rename docs/admin/{10-welcome => welcome}/_category_.json (100%) rename docs/admin/{10-welcome/30-datasheet.md => welcome/datasheet.md} (100%) rename docs/admin/{10-welcome/10-faq.md => welcome/faq.md} (100%) rename docs/admin/{10-welcome/20-features.md => welcome/features.md} (100%) rename docs/admin/{10-welcome => welcome}/index.md (100%) create mode 100644 docs/dev/server/_category_.json create mode 100644 docs/dev/server/diagrams/_category_.json create mode 100644 docs/dev/server/diagrams/specifications.md create mode 100644 docs/dev/server/index.md create mode 100644 docs/dev/web/_category_.json rename docs/dev/{20-web/20-development => web/development}/_category_.json (100%) rename docs/dev/{20-web/20-development/10-conventions.md => web/development/conventions.md} (97%) rename docs/dev/{20-web/20-development/20-repo-structure.md => web/development/repo-structure.md} (97%) rename docs/dev/{20-web/20-development/30-tooling.md => web/development/tooling.md} (100%) rename docs/dev/{20-web/40-embed-mode => web/embed-mode}/_category_.json (100%) rename docs/dev/{20-web/40-embed-mode => web/embed-mode}/index.md (100%) rename docs/dev/{20-web/50-extension-system => web/extension-system}/_category_.json (100%) rename docs/dev/{20-web/50-extension-system/20-extension-types => web/extension-system/extension-types}/_category_.json (100%) rename docs/dev/{20-web/50-extension-system/20-extension-types/10-action-extensions.md => web/extension-system/extension-types/action-extensions.md} (100%) rename docs/dev/{20-web/50-extension-system/20-extension-types/20-app-menu-item-extensions.md => web/extension-system/extension-types/app-menu-item-extensions.md} (100%) rename docs/dev/{20-web/50-extension-system/20-extension-types/30-custom-component-extensions.md => web/extension-system/extension-types/custom-component-extensions.md} (100%) rename docs/dev/{20-web/50-extension-system/20-extension-types/40-folder-view-extensions.md => web/extension-system/extension-types/folder-view-extensions.md} (100%) rename docs/dev/{20-web/50-extension-system/20-extension-types => web/extension-system/extension-types}/index.md (100%) rename docs/dev/{20-web/50-extension-system/20-extension-types/50-left-sidebar-menu-item-extensions.md => web/extension-system/extension-types/left-sidebar-menu-item-extensions.md} (100%) rename docs/dev/{20-web/50-extension-system/20-extension-types/60-right-sidebar-panel-extensions.md => web/extension-system/extension-types/right-sidebar-panel-extensions.md} (100%) rename docs/dev/{20-web/50-extension-system/20-extension-types/70-search-extensions.md => web/extension-system/extension-types/search-extensions.md} (100%) rename docs/dev/{20-web/50-extension-system => web/extension-system}/index.md (94%) rename docs/dev/{20-web/50-extension-system/10-viewer-editor-apps.md => web/extension-system/viewer-editor-apps.md} (100%) rename docs/dev/{20-web/10-getting-started.md => web/getting-started.md} (99%) rename docs/dev/{20-web => web}/index.md (72%) rename docs/dev/{20-web/30-testing => web/testing}/_category_.json (100%) rename docs/dev/{20-web/30-testing/20-e2e-testing-standards.md => web/testing/e2e-testing-standards.md} (100%) rename docs/dev/{20-web/30-testing/10-running-tests.md => web/testing/running-tests.md} (98%) diff --git a/docs/admin/30-configuration/110-web-applications.md b/docs/admin/configuration/110-web-applications.md similarity index 100% rename from docs/admin/30-configuration/110-web-applications.md rename to docs/admin/configuration/110-web-applications.md diff --git a/docs/admin/30-configuration/_category_.json b/docs/admin/configuration/_category_.json similarity index 100% rename from docs/admin/30-configuration/_category_.json rename to docs/admin/configuration/_category_.json diff --git a/docs/admin/30-configuration/50-antivirus.md b/docs/admin/configuration/antivirus.md similarity index 100% rename from docs/admin/30-configuration/50-antivirus.md rename to docs/admin/configuration/antivirus.md diff --git a/docs/admin/30-configuration/30-authentication-and-user-management/10-external-idp.md b/docs/admin/configuration/authentication-and-user-management/external-idp.md similarity index 100% rename from docs/admin/30-configuration/30-authentication-and-user-management/10-external-idp.md rename to docs/admin/configuration/authentication-and-user-management/external-idp.md diff --git a/docs/admin/30-configuration/30-authentication-and-user-management/index.md b/docs/admin/configuration/authentication-and-user-management/index.md similarity index 100% rename from docs/admin/30-configuration/30-authentication-and-user-management/index.md rename to docs/admin/configuration/authentication-and-user-management/index.md diff --git a/docs/admin/30-configuration/30-authentication-and-user-management/30-keycloak.md b/docs/admin/configuration/authentication-and-user-management/keycloak.md similarity index 92% rename from docs/admin/30-configuration/30-authentication-and-user-management/30-keycloak.md rename to docs/admin/configuration/authentication-and-user-management/keycloak.md index 98cd9b0c..0a42942c 100644 --- a/docs/admin/30-configuration/30-authentication-and-user-management/30-keycloak.md +++ b/docs/admin/configuration/authentication-and-user-management/keycloak.md @@ -46,11 +46,11 @@ GRAPH_USERNAME_MATCH=none OC_EXCLUDE_RUN_SERVICES=idp ``` -Look [here](./10-external-idp.md#opencloud-configuration) for some more details about these settings. +Look [here](./external-idp.md#opencloud-configuration) for some more details about these settings. ## Client Configuration -The [OIDC clients](./10-external-idp.md#client-configuration) required by OpenCloud are pre-configured in the Docker Compose setup and match the clients used by the built-in IdP. +The [OIDC clients](./external-idp.md#client-configuration) required by OpenCloud are pre-configured in the Docker Compose setup and match the clients used by the built-in IdP. ## Advanced Configuration diff --git a/docs/admin/30-configuration/20-file-picker.md b/docs/admin/configuration/file-picker.md similarity index 100% rename from docs/admin/30-configuration/20-file-picker.md rename to docs/admin/configuration/file-picker.md diff --git a/docs/admin/30-configuration/60-firewall.md b/docs/admin/configuration/firewall.md similarity index 100% rename from docs/admin/30-configuration/60-firewall.md rename to docs/admin/configuration/firewall.md diff --git a/docs/admin/30-configuration/img/app-store.png b/docs/admin/configuration/img/app-store.png similarity index 100% rename from docs/admin/30-configuration/img/app-store.png rename to docs/admin/configuration/img/app-store.png diff --git a/docs/admin/30-configuration/img/decomposeds3-with-minio.png b/docs/admin/configuration/img/decomposeds3-with-minio.png similarity index 100% rename from docs/admin/30-configuration/img/decomposeds3-with-minio.png rename to docs/admin/configuration/img/decomposeds3-with-minio.png diff --git a/docs/admin/30-configuration/img/login-page.png b/docs/admin/configuration/img/login-page.png similarity index 100% rename from docs/admin/30-configuration/img/login-page.png rename to docs/admin/configuration/img/login-page.png diff --git a/docs/admin/30-configuration/70-monitoring.md b/docs/admin/configuration/monitoring.md similarity index 100% rename from docs/admin/30-configuration/70-monitoring.md rename to docs/admin/configuration/monitoring.md diff --git a/docs/admin/30-configuration/10-office.md b/docs/admin/configuration/office.md similarity index 100% rename from docs/admin/30-configuration/10-office.md rename to docs/admin/configuration/office.md diff --git a/docs/admin/30-configuration/40-search.md b/docs/admin/configuration/search.md similarity index 100% rename from docs/admin/30-configuration/40-search.md rename to docs/admin/configuration/search.md diff --git a/docs/admin/30-configuration/80-storage/_category_.json b/docs/admin/configuration/storage/_category_.json similarity index 100% rename from docs/admin/30-configuration/80-storage/_category_.json rename to docs/admin/configuration/storage/_category_.json diff --git a/docs/admin/30-configuration/80-storage/20-cephfs.md b/docs/admin/configuration/storage/cephfs.md similarity index 100% rename from docs/admin/30-configuration/80-storage/20-cephfs.md rename to docs/admin/configuration/storage/cephfs.md diff --git a/docs/admin/30-configuration/80-storage/30-decomposeds3.md b/docs/admin/configuration/storage/decomposeds3.md similarity index 96% rename from docs/admin/30-configuration/80-storage/30-decomposeds3.md rename to docs/admin/configuration/storage/decomposeds3.md index b415129c..eee82bba 100644 --- a/docs/admin/30-configuration/80-storage/30-decomposeds3.md +++ b/docs/admin/configuration/storage/decomposeds3.md @@ -77,4 +77,4 @@ Login with your browser: If you encounter any issues or errors, try finding a solution here: -- [Common Issues & Help](../../50-resources/30-common-issues.md) +- [Common Issues & Help](../../resources/common-issues.md) diff --git a/docs/admin/30-configuration/80-storage/10-posixfs.md b/docs/admin/configuration/storage/posixfs.md similarity index 100% rename from docs/admin/30-configuration/80-storage/10-posixfs.md rename to docs/admin/configuration/storage/posixfs.md diff --git a/docs/admin/20-getting-started/_category_.json b/docs/admin/getting-started/_category_.json similarity index 100% rename from docs/admin/20-getting-started/_category_.json rename to docs/admin/getting-started/_category_.json diff --git a/docs/admin/20-getting-started/20-docker/_category_.json b/docs/admin/getting-started/docker/_category_.json similarity index 100% rename from docs/admin/20-getting-started/20-docker/_category_.json rename to docs/admin/getting-started/docker/_category_.json diff --git a/docs/admin/20-getting-started/20-docker/25-docker-compose-local.md b/docs/admin/getting-started/docker/docker-compose-local.md similarity index 97% rename from docs/admin/20-getting-started/20-docker/25-docker-compose-local.md rename to docs/admin/getting-started/docker/docker-compose-local.md index 8802887e..b012e37f 100644 --- a/docs/admin/20-getting-started/20-docker/25-docker-compose-local.md +++ b/docs/admin/getting-started/docker/docker-compose-local.md @@ -82,5 +82,5 @@ Your OpenCloud server is now running and ready to use 🚀 If you encounter any issues or errors, try finding a solution here: -- [Common Issues & Help](./../../50-resources/30-common-issues.md) +- [Common Issues & Help](./../../resources/common-issues.md) diff --git a/docs/admin/20-getting-started/20-docker/20-docker-compose.md b/docs/admin/getting-started/docker/docker-compose.md similarity index 99% rename from docs/admin/20-getting-started/20-docker/20-docker-compose.md rename to docs/admin/getting-started/docker/docker-compose.md index 6e26ea5d..0ef3b03e 100644 --- a/docs/admin/20-getting-started/20-docker/20-docker-compose.md +++ b/docs/admin/getting-started/docker/docker-compose.md @@ -230,7 +230,7 @@ Login with: Admin general ## Troubleshooting -If you encounter any issues, check the [Common Issues & Help](./../../50-resources/30-common-issues.md) +If you encounter any issues, check the [Common Issues & Help](./../../resources/common-issues.md) --- diff --git a/docs/admin/20-getting-started/20-docker/30-docker.md b/docs/admin/getting-started/docker/docker.md similarity index 96% rename from docs/admin/20-getting-started/20-docker/30-docker.md rename to docs/admin/getting-started/docker/docker.md index 08a6b70d..6c927ad1 100644 --- a/docs/admin/20-getting-started/20-docker/30-docker.md +++ b/docs/admin/getting-started/docker/docker.md @@ -98,4 +98,4 @@ Your OpenCloud server is now running and ready to use 🚀 If you encounter any issues or errors, try finding a solution here: -- [Common Issues & Help](./../../50-resources/30-common-issues.md) +- [Common Issues & Help](./../../resources/common-issues.md) diff --git a/docs/admin/20-getting-started/img/bare-metal/cd-opencloud-subdirectory.png b/docs/admin/getting-started/img/bare-metal/cd-opencloud-subdirectory.png similarity index 100% rename from docs/admin/20-getting-started/img/bare-metal/cd-opencloud-subdirectory.png rename to docs/admin/getting-started/img/bare-metal/cd-opencloud-subdirectory.png diff --git a/docs/admin/20-getting-started/img/bare-metal/cd-opencloud.png b/docs/admin/getting-started/img/bare-metal/cd-opencloud.png similarity index 100% rename from docs/admin/20-getting-started/img/bare-metal/cd-opencloud.png rename to docs/admin/getting-started/img/bare-metal/cd-opencloud.png diff --git a/docs/admin/20-getting-started/img/bare-metal/corepack-enable.png b/docs/admin/getting-started/img/bare-metal/corepack-enable.png similarity index 100% rename from docs/admin/20-getting-started/img/bare-metal/corepack-enable.png rename to docs/admin/getting-started/img/bare-metal/corepack-enable.png diff --git a/docs/admin/20-getting-started/img/bare-metal/git-clone.png b/docs/admin/getting-started/img/bare-metal/git-clone.png similarity index 100% rename from docs/admin/20-getting-started/img/bare-metal/git-clone.png rename to docs/admin/getting-started/img/bare-metal/git-clone.png diff --git a/docs/admin/20-getting-started/img/bare-metal/install-corepack.png b/docs/admin/getting-started/img/bare-metal/install-corepack.png similarity index 100% rename from docs/admin/20-getting-started/img/bare-metal/install-corepack.png rename to docs/admin/getting-started/img/bare-metal/install-corepack.png diff --git a/docs/admin/20-getting-started/img/bare-metal/install-git.png b/docs/admin/getting-started/img/bare-metal/install-git.png similarity index 100% rename from docs/admin/20-getting-started/img/bare-metal/install-git.png rename to docs/admin/getting-started/img/bare-metal/install-git.png diff --git a/docs/admin/20-getting-started/img/bare-metal/install-golang.png b/docs/admin/getting-started/img/bare-metal/install-golang.png similarity index 100% rename from docs/admin/20-getting-started/img/bare-metal/install-golang.png rename to docs/admin/getting-started/img/bare-metal/install-golang.png diff --git a/docs/admin/20-getting-started/img/bare-metal/install-npm.png b/docs/admin/getting-started/img/bare-metal/install-npm.png similarity index 100% rename from docs/admin/20-getting-started/img/bare-metal/install-npm.png rename to docs/admin/getting-started/img/bare-metal/install-npm.png diff --git a/docs/admin/20-getting-started/img/bare-metal/localhost-warnung.png b/docs/admin/getting-started/img/bare-metal/localhost-warnung.png similarity index 100% rename from docs/admin/20-getting-started/img/bare-metal/localhost-warnung.png rename to docs/admin/getting-started/img/bare-metal/localhost-warnung.png diff --git a/docs/admin/20-getting-started/img/bare-metal/login.png b/docs/admin/getting-started/img/bare-metal/login.png similarity index 100% rename from docs/admin/20-getting-started/img/bare-metal/login.png rename to docs/admin/getting-started/img/bare-metal/login.png diff --git a/docs/admin/20-getting-started/img/bare-metal/opencloud-init.png b/docs/admin/getting-started/img/bare-metal/opencloud-init.png similarity index 100% rename from docs/admin/20-getting-started/img/bare-metal/opencloud-init.png rename to docs/admin/getting-started/img/bare-metal/opencloud-init.png diff --git a/docs/admin/20-getting-started/img/bare-metal/opencloud-server.png b/docs/admin/getting-started/img/bare-metal/opencloud-server.png similarity index 100% rename from docs/admin/20-getting-started/img/bare-metal/opencloud-server.png rename to docs/admin/getting-started/img/bare-metal/opencloud-server.png diff --git a/docs/admin/20-getting-started/img/docker-compose/certificate-details.png b/docs/admin/getting-started/img/docker-compose/certificate-details.png similarity index 100% rename from docs/admin/20-getting-started/img/docker-compose/certificate-details.png rename to docs/admin/getting-started/img/docker-compose/certificate-details.png diff --git a/docs/admin/20-getting-started/img/docker-compose/certificate-viewer.png b/docs/admin/getting-started/img/docker-compose/certificate-viewer.png similarity index 100% rename from docs/admin/20-getting-started/img/docker-compose/certificate-viewer.png rename to docs/admin/getting-started/img/docker-compose/certificate-viewer.png diff --git a/docs/admin/20-getting-started/img/docker-compose/login.png b/docs/admin/getting-started/img/docker-compose/login.png similarity index 100% rename from docs/admin/20-getting-started/img/docker-compose/login.png rename to docs/admin/getting-started/img/docker-compose/login.png diff --git a/docs/admin/20-getting-started/img/docker-compose/status-secure.png b/docs/admin/getting-started/img/docker-compose/status-secure.png similarity index 100% rename from docs/admin/20-getting-started/img/docker-compose/status-secure.png rename to docs/admin/getting-started/img/docker-compose/status-secure.png diff --git a/docs/admin/20-getting-started/img/docker-compose/subordinate-ca's.png b/docs/admin/getting-started/img/docker-compose/subordinate-ca's.png similarity index 100% rename from docs/admin/20-getting-started/img/docker-compose/subordinate-ca's.png rename to docs/admin/getting-started/img/docker-compose/subordinate-ca's.png diff --git a/docs/admin/20-getting-started/img/quick-guide/collabora-accept-self-signed-cert.png b/docs/admin/getting-started/img/quick-guide/collabora-accept-self-signed-cert.png similarity index 100% rename from docs/admin/20-getting-started/img/quick-guide/collabora-accept-self-signed-cert.png rename to docs/admin/getting-started/img/quick-guide/collabora-accept-self-signed-cert.png diff --git a/docs/admin/20-getting-started/img/quick-guide/docker-opencloud-init.png b/docs/admin/getting-started/img/quick-guide/docker-opencloud-init.png similarity index 100% rename from docs/admin/20-getting-started/img/quick-guide/docker-opencloud-init.png rename to docs/admin/getting-started/img/quick-guide/docker-opencloud-init.png diff --git a/docs/admin/20-getting-started/img/quick-guide/quick-docker-compose-up.png b/docs/admin/getting-started/img/quick-guide/quick-docker-compose-up.png similarity index 100% rename from docs/admin/20-getting-started/img/quick-guide/quick-docker-compose-up.png rename to docs/admin/getting-started/img/quick-guide/quick-docker-compose-up.png diff --git a/docs/admin/20-getting-started/img/quick-guide/quick-login.png b/docs/admin/getting-started/img/quick-guide/quick-login.png similarity index 100% rename from docs/admin/20-getting-started/img/quick-guide/quick-login.png rename to docs/admin/getting-started/img/quick-guide/quick-login.png diff --git a/docs/admin/20-getting-started/img/raspberrypi/change-env-for-storage.png b/docs/admin/getting-started/img/raspberrypi/change-env-for-storage.png similarity index 100% rename from docs/admin/20-getting-started/img/raspberrypi/change-env-for-storage.png rename to docs/admin/getting-started/img/raspberrypi/change-env-for-storage.png diff --git a/docs/admin/20-getting-started/img/raspberrypi/docker-compose-check.png b/docs/admin/getting-started/img/raspberrypi/docker-compose-check.png similarity index 100% rename from docs/admin/20-getting-started/img/raspberrypi/docker-compose-check.png rename to docs/admin/getting-started/img/raspberrypi/docker-compose-check.png diff --git a/docs/admin/20-getting-started/img/raspberrypi/docker-user-check.png b/docs/admin/getting-started/img/raspberrypi/docker-user-check.png similarity index 100% rename from docs/admin/20-getting-started/img/raspberrypi/docker-user-check.png rename to docs/admin/getting-started/img/raspberrypi/docker-user-check.png diff --git a/docs/admin/20-getting-started/img/raspberrypi/error-mounting.png b/docs/admin/getting-started/img/raspberrypi/error-mounting.png similarity index 100% rename from docs/admin/20-getting-started/img/raspberrypi/error-mounting.png rename to docs/admin/getting-started/img/raspberrypi/error-mounting.png diff --git a/docs/admin/20-getting-started/img/raspberrypi/find-external-hd.png b/docs/admin/getting-started/img/raspberrypi/find-external-hd.png similarity index 100% rename from docs/admin/20-getting-started/img/raspberrypi/find-external-hd.png rename to docs/admin/getting-started/img/raspberrypi/find-external-hd.png diff --git a/docs/admin/20-getting-started/img/raspberrypi/format-drive.png b/docs/admin/getting-started/img/raspberrypi/format-drive.png similarity index 100% rename from docs/admin/20-getting-started/img/raspberrypi/format-drive.png rename to docs/admin/getting-started/img/raspberrypi/format-drive.png diff --git a/docs/admin/20-getting-started/img/raspberrypi/ip-router.png b/docs/admin/getting-started/img/raspberrypi/ip-router.png similarity index 100% rename from docs/admin/20-getting-started/img/raspberrypi/ip-router.png rename to docs/admin/getting-started/img/raspberrypi/ip-router.png diff --git a/docs/admin/20-getting-started/img/raspberrypi/noip.png b/docs/admin/getting-started/img/raspberrypi/noip.png similarity index 100% rename from docs/admin/20-getting-started/img/raspberrypi/noip.png rename to docs/admin/getting-started/img/raspberrypi/noip.png diff --git a/docs/admin/20-getting-started/img/raspberrypi/oc-domain.png b/docs/admin/getting-started/img/raspberrypi/oc-domain.png similarity index 100% rename from docs/admin/20-getting-started/img/raspberrypi/oc-domain.png rename to docs/admin/getting-started/img/raspberrypi/oc-domain.png diff --git a/docs/admin/20-getting-started/img/raspberrypi/portforwarding.png b/docs/admin/getting-started/img/raspberrypi/portforwarding.png similarity index 100% rename from docs/admin/20-getting-started/img/raspberrypi/portforwarding.png rename to docs/admin/getting-started/img/raspberrypi/portforwarding.png diff --git a/docs/admin/20-getting-started/img/raspberrypi/reachable-via-URL.png b/docs/admin/getting-started/img/raspberrypi/reachable-via-URL.png similarity index 100% rename from docs/admin/20-getting-started/img/raspberrypi/reachable-via-URL.png rename to docs/admin/getting-started/img/raspberrypi/reachable-via-URL.png diff --git a/docs/admin/20-getting-started/img/raspberrypi/ssh-activate.png b/docs/admin/getting-started/img/raspberrypi/ssh-activate.png similarity index 100% rename from docs/admin/20-getting-started/img/raspberrypi/ssh-activate.png rename to docs/admin/getting-started/img/raspberrypi/ssh-activate.png diff --git a/docs/admin/20-getting-started/80-kubernetes.md b/docs/admin/getting-started/kubernetes.md similarity index 100% rename from docs/admin/20-getting-started/80-kubernetes.md rename to docs/admin/getting-started/kubernetes.md diff --git a/docs/admin/20-getting-started/30-other/_category_.json b/docs/admin/getting-started/other/_category_.json similarity index 100% rename from docs/admin/20-getting-started/30-other/_category_.json rename to docs/admin/getting-started/other/_category_.json diff --git a/docs/admin/20-getting-started/30-other/40-bare-metal.md b/docs/admin/getting-started/other/bare-metal.md similarity index 97% rename from docs/admin/20-getting-started/30-other/40-bare-metal.md rename to docs/admin/getting-started/other/bare-metal.md index 84d24906..3e52c260 100644 --- a/docs/admin/20-getting-started/30-other/40-bare-metal.md +++ b/docs/admin/getting-started/other/bare-metal.md @@ -107,4 +107,4 @@ Your OpenCloud server is now running and ready to use 🚀 --- ### If you encounter any issues or errors, try finding a solution here: -- [Common Issues & Help](./../../50-resources/30-common-issues.md) \ No newline at end of file +- [Common Issues & Help](./../../resources/common-issues.md) \ No newline at end of file diff --git a/docs/admin/20-getting-started/30-other/50-raspberry-pi.md b/docs/admin/getting-started/other/raspberry-pi.md similarity index 100% rename from docs/admin/20-getting-started/30-other/50-raspberry-pi.md rename to docs/admin/getting-started/other/raspberry-pi.md diff --git a/docs/admin/20-getting-started/10-requirements.md b/docs/admin/getting-started/requirements.md similarity index 100% rename from docs/admin/20-getting-started/10-requirements.md rename to docs/admin/getting-started/requirements.md diff --git a/docs/admin/40-maintenance/_category_.json b/docs/admin/maintenance/_category_.json similarity index 100% rename from docs/admin/40-maintenance/_category_.json rename to docs/admin/maintenance/_category_.json diff --git a/docs/admin/40-maintenance/20-backup.md b/docs/admin/maintenance/backup.md similarity index 100% rename from docs/admin/40-maintenance/20-backup.md rename to docs/admin/maintenance/backup.md diff --git a/docs/admin/40-maintenance/img/generate-pass-nc.png b/docs/admin/maintenance/img/generate-pass-nc.png similarity index 100% rename from docs/admin/40-maintenance/img/generate-pass-nc.png rename to docs/admin/maintenance/img/generate-pass-nc.png diff --git a/docs/admin/40-maintenance/img/init-diff.png b/docs/admin/maintenance/img/init-diff.png similarity index 100% rename from docs/admin/40-maintenance/img/init-diff.png rename to docs/admin/maintenance/img/init-diff.png diff --git a/docs/admin/40-maintenance/30-migrate.md b/docs/admin/maintenance/migrate.md similarity index 100% rename from docs/admin/40-maintenance/30-migrate.md rename to docs/admin/maintenance/migrate.md diff --git a/docs/admin/40-maintenance/10-upgrade.md b/docs/admin/maintenance/upgrade.md similarity index 93% rename from docs/admin/40-maintenance/10-upgrade.md rename to docs/admin/maintenance/upgrade.md index 781fbf70..097a289b 100644 --- a/docs/admin/40-maintenance/10-upgrade.md +++ b/docs/admin/maintenance/upgrade.md @@ -8,7 +8,7 @@ description: "🔄 Keep your setup up to date with the latest features!" import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -This guide provides steps to upgrade OpenCloud for both [docker](docs/admin/20-getting-started/20-docker/30-docker.md) and [docker compose](docs/admin/20-getting-started/20-docker/20-docker-compose.md) +This guide provides steps to upgrade OpenCloud for both [docker](docs/admin/getting-started/docker/docker.md) and [docker compose](docs/admin/getting-started/docker/docker-compose.md) ### 1. Stop OpenCloud diff --git a/docs/admin/50-resources/_category_.json b/docs/admin/resources/_category_.json similarity index 100% rename from docs/admin/50-resources/_category_.json rename to docs/admin/resources/_category_.json diff --git a/docs/admin/50-resources/30-common-issues.md b/docs/admin/resources/common-issues.md similarity index 100% rename from docs/admin/50-resources/30-common-issues.md rename to docs/admin/resources/common-issues.md diff --git a/docs/admin/50-resources/40-demo-user.md b/docs/admin/resources/demo-user.md similarity index 87% rename from docs/admin/50-resources/40-demo-user.md rename to docs/admin/resources/demo-user.md index 8869116c..f81533d4 100644 --- a/docs/admin/50-resources/40-demo-user.md +++ b/docs/admin/resources/demo-user.md @@ -27,7 +27,7 @@ Below, you’ll find details about each user, including their roles and login cr #### Role: Admin 📌 **Co-developer of UNIX & inventor of the C programming language** -Dennis Ritchie +Dennis Ritchie - Studied physics and applied mathematics at Harvard University - Worked at Bell Labs from 1967, where he developed the first version of the Unix operating system @@ -40,7 +40,7 @@ Below, you’ll find details about each user, including their roles and login cr #### Role: Space Admin 📌 **Software pioneer & NASA developer** -Margaret Hamilton +Margaret Hamilton - Studied mathematics at Earlham College - Developed the on-board flight software for NASA as a software engineer at MIT @@ -53,7 +53,7 @@ Below, you’ll find details about each user, including their roles and login cr #### Role: User 📌 **Father of modern computer science & codebreaker in the Second World War** -Alan Turing +Alan Turing - British logician, mathematician, and computer scientist - Developed the theoretical foundations of modern computer technology @@ -66,7 +66,7 @@ Below, you’ll find details about each user, including their roles and login cr #### Role: User 📌 Computer scientist & microchip design pioneer -Lynn Conway +Lynn Conway - Studied electrical engineering at Columbia University - Developed VLSI design methodology, revolutionizing microchip development @@ -81,7 +81,7 @@ Below, you’ll find details about each user, including their roles and login cr #### Role: User 📌 **First woman with a PhD in computer science** -Mary Kenneth Keller +Mary Kenneth Keller - Was a nun and studied mathematics (Bachelor & Master of Science) - First woman to work at Dartmouth College's Computer Science Center diff --git a/docs/admin/50-resources/img/common-issues/quick-accept-security-risk.png b/docs/admin/resources/img/common-issues/quick-accept-security-risk.png similarity index 100% rename from docs/admin/50-resources/img/common-issues/quick-accept-security-risk.png rename to docs/admin/resources/img/common-issues/quick-accept-security-risk.png diff --git a/docs/admin/50-resources/img/common-issues/quick-advanced.png b/docs/admin/resources/img/common-issues/quick-advanced.png similarity index 100% rename from docs/admin/50-resources/img/common-issues/quick-advanced.png rename to docs/admin/resources/img/common-issues/quick-advanced.png diff --git a/docs/admin/50-resources/img/common-issues/quick-docker-running.png b/docs/admin/resources/img/common-issues/quick-docker-running.png similarity index 100% rename from docs/admin/50-resources/img/common-issues/quick-docker-running.png rename to docs/admin/resources/img/common-issues/quick-docker-running.png diff --git a/docs/admin/50-resources/img/40-demo-user/admin.png b/docs/admin/resources/img/demo-user/admin.png similarity index 100% rename from docs/admin/50-resources/img/40-demo-user/admin.png rename to docs/admin/resources/img/demo-user/admin.png diff --git a/docs/admin/50-resources/img/40-demo-user/alan-turing.png b/docs/admin/resources/img/demo-user/alan-turing.png similarity index 100% rename from docs/admin/50-resources/img/40-demo-user/alan-turing.png rename to docs/admin/resources/img/demo-user/alan-turing.png diff --git a/docs/admin/50-resources/img/40-demo-user/dennis-ritchie.png b/docs/admin/resources/img/demo-user/dennis-ritchie.png similarity index 100% rename from docs/admin/50-resources/img/40-demo-user/dennis-ritchie.png rename to docs/admin/resources/img/demo-user/dennis-ritchie.png diff --git a/docs/admin/50-resources/img/40-demo-user/lynn-conway.png b/docs/admin/resources/img/demo-user/lynn-conway.png similarity index 100% rename from docs/admin/50-resources/img/40-demo-user/lynn-conway.png rename to docs/admin/resources/img/demo-user/lynn-conway.png diff --git a/docs/admin/50-resources/img/40-demo-user/margaret-hamilton.png b/docs/admin/resources/img/demo-user/margaret-hamilton.png similarity index 100% rename from docs/admin/50-resources/img/40-demo-user/margaret-hamilton.png rename to docs/admin/resources/img/demo-user/margaret-hamilton.png diff --git a/docs/admin/50-resources/img/40-demo-user/mary-kenneth-keller.png b/docs/admin/resources/img/demo-user/mary-kenneth-keller.png similarity index 100% rename from docs/admin/50-resources/img/40-demo-user/mary-kenneth-keller.png rename to docs/admin/resources/img/demo-user/mary-kenneth-keller.png diff --git a/docs/admin/50-resources/20-lifecycle.md b/docs/admin/resources/lifecycle.md similarity index 100% rename from docs/admin/50-resources/20-lifecycle.md rename to docs/admin/resources/lifecycle.md diff --git a/docs/admin/50-resources/10-whats-new.md b/docs/admin/resources/whats-new.md similarity index 100% rename from docs/admin/50-resources/10-whats-new.md rename to docs/admin/resources/whats-new.md diff --git a/docs/admin/10-welcome/_category_.json b/docs/admin/welcome/_category_.json similarity index 100% rename from docs/admin/10-welcome/_category_.json rename to docs/admin/welcome/_category_.json diff --git a/docs/admin/10-welcome/30-datasheet.md b/docs/admin/welcome/datasheet.md similarity index 100% rename from docs/admin/10-welcome/30-datasheet.md rename to docs/admin/welcome/datasheet.md diff --git a/docs/admin/10-welcome/10-faq.md b/docs/admin/welcome/faq.md similarity index 100% rename from docs/admin/10-welcome/10-faq.md rename to docs/admin/welcome/faq.md diff --git a/docs/admin/10-welcome/20-features.md b/docs/admin/welcome/features.md similarity index 100% rename from docs/admin/10-welcome/20-features.md rename to docs/admin/welcome/features.md diff --git a/docs/admin/10-welcome/index.md b/docs/admin/welcome/index.md similarity index 100% rename from docs/admin/10-welcome/index.md rename to docs/admin/welcome/index.md diff --git a/docs/dev/server/_category_.json b/docs/dev/server/_category_.json new file mode 100644 index 00000000..2d1556d7 --- /dev/null +++ b/docs/dev/server/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Server", + "position": 2 +} diff --git a/docs/dev/server/diagrams/_category_.json b/docs/dev/server/diagrams/_category_.json new file mode 100644 index 00000000..8754ed84 --- /dev/null +++ b/docs/dev/server/diagrams/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "Diagrams", + "position": 1, + "link": { + "type": "generated-index", + "description": "\uD83D\uDCC8 Diagrams", + "slug": "dev/server/diagrams" + } +} diff --git a/docs/dev/server/diagrams/specifications.md b/docs/dev/server/diagrams/specifications.md new file mode 100644 index 00000000..01b1ec4b --- /dev/null +++ b/docs/dev/server/diagrams/specifications.md @@ -0,0 +1,27 @@ +--- +title: 'Specifications' +sidebar_position: 1 +--- + +```mermaid +C4Context + Person(user, "User", "A member of the organization") + Person(externalperson, "Guest", "An external user") + + System(opencloud, "OpenCloud", "File sharing and collaboration platform") + System_Ext(idp, "Identity Provider", "OpenID Connect capable identity provider") + + Rel(user, opencloud, "Manages files") + Rel(opencloud, idp, "Authenticates users with") + Rel(externalperson, opencloud, "Manages shared files") + + System(openldap, "OpenLDAP", "An LDAP server") + System(clamav, "ClamAV", "An antivirus engine") + System(mta, "E-Mail Server", "Mail Transfer Agent that sends notifications") + System(storage, "POSIX storage", "POSIX capable storage with notification mechanisms") + + Rel(opencloud, openldap, "Searches recipients in") + Rel(opencloud, clamav, "Scans uploaded files with") + Rel(opencloud, mta, "Sends e-mails via") + Rel(opencloud, storage, "Manages files on") +``` \ No newline at end of file diff --git a/docs/dev/server/index.md b/docs/dev/server/index.md new file mode 100644 index 00000000..0cf54e1c --- /dev/null +++ b/docs/dev/server/index.md @@ -0,0 +1,3 @@ +--- +title: 'Server' +--- diff --git a/docs/dev/web/_category_.json b/docs/dev/web/_category_.json new file mode 100644 index 00000000..8eb4ff33 --- /dev/null +++ b/docs/dev/web/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Web", + "position": 3 +} diff --git a/docs/dev/20-web/20-development/_category_.json b/docs/dev/web/development/_category_.json similarity index 100% rename from docs/dev/20-web/20-development/_category_.json rename to docs/dev/web/development/_category_.json diff --git a/docs/dev/20-web/20-development/10-conventions.md b/docs/dev/web/development/conventions.md similarity index 97% rename from docs/dev/20-web/20-development/10-conventions.md rename to docs/dev/web/development/conventions.md index 76cfa33b..962f853f 100644 --- a/docs/dev/20-web/20-development/10-conventions.md +++ b/docs/dev/web/development/conventions.md @@ -20,7 +20,7 @@ for a suitable one and open a pull request! To make sure your pull request can be efficiently reviewed and won't need a lot of changes down the road, please run the linter and the unit tests via `pnpm lint --fix` and `pnpm test:unit` locally. Our [CI](https://drone.opencloud.eu/opencloud/web) will run on pull requests and report back any problems after that. For a further introduction on how we handle testing, please head to -the [testing docs](./../30-testing/10-running-tests.md). +the [testing docs](./../testing/running-tests.md). ## Code Conventions diff --git a/docs/dev/20-web/20-development/20-repo-structure.md b/docs/dev/web/development/repo-structure.md similarity index 97% rename from docs/dev/20-web/20-development/20-repo-structure.md rename to docs/dev/web/development/repo-structure.md index 14bb7dba..5becb0d8 100644 --- a/docs/dev/20-web/20-development/20-repo-structure.md +++ b/docs/dev/web/development/repo-structure.md @@ -14,7 +14,7 @@ From a developer's perspective, the most important parts of the [OpenCloud Web r The `/dev` folder contains all the configuration files that are needed in the `docker-compose.yml` file. This docker compose stack contains all the backend and testing related infrastructure that is needed for an out-of-the-box usable localhost development setup, -as described in the [tooling section](./../20-development/30-tooling.md). +as described in the [tooling section](./../development/tooling.md). ### packages Folder @@ -29,7 +29,7 @@ Having these packages side by side within the `/packages` folder of the repo is We're using [Playwright](https://playwright.dev) for UI testing. The UI tests are located in `/tests/e2e`. You're more than welcome to make a pull request and adjust this section of the docs accordingly. :-) -You can read more about testing in our [testing section](./../30-testing/10-running-tests.md) +You can read more about testing in our [testing section](./../testing/running-tests.md) ### package.json File @@ -39,7 +39,7 @@ Each package in `/packages` can and most likely will contain another `package.js ### vite.config.ts We're working with [Vite](https://vitejs.dev) as a local development server and build tool. `vite.config.ts` is the main configuration file for that. -You can read more about the usage in our [tooling section](./../20-development/30-tooling.md). +You can read more about the usage in our [tooling section](./../development/tooling.md). ## (Published) Packages diff --git a/docs/dev/20-web/20-development/30-tooling.md b/docs/dev/web/development/tooling.md similarity index 100% rename from docs/dev/20-web/20-development/30-tooling.md rename to docs/dev/web/development/tooling.md diff --git a/docs/dev/20-web/40-embed-mode/_category_.json b/docs/dev/web/embed-mode/_category_.json similarity index 100% rename from docs/dev/20-web/40-embed-mode/_category_.json rename to docs/dev/web/embed-mode/_category_.json diff --git a/docs/dev/20-web/40-embed-mode/index.md b/docs/dev/web/embed-mode/index.md similarity index 100% rename from docs/dev/20-web/40-embed-mode/index.md rename to docs/dev/web/embed-mode/index.md diff --git a/docs/dev/20-web/50-extension-system/_category_.json b/docs/dev/web/extension-system/_category_.json similarity index 100% rename from docs/dev/20-web/50-extension-system/_category_.json rename to docs/dev/web/extension-system/_category_.json diff --git a/docs/dev/20-web/50-extension-system/20-extension-types/_category_.json b/docs/dev/web/extension-system/extension-types/_category_.json similarity index 100% rename from docs/dev/20-web/50-extension-system/20-extension-types/_category_.json rename to docs/dev/web/extension-system/extension-types/_category_.json diff --git a/docs/dev/20-web/50-extension-system/20-extension-types/10-action-extensions.md b/docs/dev/web/extension-system/extension-types/action-extensions.md similarity index 100% rename from docs/dev/20-web/50-extension-system/20-extension-types/10-action-extensions.md rename to docs/dev/web/extension-system/extension-types/action-extensions.md diff --git a/docs/dev/20-web/50-extension-system/20-extension-types/20-app-menu-item-extensions.md b/docs/dev/web/extension-system/extension-types/app-menu-item-extensions.md similarity index 100% rename from docs/dev/20-web/50-extension-system/20-extension-types/20-app-menu-item-extensions.md rename to docs/dev/web/extension-system/extension-types/app-menu-item-extensions.md diff --git a/docs/dev/20-web/50-extension-system/20-extension-types/30-custom-component-extensions.md b/docs/dev/web/extension-system/extension-types/custom-component-extensions.md similarity index 100% rename from docs/dev/20-web/50-extension-system/20-extension-types/30-custom-component-extensions.md rename to docs/dev/web/extension-system/extension-types/custom-component-extensions.md diff --git a/docs/dev/20-web/50-extension-system/20-extension-types/40-folder-view-extensions.md b/docs/dev/web/extension-system/extension-types/folder-view-extensions.md similarity index 100% rename from docs/dev/20-web/50-extension-system/20-extension-types/40-folder-view-extensions.md rename to docs/dev/web/extension-system/extension-types/folder-view-extensions.md diff --git a/docs/dev/20-web/50-extension-system/20-extension-types/index.md b/docs/dev/web/extension-system/extension-types/index.md similarity index 100% rename from docs/dev/20-web/50-extension-system/20-extension-types/index.md rename to docs/dev/web/extension-system/extension-types/index.md diff --git a/docs/dev/20-web/50-extension-system/20-extension-types/50-left-sidebar-menu-item-extensions.md b/docs/dev/web/extension-system/extension-types/left-sidebar-menu-item-extensions.md similarity index 100% rename from docs/dev/20-web/50-extension-system/20-extension-types/50-left-sidebar-menu-item-extensions.md rename to docs/dev/web/extension-system/extension-types/left-sidebar-menu-item-extensions.md diff --git a/docs/dev/20-web/50-extension-system/20-extension-types/60-right-sidebar-panel-extensions.md b/docs/dev/web/extension-system/extension-types/right-sidebar-panel-extensions.md similarity index 100% rename from docs/dev/20-web/50-extension-system/20-extension-types/60-right-sidebar-panel-extensions.md rename to docs/dev/web/extension-system/extension-types/right-sidebar-panel-extensions.md diff --git a/docs/dev/20-web/50-extension-system/20-extension-types/70-search-extensions.md b/docs/dev/web/extension-system/extension-types/search-extensions.md similarity index 100% rename from docs/dev/20-web/50-extension-system/20-extension-types/70-search-extensions.md rename to docs/dev/web/extension-system/extension-types/search-extensions.md diff --git a/docs/dev/20-web/50-extension-system/index.md b/docs/dev/web/extension-system/index.md similarity index 94% rename from docs/dev/20-web/50-extension-system/index.md rename to docs/dev/web/extension-system/index.md index a5d4341c..f3682052 100644 --- a/docs/dev/20-web/50-extension-system/index.md +++ b/docs/dev/web/extension-system/index.md @@ -85,7 +85,7 @@ By defining an application via `defineWebApplication` you can provide the follow - `routes` - the routes to the different views of your application. May be referenced within the `navItems`. Authentication requirements can be defined per item. - `extensions` - the extensions to be registered in the extension registry. For more details see the `Extensions` section below. -If you want to learn how to implement an app for viewing and editing specific file types, please consult the [relevant documentation](./10-viewer-editor-apps.md) for detailed instructions and guidance. +If you want to learn how to implement an app for viewing and editing specific file types, please consult the [relevant documentation](./viewer-editor-apps.md) for detailed instructions and guidance. To learn how to integrate an app into OpenCloud Web, please refer to the "Web Apps" section of the Web service docs ("Services" > "Web"). @@ -106,15 +106,15 @@ and most prominently also in the `files` app we have defined some extension poin For building an extension you can choose from the types predefined by the OpenCloud Web extension system. See the full list of available extension types below. 1. `ActionExtension` (type `action`) - An extension that can register `Action` items which then get shown in various places (e.g. context menus, batch actions), depending on the - extension points referenced in the extension respectively. Most commonly used for file and folder actions (e.g. copy, rename, delete, etc.). For details, please refer to the [action docs](./20-extension-types/10-action-extensions.md) -2. `SearchExtension` (type `search`) - An extension that can register additional search providers. For details, please refer to the [search docs](./20-extension-types/70-search-extensions.md). + extension points referenced in the extension respectively. Most commonly used for file and folder actions (e.g. copy, rename, delete, etc.). For details, please refer to the [action docs](./extension-types/action-extensions.md) +2. `SearchExtension` (type `search`) - An extension that can register additional search providers. For details, please refer to the [search docs](./extension-types/search-extensions.md). 3. `SidebarNavExtension` (type `sidebarNav`) - An extension that can register additional navigation items for the left sidebar. These can be scoped to specific apps, and programmatically enabled/disabled. - For details, please refer to the [sidebar nav docs](./20-extension-types/50-left-sidebar-menu-item-extensions.md). -4. `SidebarPanelExtension`, (type `sidebarPanel`) - An extension that can register panels for the right sidebar. For details, please refer to the [sidebar panel docs](./20-extension-types/60-right-sidebar-panel-extensions.md). + For details, please refer to the [sidebar nav docs](./extension-types/left-sidebar-menu-item-extensions.md). +4. `SidebarPanelExtension`, (type `sidebarPanel`) - An extension that can register panels for the right sidebar. For details, please refer to the [sidebar panel docs](./extension-types/right-sidebar-panel-extensions.md). 5. `FolderViewExtension` (type `folderView`) - An extension that can register additional ways of displaying the content of a folder (resources like spaces, folders or files) to the user. - For details, please refer to the [folder view docs](./20-extension-types/40-folder-view-extensions.md). + For details, please refer to the [folder view docs](./extension-types/folder-view-extensions.md). 6. `CustomComponentExtension` (type `customComponent`) - An extension that can register a custom component for a render target. For details, please refer to the - [custom component docs](./20-extension-types/30-custom-component-extensions.md) + [custom component docs](./extension-types/custom-component-extensions.md) You're free to introduce your own extension types within your application code and use the extension registry to query the available ones. However, if you have the impression that an important extension type is missing and would be beneficial for the platform, please reach out to us by opening a [GitHub issue](https://github.com/opencloud-eu/web/issues/new/choose). diff --git a/docs/dev/20-web/50-extension-system/10-viewer-editor-apps.md b/docs/dev/web/extension-system/viewer-editor-apps.md similarity index 100% rename from docs/dev/20-web/50-extension-system/10-viewer-editor-apps.md rename to docs/dev/web/extension-system/viewer-editor-apps.md diff --git a/docs/dev/20-web/10-getting-started.md b/docs/dev/web/getting-started.md similarity index 99% rename from docs/dev/20-web/10-getting-started.md rename to docs/dev/web/getting-started.md index f3a11d03..d2cd55c6 100644 --- a/docs/dev/20-web/10-getting-started.md +++ b/docs/dev/web/getting-started.md @@ -27,7 +27,7 @@ Then, you can start the server by running `docker-compose up opencloud` and acce The bundled frontend code automatically gets mounted into the Docker containers, recompiles on changes and you can log in using the demo user (admin/admin) and take a look around! -For more details on how to set up Web for development, please see [tooling](./20-development/30-tooling.md). +For more details on how to set up Web for development, please see [tooling](./development/tooling.md). ## Source Code diff --git a/docs/dev/20-web/index.md b/docs/dev/web/index.md similarity index 72% rename from docs/dev/20-web/index.md rename to docs/dev/web/index.md index 228589f5..c29fad6e 100644 --- a/docs/dev/20-web/index.md +++ b/docs/dev/web/index.md @@ -3,4 +3,4 @@ title: 'Web UI' --- This is the next generation OpenCloud frontend. -If you're new here, head over to the the [getting started guide](./10-getting-started.md) for a quick introduction. +If you're new here, head over to the the [getting started guide](./getting-started.md) for a quick introduction. diff --git a/docs/dev/20-web/30-testing/_category_.json b/docs/dev/web/testing/_category_.json similarity index 100% rename from docs/dev/20-web/30-testing/_category_.json rename to docs/dev/web/testing/_category_.json diff --git a/docs/dev/20-web/30-testing/20-e2e-testing-standards.md b/docs/dev/web/testing/e2e-testing-standards.md similarity index 100% rename from docs/dev/20-web/30-testing/20-e2e-testing-standards.md rename to docs/dev/web/testing/e2e-testing-standards.md diff --git a/docs/dev/20-web/30-testing/10-running-tests.md b/docs/dev/web/testing/running-tests.md similarity index 98% rename from docs/dev/20-web/30-testing/10-running-tests.md rename to docs/dev/web/testing/running-tests.md index 37e903f2..03154dd7 100644 --- a/docs/dev/20-web/30-testing/10-running-tests.md +++ b/docs/dev/web/testing/running-tests.md @@ -48,7 +48,7 @@ which makes it easy to write tests, debug them and have them run cross-browser w #### Preparation -Please make sure you have installed all dependencies and started the server(s) as described in [tooling](./../20-development/30-tooling.md). +Please make sure you have installed all dependencies and started the server(s) as described in [tooling](./../development/tooling.md). #### Prepare & Start Web From 7b1b911028606ad4ca585ccafd4a56db530d5d1f Mon Sep 17 00:00:00 2001 From: Alex Ackermann Date: Tue, 15 Apr 2025 18:08:57 +0200 Subject: [PATCH 2/3] rm additional files --- docs/dev/20-web/_category_.json | 4 ---- docs/dev/server/_category_.json | 4 ---- docs/dev/server/diagrams/_category_.json | 9 -------- docs/dev/server/diagrams/specifications.md | 27 ---------------------- docs/dev/server/index.md | 3 --- 5 files changed, 47 deletions(-) delete mode 100644 docs/dev/20-web/_category_.json delete mode 100644 docs/dev/server/_category_.json delete mode 100644 docs/dev/server/diagrams/_category_.json delete mode 100644 docs/dev/server/diagrams/specifications.md delete mode 100644 docs/dev/server/index.md diff --git a/docs/dev/20-web/_category_.json b/docs/dev/20-web/_category_.json deleted file mode 100644 index 33d0f935..00000000 --- a/docs/dev/20-web/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Web", - "position": 2 -} diff --git a/docs/dev/server/_category_.json b/docs/dev/server/_category_.json deleted file mode 100644 index 2d1556d7..00000000 --- a/docs/dev/server/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Server", - "position": 2 -} diff --git a/docs/dev/server/diagrams/_category_.json b/docs/dev/server/diagrams/_category_.json deleted file mode 100644 index 8754ed84..00000000 --- a/docs/dev/server/diagrams/_category_.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "label": "Diagrams", - "position": 1, - "link": { - "type": "generated-index", - "description": "\uD83D\uDCC8 Diagrams", - "slug": "dev/server/diagrams" - } -} diff --git a/docs/dev/server/diagrams/specifications.md b/docs/dev/server/diagrams/specifications.md deleted file mode 100644 index 01b1ec4b..00000000 --- a/docs/dev/server/diagrams/specifications.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: 'Specifications' -sidebar_position: 1 ---- - -```mermaid -C4Context - Person(user, "User", "A member of the organization") - Person(externalperson, "Guest", "An external user") - - System(opencloud, "OpenCloud", "File sharing and collaboration platform") - System_Ext(idp, "Identity Provider", "OpenID Connect capable identity provider") - - Rel(user, opencloud, "Manages files") - Rel(opencloud, idp, "Authenticates users with") - Rel(externalperson, opencloud, "Manages shared files") - - System(openldap, "OpenLDAP", "An LDAP server") - System(clamav, "ClamAV", "An antivirus engine") - System(mta, "E-Mail Server", "Mail Transfer Agent that sends notifications") - System(storage, "POSIX storage", "POSIX capable storage with notification mechanisms") - - Rel(opencloud, openldap, "Searches recipients in") - Rel(opencloud, clamav, "Scans uploaded files with") - Rel(opencloud, mta, "Sends e-mails via") - Rel(opencloud, storage, "Manages files on") -``` \ No newline at end of file diff --git a/docs/dev/server/index.md b/docs/dev/server/index.md deleted file mode 100644 index 0cf54e1c..00000000 --- a/docs/dev/server/index.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: 'Server' ---- From d13d15b0e3e9d72b4867572917406d0bc7cc830f Mon Sep 17 00:00:00 2001 From: Alex Ackermann Date: Tue, 15 Apr 2025 18:10:34 +0200 Subject: [PATCH 3/3] fix --- .../{110-web-applications.md => web-applications.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/admin/configuration/{110-web-applications.md => web-applications.md} (100%) diff --git a/docs/admin/configuration/110-web-applications.md b/docs/admin/configuration/web-applications.md similarity index 100% rename from docs/admin/configuration/110-web-applications.md rename to docs/admin/configuration/web-applications.md