diff --git a/docs/ops/deploy_instance.md b/docs/admin/deploy_instance.md similarity index 100% rename from docs/ops/deploy_instance.md rename to docs/admin/deploy_instance.md diff --git a/docs/admin/explanations/index.md b/docs/admin/explanations/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/admin/how-to/index.md b/docs/admin/how-to/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/ops/manage_dependencies.md b/docs/admin/manage_dependencies.md similarity index 100% rename from docs/ops/manage_dependencies.md rename to docs/admin/manage_dependencies.md diff --git a/docs/ops/manage_release.md b/docs/admin/manage_release.md similarity index 100% rename from docs/ops/manage_release.md rename to docs/admin/manage_release.md diff --git a/docs/admin/reference/index.md b/docs/admin/reference/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/admin/tutorials/index.md b/docs/admin/tutorials/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/dev/explanations/index.md b/docs/dev/explanations/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/developer/create_application.md b/docs/dev/how-to/create_application.md similarity index 96% rename from docs/developer/create_application.md rename to docs/dev/how-to/create_application.md index 52b552b6..0b23ac46 100644 --- a/docs/developer/create_application.md +++ b/docs/dev/how-to/create_application.md @@ -22,4 +22,4 @@ The code of your app should be in `packages/diracx-web-components/src/components In order to be compatible with the share and import buttons, the application must write its state to the session storage at `_State`. This slot is read from and written to by the corresponding functions. -💡You can look at `JobMonitor` as an example. \ No newline at end of file +💡You can look at `JobMonitor` as an example. diff --git a/docs/dev/how-to/index.md b/docs/dev/how-to/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/developer/manage_extension.md b/docs/dev/manage_extension.md similarity index 100% rename from docs/developer/manage_extension.md rename to docs/dev/manage_extension.md diff --git a/docs/dev/reference/index.md b/docs/dev/reference/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/developer/setup_environment.md b/docs/dev/setup_environment.md similarity index 100% rename from docs/developer/setup_environment.md rename to docs/dev/setup_environment.md diff --git a/docs/dev/tutorials/index.md b/docs/dev/tutorials/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/developer/index.md b/docs/dev/web-arch.md similarity index 100% rename from docs/developer/index.md rename to docs/dev/web-arch.md diff --git a/docs/ops/index.md b/docs/ops/index.md deleted file mode 100644 index af816531..00000000 --- a/docs/ops/index.md +++ /dev/null @@ -1,60 +0,0 @@ -# Administrator Guide - -Welcome to the DiracX-Web Administrator Guide! This comprehensive resource is designed to assist you in effectively managing, deploying, and maintaining the DiracX-Web repository. Whether you're overseeing releases, handling dependencies, or configuring the system, this guide provides the necessary insights and instructions. - -The following graph gives you an overview of the [Github Action Workflows](../../.github/workflows/): - -```mermaid ---- -config: - layout: elk ---- -flowchart TD - subgraph basic-checks["Basic Checks"] - checks["Linting and Commit format checking"] - end - subgraph lib-test["DiracX-Web-Components Tests"] - unit-tests["Unit Tests"] - end - subgraph diracx-web-test["DiracX-Web Tests"] - integration-tests["Integration Tests"] - end - subgraph gubbins-test["Extensions[Gubbins] Tests"] - lint["Linting"] - standalone["Prepare Gubbins as a standalone"] - ext-docker["Build docker dev image"] - ext-integration-tests["Integration Tests"] - end - subgraph deployment["Deployment"] - main:release-please["Release Please: Create/Update PR"] - rel:release-please["Release Please: Push tags & releases"] - main:build-deploy-lib["Build diracx-web-components"] - docker-dev["Build & Push dev image"] - storybook["Build Storybook"] - rel:deploy-storybook["Deploy Storybook"] - rel:build-deploy-lib["Publish diracx-web-components on NPM"] - rel:docker-release["Push release image"] - end - standalone -- is needed for --> ext-docker & ext-integration-tests - basic-checks ~~~ lib-test - lib-test ~~~ diracx-web-test & gubbins-test - diracx-web-test ~~~ deployment - gubbins-test ~~~ deployment - main:release-please -- is needed for --> main:build-deploy-lib - rel:release-please -- is needed for --> rel:build-deploy-lib & rel:deploy-storybook & rel:docker-release - storybook -- is needed for --> rel:deploy-storybook - main:build-deploy-lib -- is needed for --> rel:build-deploy-lib - rel:release-please:::Rose - rel:deploy-storybook:::Rose - rel:build-deploy-lib:::Rose - rel:docker-release:::Rose - classDef Rose stroke-width:1px, stroke-dasharray:none, stroke:#FF5978, fill:#FFDFE5, color:#8E2236 - -``` - - -## Content - -- [Deploy DiracX-Web](./deploy_instance.md) -- [Manage dependencies](./manage_dependencies.md) -- [Manage releases](./manage_release.md) \ No newline at end of file diff --git a/docs/user/explanations/index.md b/docs/user/explanations/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/user/how-to/index.md b/docs/user/how-to/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/user/index.md b/docs/user/index.md deleted file mode 100644 index d8e8fb47..00000000 --- a/docs/user/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# User Guide - -Welcome to the DiracX-Web User Guide! This guide will help you navigate and make the most of the DiracX-Web application. Whether you are logging in for the first time, or managing various application instances, this guide provides step-by-step instructions to simplify your experience. - -## Content - -- [How to Log In and Log Out?](login_out.md) -- [How to Interact with my Jobs?](monitor_jobs.md) -- [How to Manage various Application Instances and share them?](list_and_share_applications.md) diff --git a/docs/user/reference/index.md b/docs/user/reference/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/user/tutorials/index.md b/docs/user/tutorials/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/user/web/index.md b/docs/user/web/index.md new file mode 100644 index 00000000..ea2d95d0 --- /dev/null +++ b/docs/user/web/index.md @@ -0,0 +1 @@ +# DiracX Web diff --git a/docs/user/list_and_share_applications.md b/docs/user/web/list_and_share_applications.md similarity index 100% rename from docs/user/list_and_share_applications.md rename to docs/user/web/list_and_share_applications.md diff --git a/docs/user/login_out.md b/docs/user/web/login_out.md similarity index 99% rename from docs/user/login_out.md rename to docs/user/web/login_out.md index 559c8ed1..1c8fab94 100644 --- a/docs/user/login_out.md +++ b/docs/user/web/login_out.md @@ -1,6 +1,7 @@ # Logging in & out ## Basics + ### Logging in 1. Go to the DiracX-Web instance homepage. diff --git a/docs/user/monitor_jobs.md b/docs/user/web/monitor_jobs.md similarity index 100% rename from docs/user/monitor_jobs.md rename to docs/user/web/monitor_jobs.md