From 90d97a514990d359c3d4d2c2d4cea294501c0c39 Mon Sep 17 00:00:00 2001 From: leorossi Date: Fri, 4 Oct 2024 09:20:03 +0000 Subject: [PATCH] [automated commit] Bump docs to versions 2.4.0, 1.53.3 --- .../{version-2.2.1 => version-2.4.0}/FAQs.md | 0 .../Overview.md | 0 .../{version-2.2.1 => version-2.4.0}/cli.md | 0 .../client/frontend.md | 0 .../client/overview.md | 0 .../client/programmatic.md | 0 .../composer/api-modification.md | 0 .../composer/configuration.md | 75 ++++++++------ .../composer/overview.md | 0 .../composer/plugin.md | 0 .../composer/programmatic.md | 0 .../contributing/contributing.md | 0 .../contributing/documentation-style-guide.md | 0 .../db/authorization/images/http.png | Bin .../db/authorization/images/jwt.png | Bin .../images/sources/http.excalidraw | 0 .../images/sources/jwt.excalidraw | 0 .../images/sources/webhook.excalidraw | 0 .../db/authorization/images/webhook.png | Bin .../db/authorization/overview.md | 0 .../db/authorization/rules.md | 0 .../db/authorization/strategies.md | 0 .../db/authorization/user-roles-metadata.md | 0 .../db/configuration.md | 1 + .../db/logging.md | 0 .../db/migrations.md | 0 .../db/overview.md | 0 .../db/plugin.md | 0 .../db/programmatic.md | 0 .../db/schema-support.md | 0 .../file-formats.md | 0 .../getting-started/issues.md | 0 .../new-api-project-instructions.md | 0 .../platformatic-architecture.png | Bin .../platformatic-composer-architecture.png | Bin .../platformatic-db-architecture.png | Bin .../platformatic-runtime-architecture.png | Bin .../platformatic-stackables-architecture.png | Bin ...tformatid-composer-architecture.excalidraw | 0 .../platformatid-db-architecture.excalidraw | 0 ...atformatid-runtime-architecture.excalidraw | 0 ...ormatid-stackables-architecture.excalidraw | 0 .../getting-started/quick-start-guide.md | 6 +- .../getting-started/quick-start-watt.md | 8 +- .../extend-graphql.md | 0 .../add-custom-functionality/extend-rest.md | 0 .../add-custom-functionality/overview.md | 0 .../add-custom-functionality/prerequisites.md | 0 .../add-custom-functionality/raw-sql.md | 0 .../architecture-diagram.excalidraw | 0 .../architecture-diagram.png | Bin .../create-a-static-app-workspace-01.png | Bin .../create-a-static-app-workspace-02.png | Bin .../create-an-app-on-platformati-cloud-01.png | Bin ...omposed-media-service-api-read-only-01.png | Bin .../start-the-runtime-app-01.png | Bin .../test-the-books-service-api-01.png | Bin ...test-the-composed-media-service-api-01.png | Bin .../test-the-movies-service-api-01.png | Bin .../test-the-people-service-01.png | Bin .../guides/build-modular-monolith.md | 0 .../compiling-typescript-for-deployment.md | 0 .../guides/debug-platformatic-db.md | 0 .../guides/deploying-on-lambda.md | 0 .../deployment/advanced-fly-io-deployment.md | 0 .../deploy-to-fly-io-with-sqlite.md | 0 .../guides/deployment/overview.md | 0 .../guides/dockerize-platformatic-app.md | 0 .../guides/environment-variables.md | 0 ...d-code-to-consume-platformatic-rest-api.md | 0 .../guides/images/frontend-screenshot-1.jpg | Bin .../guides/images/frontend-screenshot-2.jpg | Bin .../guides/images/frontend-screenshot-3.jpg | Bin .../guides/images/frontend-screenshot-4.jpg | Bin .../guides/images/kibana-1.png | Bin .../guides/images/kibana-2.png | Bin .../guides/images/kibana-3.png | Bin .../guides/images/kibana-4.png | Bin .../guides/jwt-auth0.md | 0 .../guides/jwt-keycloak.md | 0 .../assign_service_account_roles.png | Bin .../keycloak-images/client_credentials.png | Bin .../guides/keycloak-images/create_client.png | Bin .../keycloak-images/create_client_2.png | Bin .../keycloak-images/create_client_3.png | Bin .../keycloak-images/create_client_4.png | Bin .../keycloak-images/create_platformatic.png | Bin .../guides/keycloak-images/create_realm.png | Bin .../guides/keycloak-images/create_realm_2.png | Bin .../keycloak-images/create_realm_role.png | Bin .../guides/keycloak-images/plt_auth.png | Bin .../guides/keycloak-images/plt_start.png | Bin .../guides/keycloak-images/plt_unauth.png | Bin .../guides/logging-to-elasticsearch.md | 0 ...ing-express-app-to-platformatic-service.md | 0 ...ing-fastify-app-to-platformatic-service.md | 0 .../guides/monitoring.md | 0 .../guides/movie-quotes-app-tutorial.md | 0 .../guides/prisma.md | 0 .../guides/runtime-cli-managing.md | 0 .../guides/securing-platformatic-db.md | 0 .../guides/seed-a-database.md | 0 .../telemetry-images/compose-openapi.png | Bin .../guides/telemetry-images/jaeger-1.png | Bin .../guides/telemetry-images/jaeger-2.png | Bin .../guides/telemetry-images/jaeger-3.png | Bin .../guides/telemetry.md | 0 .../guides/use-env-with-platformatic.md | 0 .../images/ENV_Var_Platforamtic.png | Bin ...formatic_Composer_Diagram_(Light_Mode).png | Bin .../Platformatic_DB_Diagram_(Light_Mode).png | Bin ...tformatic_Runtime_Diagram_(Light_Mode).png | Bin ...tformatic_Service_Diagram_(Light_Mode).png | Bin ...rmatic_Stackables_Diagram_(Light_Mode).png | Bin ...tformatic_Composer_Diagram_(Dark_Mode).png | Bin .../Platformatic_DB_Diagram_(Dark_Mode).png | Bin ...atformatic_Runtime_Diagram_(Dark_Mode).png | Bin ...atformatic_Service_Diagram_(Dark_Mode).png | Bin ...ormatic_Stackables_Diagram_(Dark_Mode).png | Bin .../learn/beginner/crud-application.md | 0 .../learn/glossary.md | 0 .../learn/images/plt-endpoints.png | Bin .../learn/images/plt-localhost.png | Bin .../learn/images/test-endpoint.png | Bin .../learn/overview.md | 0 .../packages/astro/configuration.md | 33 +++++++ .../version-2.4.0/packages/astro/overview.md | 49 ++++++++++ .../packages/errors.md | 0 .../packages/next/configuration.md | 33 +++++++ .../version-2.4.0/packages/next/overview.md | 45 +++++++++ .../packages/node/configuration.md | 40 ++++++++ .../version-2.4.0/packages/node/overview.md | 92 ++++++++++++++++++ .../packages/remix/configuration.md | 16 +++ .../version-2.4.0/packages/remix/overview.md | 49 ++++++++++ .../packages/sql-events/fastify-plugin.md | 0 .../packages/sql-events/overview.md | 0 .../sql-graphql/examples/deleteEntity.js | 0 .../sql-graphql/examples/insertEntity.js | 0 .../packages/sql-graphql/examples/query.js | 0 .../sql-graphql/examples/saveEntity.js | 0 .../packages/sql-graphql/ignore.md | 0 .../packages/sql-graphql/many-to-many.md | 0 .../packages/sql-graphql/mutations.md | 0 .../packages/sql-graphql/overview.md | 0 .../packages/sql-graphql/queries.md | 0 .../packages/sql-graphql/subscriptions.md | 0 .../packages/sql-mapper/entities/api.md | 0 .../packages/sql-mapper/entities/example.md | 0 .../packages/sql-mapper/entities/fields.md | 0 .../packages/sql-mapper/entities/hooks.md | 0 .../packages/sql-mapper/entities/overview.md | 0 .../packages/sql-mapper/entities/relations.md | 0 .../sql-mapper/entities/timestamps.md | 0 .../sql-mapper/entities/transactions.md | 0 .../packages/sql-mapper/examples/count.js | 0 .../packages/sql-mapper/examples/delete.js | 0 .../sql-mapper/examples/fastify-plugin.js | 0 .../packages/sql-mapper/examples/fields.js | 0 .../packages/sql-mapper/examples/find.js | 0 .../packages/sql-mapper/examples/hooks.js | 0 .../packages/sql-mapper/examples/insert.js | 0 .../packages/sql-mapper/examples/relations.js | 0 .../packages/sql-mapper/examples/save.js | 0 .../packages/sql-mapper/fastify-plugin.md | 0 .../sql-mapper/images/plt-db-hooks.svg | 0 .../packages/sql-mapper/overview.md | 0 .../packages/sql-openapi/api.md | 0 .../packages/sql-openapi/explicit-include.md | 0 .../packages/sql-openapi/ignore.md | 0 .../packages/sql-openapi/overview.md | 0 .../packages/vite/configuration.md | 45 +++++++++ .../version-2.4.0/packages/vite/overview.md | 51 ++++++++++ .../runtime/configuration.md | 0 .../runtime/overview.md | 0 .../runtime/programmatic.md | 0 .../service/configuration.md | 6 ++ .../service/overview.md | 0 .../service/plugin.md | 0 .../service/programmatic.md | 0 .../watt/overview.md | 0 .../watt/reference.md | 0 ...ebars.json => version-2.4.0-sidebars.json} | 36 +++++++ versions.json | 2 +- 183 files changed, 550 insertions(+), 37 deletions(-) rename versioned_docs/{version-2.2.1 => version-2.4.0}/FAQs.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/Overview.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/cli.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/client/frontend.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/client/overview.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/client/programmatic.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/composer/api-modification.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/composer/configuration.md (84%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/composer/overview.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/composer/plugin.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/composer/programmatic.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/contributing/contributing.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/contributing/documentation-style-guide.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/authorization/images/http.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/authorization/images/jwt.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/authorization/images/sources/http.excalidraw (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/authorization/images/sources/jwt.excalidraw (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/authorization/images/sources/webhook.excalidraw (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/authorization/images/webhook.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/authorization/overview.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/authorization/rules.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/authorization/strategies.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/authorization/user-roles-metadata.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/configuration.md (99%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/logging.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/migrations.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/overview.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/plugin.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/programmatic.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/db/schema-support.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/file-formats.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/getting-started/issues.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/getting-started/new-api-project-instructions.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/getting-started/platformatic-architecture.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/getting-started/platformatic-composer-architecture.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/getting-started/platformatic-db-architecture.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/getting-started/platformatic-runtime-architecture.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/getting-started/platformatic-stackables-architecture.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/getting-started/platformatid-composer-architecture.excalidraw (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/getting-started/platformatid-db-architecture.excalidraw (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/getting-started/platformatid-runtime-architecture.excalidraw (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/getting-started/platformatid-stackables-architecture.excalidraw (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/getting-started/quick-start-guide.md (94%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/getting-started/quick-start-watt.md (98%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/add-custom-functionality/extend-graphql.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/add-custom-functionality/extend-rest.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/add-custom-functionality/overview.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/add-custom-functionality/prerequisites.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/add-custom-functionality/raw-sql.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/build-modular-monolith-images/architecture-diagram.excalidraw (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/build-modular-monolith-images/architecture-diagram.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/build-modular-monolith-images/create-a-static-app-workspace-01.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/build-modular-monolith-images/create-a-static-app-workspace-02.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/build-modular-monolith-images/create-an-app-on-platformati-cloud-01.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/build-modular-monolith-images/make-the-composed-media-service-api-read-only-01.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/build-modular-monolith-images/start-the-runtime-app-01.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/build-modular-monolith-images/test-the-books-service-api-01.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/build-modular-monolith-images/test-the-composed-media-service-api-01.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/build-modular-monolith-images/test-the-movies-service-api-01.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/build-modular-monolith-images/test-the-people-service-01.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/build-modular-monolith.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/compiling-typescript-for-deployment.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/debug-platformatic-db.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/deploying-on-lambda.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/deployment/advanced-fly-io-deployment.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/deployment/deploy-to-fly-io-with-sqlite.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/deployment/overview.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/dockerize-platformatic-app.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/environment-variables.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/generate-frontend-code-to-consume-platformatic-rest-api.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/images/frontend-screenshot-1.jpg (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/images/frontend-screenshot-2.jpg (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/images/frontend-screenshot-3.jpg (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/images/frontend-screenshot-4.jpg (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/images/kibana-1.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/images/kibana-2.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/images/kibana-3.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/images/kibana-4.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/jwt-auth0.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/jwt-keycloak.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/keycloak-images/assign_service_account_roles.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/keycloak-images/client_credentials.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/keycloak-images/create_client.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/keycloak-images/create_client_2.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/keycloak-images/create_client_3.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/keycloak-images/create_client_4.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/keycloak-images/create_platformatic.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/keycloak-images/create_realm.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/keycloak-images/create_realm_2.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/keycloak-images/create_realm_role.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/keycloak-images/plt_auth.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/keycloak-images/plt_start.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/keycloak-images/plt_unauth.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/logging-to-elasticsearch.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/migrating-express-app-to-platformatic-service.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/migrating-fastify-app-to-platformatic-service.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/monitoring.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/movie-quotes-app-tutorial.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/prisma.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/runtime-cli-managing.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/securing-platformatic-db.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/seed-a-database.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/telemetry-images/compose-openapi.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/telemetry-images/jaeger-1.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/telemetry-images/jaeger-2.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/telemetry-images/jaeger-3.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/telemetry.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/guides/use-env-with-platformatic.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/images/ENV_Var_Platforamtic.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/images/Platformatic_Composer_Diagram_(Light_Mode).png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/images/Platformatic_DB_Diagram_(Light_Mode).png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/images/Platformatic_Runtime_Diagram_(Light_Mode).png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/images/Platformatic_Service_Diagram_(Light_Mode).png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/images/Platformatic_Stackables_Diagram_(Light_Mode).png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/images/img-dark/Platformatic_Composer_Diagram_(Dark_Mode).png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/images/img-dark/Platformatic_DB_Diagram_(Dark_Mode).png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/images/img-dark/Platformatic_Runtime_Diagram_(Dark_Mode).png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/images/img-dark/Platformatic_Service_Diagram_(Dark_Mode).png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/images/img-dark/Platformatic_Stackables_Diagram_(Dark_Mode).png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/learn/beginner/crud-application.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/learn/glossary.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/learn/images/plt-endpoints.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/learn/images/plt-localhost.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/learn/images/test-endpoint.png (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/learn/overview.md (100%) create mode 100644 versioned_docs/version-2.4.0/packages/astro/configuration.md create mode 100644 versioned_docs/version-2.4.0/packages/astro/overview.md rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/errors.md (100%) create mode 100644 versioned_docs/version-2.4.0/packages/next/configuration.md create mode 100644 versioned_docs/version-2.4.0/packages/next/overview.md create mode 100644 versioned_docs/version-2.4.0/packages/node/configuration.md create mode 100644 versioned_docs/version-2.4.0/packages/node/overview.md create mode 100644 versioned_docs/version-2.4.0/packages/remix/configuration.md create mode 100644 versioned_docs/version-2.4.0/packages/remix/overview.md rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-events/fastify-plugin.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-events/overview.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-graphql/examples/deleteEntity.js (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-graphql/examples/insertEntity.js (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-graphql/examples/query.js (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-graphql/examples/saveEntity.js (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-graphql/ignore.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-graphql/many-to-many.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-graphql/mutations.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-graphql/overview.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-graphql/queries.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-graphql/subscriptions.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/entities/api.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/entities/example.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/entities/fields.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/entities/hooks.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/entities/overview.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/entities/relations.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/entities/timestamps.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/entities/transactions.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/examples/count.js (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/examples/delete.js (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/examples/fastify-plugin.js (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/examples/fields.js (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/examples/find.js (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/examples/hooks.js (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/examples/insert.js (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/examples/relations.js (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/examples/save.js (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/fastify-plugin.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/images/plt-db-hooks.svg (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-mapper/overview.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-openapi/api.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-openapi/explicit-include.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-openapi/ignore.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/packages/sql-openapi/overview.md (100%) create mode 100644 versioned_docs/version-2.4.0/packages/vite/configuration.md create mode 100644 versioned_docs/version-2.4.0/packages/vite/overview.md rename versioned_docs/{version-2.2.1 => version-2.4.0}/runtime/configuration.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/runtime/overview.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/runtime/programmatic.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/service/configuration.md (98%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/service/overview.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/service/plugin.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/service/programmatic.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/watt/overview.md (100%) rename versioned_docs/{version-2.2.1 => version-2.4.0}/watt/reference.md (100%) rename versioned_sidebars/{version-2.2.1-sidebars.json => version-2.4.0-sidebars.json} (86%) diff --git a/versioned_docs/version-2.2.1/FAQs.md b/versioned_docs/version-2.4.0/FAQs.md similarity index 100% rename from versioned_docs/version-2.2.1/FAQs.md rename to versioned_docs/version-2.4.0/FAQs.md diff --git a/versioned_docs/version-2.2.1/Overview.md b/versioned_docs/version-2.4.0/Overview.md similarity index 100% rename from versioned_docs/version-2.2.1/Overview.md rename to versioned_docs/version-2.4.0/Overview.md diff --git a/versioned_docs/version-2.2.1/cli.md b/versioned_docs/version-2.4.0/cli.md similarity index 100% rename from versioned_docs/version-2.2.1/cli.md rename to versioned_docs/version-2.4.0/cli.md diff --git a/versioned_docs/version-2.2.1/client/frontend.md b/versioned_docs/version-2.4.0/client/frontend.md similarity index 100% rename from versioned_docs/version-2.2.1/client/frontend.md rename to versioned_docs/version-2.4.0/client/frontend.md diff --git a/versioned_docs/version-2.2.1/client/overview.md b/versioned_docs/version-2.4.0/client/overview.md similarity index 100% rename from versioned_docs/version-2.2.1/client/overview.md rename to versioned_docs/version-2.4.0/client/overview.md diff --git a/versioned_docs/version-2.2.1/client/programmatic.md b/versioned_docs/version-2.4.0/client/programmatic.md similarity index 100% rename from versioned_docs/version-2.2.1/client/programmatic.md rename to versioned_docs/version-2.4.0/client/programmatic.md diff --git a/versioned_docs/version-2.2.1/composer/api-modification.md b/versioned_docs/version-2.4.0/composer/api-modification.md similarity index 100% rename from versioned_docs/version-2.2.1/composer/api-modification.md rename to versioned_docs/version-2.4.0/composer/api-modification.md diff --git a/versioned_docs/version-2.2.1/composer/configuration.md b/versioned_docs/version-2.4.0/composer/configuration.md similarity index 84% rename from versioned_docs/version-2.2.1/composer/configuration.md rename to versioned_docs/version-2.4.0/composer/configuration.md index b6c8270383..dc6527cc94 100644 --- a/versioned_docs/version-2.2.1/composer/configuration.md +++ b/versioned_docs/version-2.4.0/composer/configuration.md @@ -2,13 +2,13 @@ import Issues from '../getting-started/issues.md'; # Configuration -Platformatic Composer can be configured with a [configuration file](#configuration-files) in the different file formats below. The Composer also supports use of environment variables as setting values with [environment variable placeholders](../composer/configuration.md#setting-and-using-env-placeholders). +Platformatic Composer can be configured with a [configuration file](#configuration-files) in the different file formats below. The Composer also supports use of environment variables as setting values with [environment variable placeholders](../composer/configuration.md#setting-and-using-env-placeholders). ## Configuration Files Platformatic will automatically detect and load configuration files found in the current working directory with the file names listed [here](../file-formats.md#configuration-files). -To specify a configuration file manually, use the [`--config` option](../cli.md#composer) with any `platformatic composer` CLI command. +To specify a configuration file manually, use the [`--config` option](../cli.md#composer) with any `platformatic composer` CLI command. ## Supported File Formats @@ -16,15 +16,16 @@ For detailed information on supported file formats and extensions, visit our [Su ## Configuration Settings -Configuration file settings are grouped as follows: +Configuration file settings are grouped as follows: +- **`basePath`** **(required)**: Configures the [basePath](../service/configuration.md#basePath). - **`server`** **(required)**: Configures the [server settings](../service/configuration.md#server) - **`composer`**: Specific settings for Platformatic Composer, such as service management and API composition. - **`metrics`**: Monitors and records performance [metrics](../service/configuration.md#metrics). - **`plugins`**: Manages additional functionality through [plugins](../service/configuration.md#plugins). - **`telemetry`**: Handles [telemetry data reporting](../service/configuration.md#telemetry). - **`watch`**: Observes file changes for [dynamic updates](../service/configuration.md#watch). -- **`clients`**: Configures [client-specific](../service/configuration.md#clients) settings. +- **`clients`**: Configures [client-specific](../service/configuration.md#clients) settings. Sensitive data within these settings should use [configuration placeholders](#configuration-placeholders) to ensure security. @@ -33,24 +34,37 @@ Sensitive data within these settings should use [configuration placeholders](#co Configure `@platformatic/composer` specific settings such as `services` or `refreshTimeout`: - **`services`** (`array`, default: `[]`) — is an array of objects that defines -the services managed by the composer. Each service object supports the following settings: + the services managed by the composer. Each service object supports the following settings: - - **`id`** (**required**, `string`) - A unique identifier for the service. Use a Platformatic Runtime service id if the service is executing inside [Platformatic Runtime context](../runtime/overview.md#platformatic-runtime-context). - - **`origin`** (`string`) - A service origin. Skip this option if the service is executing inside [Platformatic Runtime context](../runtime/overview.md#platformatic-runtime-context). In this case, service `id` will be used instead of origin. - - **`openapi`** (`object`) - The configuration file used to compose [OpenAPI](#openapi) specification. - - **`graphql`** (`object`) - The configuration for the [GraphQL](#graphql) service. + - **`id`** (**required**, `string`) - A unique identifier for the service. Use a Platformatic Runtime service id if the service is executing inside [Platformatic Runtime context](../runtime/overview.md#platformatic-runtime-context). + - **`origin`** (`string`) - A service origin. Skip this option if the service is executing inside [Platformatic Runtime context](../runtime/overview.md#platformatic-runtime-context). In this case, service `id` will be used instead of origin. + - **`openapi`** (`object`) - The configuration file used to compose [OpenAPI](#openapi) specification. + - **`graphql`** (`object`) - The configuration for the [GraphQL](#graphql) service. - **`proxy`** (`object` or `false`) - Service proxy configuration. If `false`, the service proxy is disabled. - - `prefix` (**required**, `string`) - Service proxy prefix. All service routes will be prefixed with this value. + + - `prefix` (`string`) - Service proxy prefix. All service routes will be prefixed with this value. + + :::note + If the prefix is not explictly set, the composer and the service will try to find the best prefix for the service. + + First of all, if the application code used the `platformatic.setBasePath` (which is always available in each service), + then the value will become the service prefix. + + The next attempt will be to let the service autodetect its own prefix by using the configuration (as the `basePath` setting for `@platformatic/service`) + or by autodetecting the prefix from the host application (like Next.js). + + When none of the criteria above successfully lead to a prefix, the service ID is chosen as last fallback to ensure there are not routing conflicts. + ::: - **`openapi`** (`object`) - See the Platformatic Service [openapi](../service/configuration.md#service) option for more details. -- **`graphql`** (`object`) - Has the Platformatic Service [graphql](../service//configuration.md#service) options, plus - - - **`addEntitiesResolvers`** (`boolean`) - Automatically add related entities on GraphQL types, following the services entities configuration. See [graphql-composer entities](https://github.com/platformatic/graphql-composer#composer-entities) for details. +- **`graphql`** (`object`) - Has the Platformatic Service [graphql](../service//configuration.md#service) options, plus + + - **`addEntitiesResolvers`** (`boolean`) - Automatically add related entities on GraphQL types, following the services entities configuration. See [graphql-composer entities](https://github.com/platformatic/graphql-composer#composer-entities) for details. - **`defaultArgsAdapter`** (`function` or `string`) - The default `argsAdapter` function for the entities, for example for the platformatic db mapped entities queries. ```js graphql: { - defaultArgsAdapter: (partialResults) => ({ where: { id: { in: partialResults.map(r => r.id) } } }) + defaultArgsAdapter: partialResults => ({ where: { id: { in: partialResults.map(r => r.id) } } }) } ``` @@ -59,7 +73,9 @@ the services managed by the composer. Each service object supports the following ```json "defaultArgsAdapter": "where.id.in.$>#id" ``` + - **`onSubgraphError`** (`function`) - Hook called when an error occurs getting schema from a subgraph. The arguments are: + - `error` (`error`) - The error message - `subgraphName` (`string`) - The erroring subgraph @@ -74,14 +90,14 @@ the services managed by the composer. Each service object supports the following - **`url`** (`string`) - A path of the route that exposes the OpenAPI specification. If a service is a Platformatic Service or Platformatic DB, use `/documentation/json` as a value. Use this or `file` option to specify the OpenAPI specification. - **`file`** (`string`) - A path to the OpenAPI specification file. Use this or `url` option to specify the OpenAPI specification. - **`prefix`** (`string`) - A prefix for the OpenAPI specification. All service routes will be prefixed with this value. -- **`config`** (`string`) - A path to the OpenAPI configuration file. This file is used to customize the [OpenAPI](#openapi-configuration)specification. +- **`config`** (`string`) - A path to the OpenAPI configuration file. This file is used to customize the [OpenAPI](#openapi-configuration)specification. ### OpenAPI Configuration The OpenAPI configuration file is a JSON file that is used to customize the OpenAPI specification. It supports the following options: - **`ignore`** (`boolean`) - If `true`, the route will be ignored by the composer. -If you want to ignore a specific method, use the `ignore` option in the nested method object. + If you want to ignore a specific method, use the `ignore` option in the nested method object. ```json title="Example JSON object" { @@ -99,7 +115,6 @@ If you want to ignore a specific method, use the `ignore` option in the nested m - **alias** (`string`) - Use it create an alias for the route path. Original route path will be ignored. - ```json title="Example JSON object" { "paths": { @@ -111,24 +126,24 @@ If you want to ignore a specific method, use the `ignore` option in the nested m ``` - **`rename`** (`string`) - Use it to rename composed route response fields. -Use json schema format to describe the response structure, this only for `200` response. + Use json schema format to describe the response structure, this only for `200` response. ```json title="Example JSON object" { "paths": { "/users": { "responses": { - "200": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { "rename": "user_id" }, - "name": { "rename": "first_name" } - } + "200": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "rename": "user_id" }, + "name": { "rename": "first_name" } } } } + } } } } @@ -196,7 +211,7 @@ Use json schema format to describe the response structure, this only for `200` - **`resolver`** (`object`) - The resolver to retrieve a list of objects - should return a list - and should accept as an arguments a list of primary keys or foreign keys. - **`name`** (`string`, **required**) - The name of the resolver. - **`argsAdapter (partialResults)`** (`function` or `string`) - The function invoked with a subset of the result of the initial query, where `partialResults` is an array of the parent node. It should return an object to be used as argument for `resolver` query. Can be a function or a [metaline](https://github.com/platformatic/metaline) string. - **Default:** if missing, the `defaultArgsAdapter` function will be used; if that is missing too, a [generic one](lib/utils.js#L3) will be used. + **Default:** if missing, the `defaultArgsAdapter` function will be used; if that is missing too, a [generic one](lib/utils.js#L3) will be used. - **`partialResults`** (`function` or `string`) - The function to adapt the subset of the result to be passed to `argsAdapter` - usually is needed only on resolvers of `fkeys` and `many`. Can be a function or a [metaline](https://github.com/platformatic/metaline) string. - **`pkey`** (`string`, **required**) - The primary key field to identify the entity. - **`fkeys`** (`array of objects`) an array to describe the foreign keys of the entities, for example `fkeys: [{ type: 'Author', field: 'authorId' }]`. @@ -217,9 +232,11 @@ Use json schema format to describe the response structure, this only for `200` ## Configuration References ### `telemetry` + Telemetry involves the collection and analysis of data generated by the operations of services. See our [telemetry documentation](../service/configuration.md#telemetry) for details on configuring telemetry for Platformatic Service. ### `watch` + The `watch` functionality helps in monitoring file changes and dynamically updating services. Learn more at Platformatic Service [watch](../service/configuration.md#watch) ### `clients` @@ -232,6 +249,6 @@ Environment variable placeholders are used to securely inject runtime configurat ### PLT_ROOT -The [PLT_ROOT](../service/configuration.md#plt_root) variable is used to configure relative path and is set to the directory containing the Service configuration file. +The [PLT_ROOT](../service/configuration.md#plt_root) variable is used to configure relative path and is set to the directory containing the Service configuration file. - \ No newline at end of file + diff --git a/versioned_docs/version-2.2.1/composer/overview.md b/versioned_docs/version-2.4.0/composer/overview.md similarity index 100% rename from versioned_docs/version-2.2.1/composer/overview.md rename to versioned_docs/version-2.4.0/composer/overview.md diff --git a/versioned_docs/version-2.2.1/composer/plugin.md b/versioned_docs/version-2.4.0/composer/plugin.md similarity index 100% rename from versioned_docs/version-2.2.1/composer/plugin.md rename to versioned_docs/version-2.4.0/composer/plugin.md diff --git a/versioned_docs/version-2.2.1/composer/programmatic.md b/versioned_docs/version-2.4.0/composer/programmatic.md similarity index 100% rename from versioned_docs/version-2.2.1/composer/programmatic.md rename to versioned_docs/version-2.4.0/composer/programmatic.md diff --git a/versioned_docs/version-2.2.1/contributing/contributing.md b/versioned_docs/version-2.4.0/contributing/contributing.md similarity index 100% rename from versioned_docs/version-2.2.1/contributing/contributing.md rename to versioned_docs/version-2.4.0/contributing/contributing.md diff --git a/versioned_docs/version-2.2.1/contributing/documentation-style-guide.md b/versioned_docs/version-2.4.0/contributing/documentation-style-guide.md similarity index 100% rename from versioned_docs/version-2.2.1/contributing/documentation-style-guide.md rename to versioned_docs/version-2.4.0/contributing/documentation-style-guide.md diff --git a/versioned_docs/version-2.2.1/db/authorization/images/http.png b/versioned_docs/version-2.4.0/db/authorization/images/http.png similarity index 100% rename from versioned_docs/version-2.2.1/db/authorization/images/http.png rename to versioned_docs/version-2.4.0/db/authorization/images/http.png diff --git a/versioned_docs/version-2.2.1/db/authorization/images/jwt.png b/versioned_docs/version-2.4.0/db/authorization/images/jwt.png similarity index 100% rename from versioned_docs/version-2.2.1/db/authorization/images/jwt.png rename to versioned_docs/version-2.4.0/db/authorization/images/jwt.png diff --git a/versioned_docs/version-2.2.1/db/authorization/images/sources/http.excalidraw b/versioned_docs/version-2.4.0/db/authorization/images/sources/http.excalidraw similarity index 100% rename from versioned_docs/version-2.2.1/db/authorization/images/sources/http.excalidraw rename to versioned_docs/version-2.4.0/db/authorization/images/sources/http.excalidraw diff --git a/versioned_docs/version-2.2.1/db/authorization/images/sources/jwt.excalidraw b/versioned_docs/version-2.4.0/db/authorization/images/sources/jwt.excalidraw similarity index 100% rename from versioned_docs/version-2.2.1/db/authorization/images/sources/jwt.excalidraw rename to versioned_docs/version-2.4.0/db/authorization/images/sources/jwt.excalidraw diff --git a/versioned_docs/version-2.2.1/db/authorization/images/sources/webhook.excalidraw b/versioned_docs/version-2.4.0/db/authorization/images/sources/webhook.excalidraw similarity index 100% rename from versioned_docs/version-2.2.1/db/authorization/images/sources/webhook.excalidraw rename to versioned_docs/version-2.4.0/db/authorization/images/sources/webhook.excalidraw diff --git a/versioned_docs/version-2.2.1/db/authorization/images/webhook.png b/versioned_docs/version-2.4.0/db/authorization/images/webhook.png similarity index 100% rename from versioned_docs/version-2.2.1/db/authorization/images/webhook.png rename to versioned_docs/version-2.4.0/db/authorization/images/webhook.png diff --git a/versioned_docs/version-2.2.1/db/authorization/overview.md b/versioned_docs/version-2.4.0/db/authorization/overview.md similarity index 100% rename from versioned_docs/version-2.2.1/db/authorization/overview.md rename to versioned_docs/version-2.4.0/db/authorization/overview.md diff --git a/versioned_docs/version-2.2.1/db/authorization/rules.md b/versioned_docs/version-2.4.0/db/authorization/rules.md similarity index 100% rename from versioned_docs/version-2.2.1/db/authorization/rules.md rename to versioned_docs/version-2.4.0/db/authorization/rules.md diff --git a/versioned_docs/version-2.2.1/db/authorization/strategies.md b/versioned_docs/version-2.4.0/db/authorization/strategies.md similarity index 100% rename from versioned_docs/version-2.2.1/db/authorization/strategies.md rename to versioned_docs/version-2.4.0/db/authorization/strategies.md diff --git a/versioned_docs/version-2.2.1/db/authorization/user-roles-metadata.md b/versioned_docs/version-2.4.0/db/authorization/user-roles-metadata.md similarity index 100% rename from versioned_docs/version-2.2.1/db/authorization/user-roles-metadata.md rename to versioned_docs/version-2.4.0/db/authorization/user-roles-metadata.md diff --git a/versioned_docs/version-2.2.1/db/configuration.md b/versioned_docs/version-2.4.0/db/configuration.md similarity index 99% rename from versioned_docs/version-2.2.1/db/configuration.md rename to versioned_docs/version-2.4.0/db/configuration.md index 70a08776bd..c0008f6d60 100644 --- a/versioned_docs/version-2.2.1/db/configuration.md +++ b/versioned_docs/version-2.4.0/db/configuration.md @@ -18,6 +18,7 @@ For detailed information on supported file formats and extensions, please visit Configuration file settings are grouped as follows: +- **`basePath`** **(required)**: Configures the [basePath](../service/configuration.md#basePath). - **`server`** **(required)**: Configures the [server settings](../service/configuration.md#server) - **`composer`**: Specific settings for Platformatic Composer, such as service management and API composition. - **`metrics`**: Monitors and records performance [metrics](../service/configuration.md#metrics). diff --git a/versioned_docs/version-2.2.1/db/logging.md b/versioned_docs/version-2.4.0/db/logging.md similarity index 100% rename from versioned_docs/version-2.2.1/db/logging.md rename to versioned_docs/version-2.4.0/db/logging.md diff --git a/versioned_docs/version-2.2.1/db/migrations.md b/versioned_docs/version-2.4.0/db/migrations.md similarity index 100% rename from versioned_docs/version-2.2.1/db/migrations.md rename to versioned_docs/version-2.4.0/db/migrations.md diff --git a/versioned_docs/version-2.2.1/db/overview.md b/versioned_docs/version-2.4.0/db/overview.md similarity index 100% rename from versioned_docs/version-2.2.1/db/overview.md rename to versioned_docs/version-2.4.0/db/overview.md diff --git a/versioned_docs/version-2.2.1/db/plugin.md b/versioned_docs/version-2.4.0/db/plugin.md similarity index 100% rename from versioned_docs/version-2.2.1/db/plugin.md rename to versioned_docs/version-2.4.0/db/plugin.md diff --git a/versioned_docs/version-2.2.1/db/programmatic.md b/versioned_docs/version-2.4.0/db/programmatic.md similarity index 100% rename from versioned_docs/version-2.2.1/db/programmatic.md rename to versioned_docs/version-2.4.0/db/programmatic.md diff --git a/versioned_docs/version-2.2.1/db/schema-support.md b/versioned_docs/version-2.4.0/db/schema-support.md similarity index 100% rename from versioned_docs/version-2.2.1/db/schema-support.md rename to versioned_docs/version-2.4.0/db/schema-support.md diff --git a/versioned_docs/version-2.2.1/file-formats.md b/versioned_docs/version-2.4.0/file-formats.md similarity index 100% rename from versioned_docs/version-2.2.1/file-formats.md rename to versioned_docs/version-2.4.0/file-formats.md diff --git a/versioned_docs/version-2.2.1/getting-started/issues.md b/versioned_docs/version-2.4.0/getting-started/issues.md similarity index 100% rename from versioned_docs/version-2.2.1/getting-started/issues.md rename to versioned_docs/version-2.4.0/getting-started/issues.md diff --git a/versioned_docs/version-2.2.1/getting-started/new-api-project-instructions.md b/versioned_docs/version-2.4.0/getting-started/new-api-project-instructions.md similarity index 100% rename from versioned_docs/version-2.2.1/getting-started/new-api-project-instructions.md rename to versioned_docs/version-2.4.0/getting-started/new-api-project-instructions.md diff --git a/versioned_docs/version-2.2.1/getting-started/platformatic-architecture.png b/versioned_docs/version-2.4.0/getting-started/platformatic-architecture.png similarity index 100% rename from versioned_docs/version-2.2.1/getting-started/platformatic-architecture.png rename to versioned_docs/version-2.4.0/getting-started/platformatic-architecture.png diff --git a/versioned_docs/version-2.2.1/getting-started/platformatic-composer-architecture.png b/versioned_docs/version-2.4.0/getting-started/platformatic-composer-architecture.png similarity index 100% rename from versioned_docs/version-2.2.1/getting-started/platformatic-composer-architecture.png rename to versioned_docs/version-2.4.0/getting-started/platformatic-composer-architecture.png diff --git a/versioned_docs/version-2.2.1/getting-started/platformatic-db-architecture.png b/versioned_docs/version-2.4.0/getting-started/platformatic-db-architecture.png similarity index 100% rename from versioned_docs/version-2.2.1/getting-started/platformatic-db-architecture.png rename to versioned_docs/version-2.4.0/getting-started/platformatic-db-architecture.png diff --git a/versioned_docs/version-2.2.1/getting-started/platformatic-runtime-architecture.png b/versioned_docs/version-2.4.0/getting-started/platformatic-runtime-architecture.png similarity index 100% rename from versioned_docs/version-2.2.1/getting-started/platformatic-runtime-architecture.png rename to versioned_docs/version-2.4.0/getting-started/platformatic-runtime-architecture.png diff --git a/versioned_docs/version-2.2.1/getting-started/platformatic-stackables-architecture.png b/versioned_docs/version-2.4.0/getting-started/platformatic-stackables-architecture.png similarity index 100% rename from versioned_docs/version-2.2.1/getting-started/platformatic-stackables-architecture.png rename to versioned_docs/version-2.4.0/getting-started/platformatic-stackables-architecture.png diff --git a/versioned_docs/version-2.2.1/getting-started/platformatid-composer-architecture.excalidraw b/versioned_docs/version-2.4.0/getting-started/platformatid-composer-architecture.excalidraw similarity index 100% rename from versioned_docs/version-2.2.1/getting-started/platformatid-composer-architecture.excalidraw rename to versioned_docs/version-2.4.0/getting-started/platformatid-composer-architecture.excalidraw diff --git a/versioned_docs/version-2.2.1/getting-started/platformatid-db-architecture.excalidraw b/versioned_docs/version-2.4.0/getting-started/platformatid-db-architecture.excalidraw similarity index 100% rename from versioned_docs/version-2.2.1/getting-started/platformatid-db-architecture.excalidraw rename to versioned_docs/version-2.4.0/getting-started/platformatid-db-architecture.excalidraw diff --git a/versioned_docs/version-2.2.1/getting-started/platformatid-runtime-architecture.excalidraw b/versioned_docs/version-2.4.0/getting-started/platformatid-runtime-architecture.excalidraw similarity index 100% rename from versioned_docs/version-2.2.1/getting-started/platformatid-runtime-architecture.excalidraw rename to versioned_docs/version-2.4.0/getting-started/platformatid-runtime-architecture.excalidraw diff --git a/versioned_docs/version-2.2.1/getting-started/platformatid-stackables-architecture.excalidraw b/versioned_docs/version-2.4.0/getting-started/platformatid-stackables-architecture.excalidraw similarity index 100% rename from versioned_docs/version-2.2.1/getting-started/platformatid-stackables-architecture.excalidraw rename to versioned_docs/version-2.4.0/getting-started/platformatid-stackables-architecture.excalidraw diff --git a/versioned_docs/version-2.2.1/getting-started/quick-start-guide.md b/versioned_docs/version-2.4.0/getting-started/quick-start-guide.md similarity index 94% rename from versioned_docs/version-2.2.1/getting-started/quick-start-guide.md rename to versioned_docs/version-2.4.0/getting-started/quick-start-guide.md index 2d30d7218a..6b2d75d333 100644 --- a/versioned_docs/version-2.2.1/getting-started/quick-start-guide.md +++ b/versioned_docs/version-2.4.0/getting-started/quick-start-guide.md @@ -5,11 +5,11 @@ import NewApiProjectInstructions from './new-api-project-instructions.md'; # Quick Start Guide -Welcome to your first steps with [Platformatic DB](/docs/reference/db/introduction.md). This guide will help you set up and run your first API using Platformatic DB with [SQLite](https://www.sqlite.org/). By the end of this guide, you'll have a fully functional API ready to use. +Welcome to your first steps with [Platformatic DB](/docs/db/overview.md). This guide will help you set up and run your first API using Platformatic DB with [SQLite](https://www.sqlite.org/). By the end of this guide, you'll have a fully functional API ready to use. :::note -While this guide uses [SQLite](https://www.sqlite.org/), Platformatic DB also supports [PostgreSQL](https://www.postgresql.org/), [MySQL](https://www.mysql.com/), and [MariaDB](https://mariadb.org/). For more details on database compatibility, see the [Platformatic DB documentation](/docs/reference/db/introduction.md). +While this guide uses [SQLite](https://www.sqlite.org/), Platformatic DB also supports [PostgreSQL](https://www.postgresql.org/), [MySQL](https://www.mysql.com/), and [MariaDB](https://mariadb.org/). For more details on database compatibility, see the [Platformatic DB documentation](/docs/db/overview.md#supported-databases). ::: @@ -273,4 +273,4 @@ query { For more advanced guides, refer to the [Platformatic learning hub](../learn/overview.md). -::: \ No newline at end of file +::: diff --git a/versioned_docs/version-2.2.1/getting-started/quick-start-watt.md b/versioned_docs/version-2.4.0/getting-started/quick-start-watt.md similarity index 98% rename from versioned_docs/version-2.2.1/getting-started/quick-start-watt.md rename to versioned_docs/version-2.4.0/getting-started/quick-start-watt.md index 69e9eae4a6..5ca7608951 100644 --- a/versioned_docs/version-2.2.1/getting-started/quick-start-watt.md +++ b/versioned_docs/version-2.4.0/getting-started/quick-start-watt.md @@ -137,7 +137,7 @@ curl http://localhost:3042 Inside `my-app`, let's create a new Platformatic Composer ```bash -npx create-platformatic@2.0.0-alpha.23 +npx create-platformatic ``` This will output: @@ -178,7 +178,7 @@ Then, edit `web/composer/platformatic.json` to add the `node` app: "services": [{ "id": "node", "proxy": { - "path": "/node" + "prefix": "/node" } }], "refreshTimeout": 1000 @@ -265,7 +265,7 @@ Finally, let's add `Next` to our composer: "services": [{ "id": "node", "proxy": { - "path": "/node" + "prefix": "/node" } }, { "id": "next" @@ -285,7 +285,7 @@ Then, you can test it by opening your browser at [`http://localhost:3042/next`]( In this example, we are exposing the Next.js app at `/next` and the Node.js app at `/node`. You can change the paths to suit your needs. Make sure to alter the `basePath` in `web/next/watt.json` -and the `path` in `web/composer/platformatic.json` accordingly. +and the `prefix` in `web/composer/platformatic.json` accordingly. ::: diff --git a/versioned_docs/version-2.2.1/guides/add-custom-functionality/extend-graphql.md b/versioned_docs/version-2.4.0/guides/add-custom-functionality/extend-graphql.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/add-custom-functionality/extend-graphql.md rename to versioned_docs/version-2.4.0/guides/add-custom-functionality/extend-graphql.md diff --git a/versioned_docs/version-2.2.1/guides/add-custom-functionality/extend-rest.md b/versioned_docs/version-2.4.0/guides/add-custom-functionality/extend-rest.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/add-custom-functionality/extend-rest.md rename to versioned_docs/version-2.4.0/guides/add-custom-functionality/extend-rest.md diff --git a/versioned_docs/version-2.2.1/guides/add-custom-functionality/overview.md b/versioned_docs/version-2.4.0/guides/add-custom-functionality/overview.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/add-custom-functionality/overview.md rename to versioned_docs/version-2.4.0/guides/add-custom-functionality/overview.md diff --git a/versioned_docs/version-2.2.1/guides/add-custom-functionality/prerequisites.md b/versioned_docs/version-2.4.0/guides/add-custom-functionality/prerequisites.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/add-custom-functionality/prerequisites.md rename to versioned_docs/version-2.4.0/guides/add-custom-functionality/prerequisites.md diff --git a/versioned_docs/version-2.2.1/guides/add-custom-functionality/raw-sql.md b/versioned_docs/version-2.4.0/guides/add-custom-functionality/raw-sql.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/add-custom-functionality/raw-sql.md rename to versioned_docs/version-2.4.0/guides/add-custom-functionality/raw-sql.md diff --git a/versioned_docs/version-2.2.1/guides/build-modular-monolith-images/architecture-diagram.excalidraw b/versioned_docs/version-2.4.0/guides/build-modular-monolith-images/architecture-diagram.excalidraw similarity index 100% rename from versioned_docs/version-2.2.1/guides/build-modular-monolith-images/architecture-diagram.excalidraw rename to versioned_docs/version-2.4.0/guides/build-modular-monolith-images/architecture-diagram.excalidraw diff --git a/versioned_docs/version-2.2.1/guides/build-modular-monolith-images/architecture-diagram.png b/versioned_docs/version-2.4.0/guides/build-modular-monolith-images/architecture-diagram.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/build-modular-monolith-images/architecture-diagram.png rename to versioned_docs/version-2.4.0/guides/build-modular-monolith-images/architecture-diagram.png diff --git a/versioned_docs/version-2.2.1/guides/build-modular-monolith-images/create-a-static-app-workspace-01.png b/versioned_docs/version-2.4.0/guides/build-modular-monolith-images/create-a-static-app-workspace-01.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/build-modular-monolith-images/create-a-static-app-workspace-01.png rename to versioned_docs/version-2.4.0/guides/build-modular-monolith-images/create-a-static-app-workspace-01.png diff --git a/versioned_docs/version-2.2.1/guides/build-modular-monolith-images/create-a-static-app-workspace-02.png b/versioned_docs/version-2.4.0/guides/build-modular-monolith-images/create-a-static-app-workspace-02.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/build-modular-monolith-images/create-a-static-app-workspace-02.png rename to versioned_docs/version-2.4.0/guides/build-modular-monolith-images/create-a-static-app-workspace-02.png diff --git a/versioned_docs/version-2.2.1/guides/build-modular-monolith-images/create-an-app-on-platformati-cloud-01.png b/versioned_docs/version-2.4.0/guides/build-modular-monolith-images/create-an-app-on-platformati-cloud-01.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/build-modular-monolith-images/create-an-app-on-platformati-cloud-01.png rename to versioned_docs/version-2.4.0/guides/build-modular-monolith-images/create-an-app-on-platformati-cloud-01.png diff --git a/versioned_docs/version-2.2.1/guides/build-modular-monolith-images/make-the-composed-media-service-api-read-only-01.png b/versioned_docs/version-2.4.0/guides/build-modular-monolith-images/make-the-composed-media-service-api-read-only-01.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/build-modular-monolith-images/make-the-composed-media-service-api-read-only-01.png rename to versioned_docs/version-2.4.0/guides/build-modular-monolith-images/make-the-composed-media-service-api-read-only-01.png diff --git a/versioned_docs/version-2.2.1/guides/build-modular-monolith-images/start-the-runtime-app-01.png b/versioned_docs/version-2.4.0/guides/build-modular-monolith-images/start-the-runtime-app-01.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/build-modular-monolith-images/start-the-runtime-app-01.png rename to versioned_docs/version-2.4.0/guides/build-modular-monolith-images/start-the-runtime-app-01.png diff --git a/versioned_docs/version-2.2.1/guides/build-modular-monolith-images/test-the-books-service-api-01.png b/versioned_docs/version-2.4.0/guides/build-modular-monolith-images/test-the-books-service-api-01.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/build-modular-monolith-images/test-the-books-service-api-01.png rename to versioned_docs/version-2.4.0/guides/build-modular-monolith-images/test-the-books-service-api-01.png diff --git a/versioned_docs/version-2.2.1/guides/build-modular-monolith-images/test-the-composed-media-service-api-01.png b/versioned_docs/version-2.4.0/guides/build-modular-monolith-images/test-the-composed-media-service-api-01.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/build-modular-monolith-images/test-the-composed-media-service-api-01.png rename to versioned_docs/version-2.4.0/guides/build-modular-monolith-images/test-the-composed-media-service-api-01.png diff --git a/versioned_docs/version-2.2.1/guides/build-modular-monolith-images/test-the-movies-service-api-01.png b/versioned_docs/version-2.4.0/guides/build-modular-monolith-images/test-the-movies-service-api-01.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/build-modular-monolith-images/test-the-movies-service-api-01.png rename to versioned_docs/version-2.4.0/guides/build-modular-monolith-images/test-the-movies-service-api-01.png diff --git a/versioned_docs/version-2.2.1/guides/build-modular-monolith-images/test-the-people-service-01.png b/versioned_docs/version-2.4.0/guides/build-modular-monolith-images/test-the-people-service-01.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/build-modular-monolith-images/test-the-people-service-01.png rename to versioned_docs/version-2.4.0/guides/build-modular-monolith-images/test-the-people-service-01.png diff --git a/versioned_docs/version-2.2.1/guides/build-modular-monolith.md b/versioned_docs/version-2.4.0/guides/build-modular-monolith.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/build-modular-monolith.md rename to versioned_docs/version-2.4.0/guides/build-modular-monolith.md diff --git a/versioned_docs/version-2.2.1/guides/compiling-typescript-for-deployment.md b/versioned_docs/version-2.4.0/guides/compiling-typescript-for-deployment.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/compiling-typescript-for-deployment.md rename to versioned_docs/version-2.4.0/guides/compiling-typescript-for-deployment.md diff --git a/versioned_docs/version-2.2.1/guides/debug-platformatic-db.md b/versioned_docs/version-2.4.0/guides/debug-platformatic-db.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/debug-platformatic-db.md rename to versioned_docs/version-2.4.0/guides/debug-platformatic-db.md diff --git a/versioned_docs/version-2.2.1/guides/deploying-on-lambda.md b/versioned_docs/version-2.4.0/guides/deploying-on-lambda.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/deploying-on-lambda.md rename to versioned_docs/version-2.4.0/guides/deploying-on-lambda.md diff --git a/versioned_docs/version-2.2.1/guides/deployment/advanced-fly-io-deployment.md b/versioned_docs/version-2.4.0/guides/deployment/advanced-fly-io-deployment.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/deployment/advanced-fly-io-deployment.md rename to versioned_docs/version-2.4.0/guides/deployment/advanced-fly-io-deployment.md diff --git a/versioned_docs/version-2.2.1/guides/deployment/deploy-to-fly-io-with-sqlite.md b/versioned_docs/version-2.4.0/guides/deployment/deploy-to-fly-io-with-sqlite.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/deployment/deploy-to-fly-io-with-sqlite.md rename to versioned_docs/version-2.4.0/guides/deployment/deploy-to-fly-io-with-sqlite.md diff --git a/versioned_docs/version-2.2.1/guides/deployment/overview.md b/versioned_docs/version-2.4.0/guides/deployment/overview.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/deployment/overview.md rename to versioned_docs/version-2.4.0/guides/deployment/overview.md diff --git a/versioned_docs/version-2.2.1/guides/dockerize-platformatic-app.md b/versioned_docs/version-2.4.0/guides/dockerize-platformatic-app.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/dockerize-platformatic-app.md rename to versioned_docs/version-2.4.0/guides/dockerize-platformatic-app.md diff --git a/versioned_docs/version-2.2.1/guides/environment-variables.md b/versioned_docs/version-2.4.0/guides/environment-variables.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/environment-variables.md rename to versioned_docs/version-2.4.0/guides/environment-variables.md diff --git a/versioned_docs/version-2.2.1/guides/generate-frontend-code-to-consume-platformatic-rest-api.md b/versioned_docs/version-2.4.0/guides/generate-frontend-code-to-consume-platformatic-rest-api.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/generate-frontend-code-to-consume-platformatic-rest-api.md rename to versioned_docs/version-2.4.0/guides/generate-frontend-code-to-consume-platformatic-rest-api.md diff --git a/versioned_docs/version-2.2.1/guides/images/frontend-screenshot-1.jpg b/versioned_docs/version-2.4.0/guides/images/frontend-screenshot-1.jpg similarity index 100% rename from versioned_docs/version-2.2.1/guides/images/frontend-screenshot-1.jpg rename to versioned_docs/version-2.4.0/guides/images/frontend-screenshot-1.jpg diff --git a/versioned_docs/version-2.2.1/guides/images/frontend-screenshot-2.jpg b/versioned_docs/version-2.4.0/guides/images/frontend-screenshot-2.jpg similarity index 100% rename from versioned_docs/version-2.2.1/guides/images/frontend-screenshot-2.jpg rename to versioned_docs/version-2.4.0/guides/images/frontend-screenshot-2.jpg diff --git a/versioned_docs/version-2.2.1/guides/images/frontend-screenshot-3.jpg b/versioned_docs/version-2.4.0/guides/images/frontend-screenshot-3.jpg similarity index 100% rename from versioned_docs/version-2.2.1/guides/images/frontend-screenshot-3.jpg rename to versioned_docs/version-2.4.0/guides/images/frontend-screenshot-3.jpg diff --git a/versioned_docs/version-2.2.1/guides/images/frontend-screenshot-4.jpg b/versioned_docs/version-2.4.0/guides/images/frontend-screenshot-4.jpg similarity index 100% rename from versioned_docs/version-2.2.1/guides/images/frontend-screenshot-4.jpg rename to versioned_docs/version-2.4.0/guides/images/frontend-screenshot-4.jpg diff --git a/versioned_docs/version-2.2.1/guides/images/kibana-1.png b/versioned_docs/version-2.4.0/guides/images/kibana-1.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/images/kibana-1.png rename to versioned_docs/version-2.4.0/guides/images/kibana-1.png diff --git a/versioned_docs/version-2.2.1/guides/images/kibana-2.png b/versioned_docs/version-2.4.0/guides/images/kibana-2.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/images/kibana-2.png rename to versioned_docs/version-2.4.0/guides/images/kibana-2.png diff --git a/versioned_docs/version-2.2.1/guides/images/kibana-3.png b/versioned_docs/version-2.4.0/guides/images/kibana-3.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/images/kibana-3.png rename to versioned_docs/version-2.4.0/guides/images/kibana-3.png diff --git a/versioned_docs/version-2.2.1/guides/images/kibana-4.png b/versioned_docs/version-2.4.0/guides/images/kibana-4.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/images/kibana-4.png rename to versioned_docs/version-2.4.0/guides/images/kibana-4.png diff --git a/versioned_docs/version-2.2.1/guides/jwt-auth0.md b/versioned_docs/version-2.4.0/guides/jwt-auth0.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/jwt-auth0.md rename to versioned_docs/version-2.4.0/guides/jwt-auth0.md diff --git a/versioned_docs/version-2.2.1/guides/jwt-keycloak.md b/versioned_docs/version-2.4.0/guides/jwt-keycloak.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/jwt-keycloak.md rename to versioned_docs/version-2.4.0/guides/jwt-keycloak.md diff --git a/versioned_docs/version-2.2.1/guides/keycloak-images/assign_service_account_roles.png b/versioned_docs/version-2.4.0/guides/keycloak-images/assign_service_account_roles.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/keycloak-images/assign_service_account_roles.png rename to versioned_docs/version-2.4.0/guides/keycloak-images/assign_service_account_roles.png diff --git a/versioned_docs/version-2.2.1/guides/keycloak-images/client_credentials.png b/versioned_docs/version-2.4.0/guides/keycloak-images/client_credentials.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/keycloak-images/client_credentials.png rename to versioned_docs/version-2.4.0/guides/keycloak-images/client_credentials.png diff --git a/versioned_docs/version-2.2.1/guides/keycloak-images/create_client.png b/versioned_docs/version-2.4.0/guides/keycloak-images/create_client.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/keycloak-images/create_client.png rename to versioned_docs/version-2.4.0/guides/keycloak-images/create_client.png diff --git a/versioned_docs/version-2.2.1/guides/keycloak-images/create_client_2.png b/versioned_docs/version-2.4.0/guides/keycloak-images/create_client_2.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/keycloak-images/create_client_2.png rename to versioned_docs/version-2.4.0/guides/keycloak-images/create_client_2.png diff --git a/versioned_docs/version-2.2.1/guides/keycloak-images/create_client_3.png b/versioned_docs/version-2.4.0/guides/keycloak-images/create_client_3.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/keycloak-images/create_client_3.png rename to versioned_docs/version-2.4.0/guides/keycloak-images/create_client_3.png diff --git a/versioned_docs/version-2.2.1/guides/keycloak-images/create_client_4.png b/versioned_docs/version-2.4.0/guides/keycloak-images/create_client_4.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/keycloak-images/create_client_4.png rename to versioned_docs/version-2.4.0/guides/keycloak-images/create_client_4.png diff --git a/versioned_docs/version-2.2.1/guides/keycloak-images/create_platformatic.png b/versioned_docs/version-2.4.0/guides/keycloak-images/create_platformatic.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/keycloak-images/create_platformatic.png rename to versioned_docs/version-2.4.0/guides/keycloak-images/create_platformatic.png diff --git a/versioned_docs/version-2.2.1/guides/keycloak-images/create_realm.png b/versioned_docs/version-2.4.0/guides/keycloak-images/create_realm.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/keycloak-images/create_realm.png rename to versioned_docs/version-2.4.0/guides/keycloak-images/create_realm.png diff --git a/versioned_docs/version-2.2.1/guides/keycloak-images/create_realm_2.png b/versioned_docs/version-2.4.0/guides/keycloak-images/create_realm_2.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/keycloak-images/create_realm_2.png rename to versioned_docs/version-2.4.0/guides/keycloak-images/create_realm_2.png diff --git a/versioned_docs/version-2.2.1/guides/keycloak-images/create_realm_role.png b/versioned_docs/version-2.4.0/guides/keycloak-images/create_realm_role.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/keycloak-images/create_realm_role.png rename to versioned_docs/version-2.4.0/guides/keycloak-images/create_realm_role.png diff --git a/versioned_docs/version-2.2.1/guides/keycloak-images/plt_auth.png b/versioned_docs/version-2.4.0/guides/keycloak-images/plt_auth.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/keycloak-images/plt_auth.png rename to versioned_docs/version-2.4.0/guides/keycloak-images/plt_auth.png diff --git a/versioned_docs/version-2.2.1/guides/keycloak-images/plt_start.png b/versioned_docs/version-2.4.0/guides/keycloak-images/plt_start.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/keycloak-images/plt_start.png rename to versioned_docs/version-2.4.0/guides/keycloak-images/plt_start.png diff --git a/versioned_docs/version-2.2.1/guides/keycloak-images/plt_unauth.png b/versioned_docs/version-2.4.0/guides/keycloak-images/plt_unauth.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/keycloak-images/plt_unauth.png rename to versioned_docs/version-2.4.0/guides/keycloak-images/plt_unauth.png diff --git a/versioned_docs/version-2.2.1/guides/logging-to-elasticsearch.md b/versioned_docs/version-2.4.0/guides/logging-to-elasticsearch.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/logging-to-elasticsearch.md rename to versioned_docs/version-2.4.0/guides/logging-to-elasticsearch.md diff --git a/versioned_docs/version-2.2.1/guides/migrating-express-app-to-platformatic-service.md b/versioned_docs/version-2.4.0/guides/migrating-express-app-to-platformatic-service.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/migrating-express-app-to-platformatic-service.md rename to versioned_docs/version-2.4.0/guides/migrating-express-app-to-platformatic-service.md diff --git a/versioned_docs/version-2.2.1/guides/migrating-fastify-app-to-platformatic-service.md b/versioned_docs/version-2.4.0/guides/migrating-fastify-app-to-platformatic-service.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/migrating-fastify-app-to-platformatic-service.md rename to versioned_docs/version-2.4.0/guides/migrating-fastify-app-to-platformatic-service.md diff --git a/versioned_docs/version-2.2.1/guides/monitoring.md b/versioned_docs/version-2.4.0/guides/monitoring.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/monitoring.md rename to versioned_docs/version-2.4.0/guides/monitoring.md diff --git a/versioned_docs/version-2.2.1/guides/movie-quotes-app-tutorial.md b/versioned_docs/version-2.4.0/guides/movie-quotes-app-tutorial.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/movie-quotes-app-tutorial.md rename to versioned_docs/version-2.4.0/guides/movie-quotes-app-tutorial.md diff --git a/versioned_docs/version-2.2.1/guides/prisma.md b/versioned_docs/version-2.4.0/guides/prisma.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/prisma.md rename to versioned_docs/version-2.4.0/guides/prisma.md diff --git a/versioned_docs/version-2.2.1/guides/runtime-cli-managing.md b/versioned_docs/version-2.4.0/guides/runtime-cli-managing.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/runtime-cli-managing.md rename to versioned_docs/version-2.4.0/guides/runtime-cli-managing.md diff --git a/versioned_docs/version-2.2.1/guides/securing-platformatic-db.md b/versioned_docs/version-2.4.0/guides/securing-platformatic-db.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/securing-platformatic-db.md rename to versioned_docs/version-2.4.0/guides/securing-platformatic-db.md diff --git a/versioned_docs/version-2.2.1/guides/seed-a-database.md b/versioned_docs/version-2.4.0/guides/seed-a-database.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/seed-a-database.md rename to versioned_docs/version-2.4.0/guides/seed-a-database.md diff --git a/versioned_docs/version-2.2.1/guides/telemetry-images/compose-openapi.png b/versioned_docs/version-2.4.0/guides/telemetry-images/compose-openapi.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/telemetry-images/compose-openapi.png rename to versioned_docs/version-2.4.0/guides/telemetry-images/compose-openapi.png diff --git a/versioned_docs/version-2.2.1/guides/telemetry-images/jaeger-1.png b/versioned_docs/version-2.4.0/guides/telemetry-images/jaeger-1.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/telemetry-images/jaeger-1.png rename to versioned_docs/version-2.4.0/guides/telemetry-images/jaeger-1.png diff --git a/versioned_docs/version-2.2.1/guides/telemetry-images/jaeger-2.png b/versioned_docs/version-2.4.0/guides/telemetry-images/jaeger-2.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/telemetry-images/jaeger-2.png rename to versioned_docs/version-2.4.0/guides/telemetry-images/jaeger-2.png diff --git a/versioned_docs/version-2.2.1/guides/telemetry-images/jaeger-3.png b/versioned_docs/version-2.4.0/guides/telemetry-images/jaeger-3.png similarity index 100% rename from versioned_docs/version-2.2.1/guides/telemetry-images/jaeger-3.png rename to versioned_docs/version-2.4.0/guides/telemetry-images/jaeger-3.png diff --git a/versioned_docs/version-2.2.1/guides/telemetry.md b/versioned_docs/version-2.4.0/guides/telemetry.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/telemetry.md rename to versioned_docs/version-2.4.0/guides/telemetry.md diff --git a/versioned_docs/version-2.2.1/guides/use-env-with-platformatic.md b/versioned_docs/version-2.4.0/guides/use-env-with-platformatic.md similarity index 100% rename from versioned_docs/version-2.2.1/guides/use-env-with-platformatic.md rename to versioned_docs/version-2.4.0/guides/use-env-with-platformatic.md diff --git a/versioned_docs/version-2.2.1/images/ENV_Var_Platforamtic.png b/versioned_docs/version-2.4.0/images/ENV_Var_Platforamtic.png similarity index 100% rename from versioned_docs/version-2.2.1/images/ENV_Var_Platforamtic.png rename to versioned_docs/version-2.4.0/images/ENV_Var_Platforamtic.png diff --git a/versioned_docs/version-2.2.1/images/Platformatic_Composer_Diagram_(Light_Mode).png b/versioned_docs/version-2.4.0/images/Platformatic_Composer_Diagram_(Light_Mode).png similarity index 100% rename from versioned_docs/version-2.2.1/images/Platformatic_Composer_Diagram_(Light_Mode).png rename to versioned_docs/version-2.4.0/images/Platformatic_Composer_Diagram_(Light_Mode).png diff --git a/versioned_docs/version-2.2.1/images/Platformatic_DB_Diagram_(Light_Mode).png b/versioned_docs/version-2.4.0/images/Platformatic_DB_Diagram_(Light_Mode).png similarity index 100% rename from versioned_docs/version-2.2.1/images/Platformatic_DB_Diagram_(Light_Mode).png rename to versioned_docs/version-2.4.0/images/Platformatic_DB_Diagram_(Light_Mode).png diff --git a/versioned_docs/version-2.2.1/images/Platformatic_Runtime_Diagram_(Light_Mode).png b/versioned_docs/version-2.4.0/images/Platformatic_Runtime_Diagram_(Light_Mode).png similarity index 100% rename from versioned_docs/version-2.2.1/images/Platformatic_Runtime_Diagram_(Light_Mode).png rename to versioned_docs/version-2.4.0/images/Platformatic_Runtime_Diagram_(Light_Mode).png diff --git a/versioned_docs/version-2.2.1/images/Platformatic_Service_Diagram_(Light_Mode).png b/versioned_docs/version-2.4.0/images/Platformatic_Service_Diagram_(Light_Mode).png similarity index 100% rename from versioned_docs/version-2.2.1/images/Platformatic_Service_Diagram_(Light_Mode).png rename to versioned_docs/version-2.4.0/images/Platformatic_Service_Diagram_(Light_Mode).png diff --git a/versioned_docs/version-2.2.1/images/Platformatic_Stackables_Diagram_(Light_Mode).png b/versioned_docs/version-2.4.0/images/Platformatic_Stackables_Diagram_(Light_Mode).png similarity index 100% rename from versioned_docs/version-2.2.1/images/Platformatic_Stackables_Diagram_(Light_Mode).png rename to versioned_docs/version-2.4.0/images/Platformatic_Stackables_Diagram_(Light_Mode).png diff --git a/versioned_docs/version-2.2.1/images/img-dark/Platformatic_Composer_Diagram_(Dark_Mode).png b/versioned_docs/version-2.4.0/images/img-dark/Platformatic_Composer_Diagram_(Dark_Mode).png similarity index 100% rename from versioned_docs/version-2.2.1/images/img-dark/Platformatic_Composer_Diagram_(Dark_Mode).png rename to versioned_docs/version-2.4.0/images/img-dark/Platformatic_Composer_Diagram_(Dark_Mode).png diff --git a/versioned_docs/version-2.2.1/images/img-dark/Platformatic_DB_Diagram_(Dark_Mode).png b/versioned_docs/version-2.4.0/images/img-dark/Platformatic_DB_Diagram_(Dark_Mode).png similarity index 100% rename from versioned_docs/version-2.2.1/images/img-dark/Platformatic_DB_Diagram_(Dark_Mode).png rename to versioned_docs/version-2.4.0/images/img-dark/Platformatic_DB_Diagram_(Dark_Mode).png diff --git a/versioned_docs/version-2.2.1/images/img-dark/Platformatic_Runtime_Diagram_(Dark_Mode).png b/versioned_docs/version-2.4.0/images/img-dark/Platformatic_Runtime_Diagram_(Dark_Mode).png similarity index 100% rename from versioned_docs/version-2.2.1/images/img-dark/Platformatic_Runtime_Diagram_(Dark_Mode).png rename to versioned_docs/version-2.4.0/images/img-dark/Platformatic_Runtime_Diagram_(Dark_Mode).png diff --git a/versioned_docs/version-2.2.1/images/img-dark/Platformatic_Service_Diagram_(Dark_Mode).png b/versioned_docs/version-2.4.0/images/img-dark/Platformatic_Service_Diagram_(Dark_Mode).png similarity index 100% rename from versioned_docs/version-2.2.1/images/img-dark/Platformatic_Service_Diagram_(Dark_Mode).png rename to versioned_docs/version-2.4.0/images/img-dark/Platformatic_Service_Diagram_(Dark_Mode).png diff --git a/versioned_docs/version-2.2.1/images/img-dark/Platformatic_Stackables_Diagram_(Dark_Mode).png b/versioned_docs/version-2.4.0/images/img-dark/Platformatic_Stackables_Diagram_(Dark_Mode).png similarity index 100% rename from versioned_docs/version-2.2.1/images/img-dark/Platformatic_Stackables_Diagram_(Dark_Mode).png rename to versioned_docs/version-2.4.0/images/img-dark/Platformatic_Stackables_Diagram_(Dark_Mode).png diff --git a/versioned_docs/version-2.2.1/learn/beginner/crud-application.md b/versioned_docs/version-2.4.0/learn/beginner/crud-application.md similarity index 100% rename from versioned_docs/version-2.2.1/learn/beginner/crud-application.md rename to versioned_docs/version-2.4.0/learn/beginner/crud-application.md diff --git a/versioned_docs/version-2.2.1/learn/glossary.md b/versioned_docs/version-2.4.0/learn/glossary.md similarity index 100% rename from versioned_docs/version-2.2.1/learn/glossary.md rename to versioned_docs/version-2.4.0/learn/glossary.md diff --git a/versioned_docs/version-2.2.1/learn/images/plt-endpoints.png b/versioned_docs/version-2.4.0/learn/images/plt-endpoints.png similarity index 100% rename from versioned_docs/version-2.2.1/learn/images/plt-endpoints.png rename to versioned_docs/version-2.4.0/learn/images/plt-endpoints.png diff --git a/versioned_docs/version-2.2.1/learn/images/plt-localhost.png b/versioned_docs/version-2.4.0/learn/images/plt-localhost.png similarity index 100% rename from versioned_docs/version-2.2.1/learn/images/plt-localhost.png rename to versioned_docs/version-2.4.0/learn/images/plt-localhost.png diff --git a/versioned_docs/version-2.2.1/learn/images/test-endpoint.png b/versioned_docs/version-2.4.0/learn/images/test-endpoint.png similarity index 100% rename from versioned_docs/version-2.2.1/learn/images/test-endpoint.png rename to versioned_docs/version-2.4.0/learn/images/test-endpoint.png diff --git a/versioned_docs/version-2.2.1/learn/overview.md b/versioned_docs/version-2.4.0/learn/overview.md similarity index 100% rename from versioned_docs/version-2.2.1/learn/overview.md rename to versioned_docs/version-2.4.0/learn/overview.md diff --git a/versioned_docs/version-2.4.0/packages/astro/configuration.md b/versioned_docs/version-2.4.0/packages/astro/configuration.md new file mode 100644 index 0000000000..eacd4c78d6 --- /dev/null +++ b/versioned_docs/version-2.4.0/packages/astro/configuration.md @@ -0,0 +1,33 @@ +import Issues from '../../getting-started/issues.md'; + +# Configuration + +Platformatic Astro is configured with a configuration file. It supports the use +of environment variables as setting values with [configuration placeholders](#configuration-placeholders). + +## `application` + +Supported object properties: + +- **`basePath`**: Service proxy base path when exposing this application in a [composer](../../composer/configuration.md) when setting the `proxy` property. If not specified, the service will be exposed on the service or a value specified in the service code via `platformatic.setBasePath()`. +- **`outputDirectory`**: The subdirectory where production build is stored at when using `wattpm build` or `plt build`. The default is `dist`. +- **`include`**: The paths to include when deploying the service. The default is `['dist']`. +- **`commands`**: An object specifying the commands to manage the application instead of using the Astro defaults. Supported commands are: + - **`install`**: The command to execute to install the service dependencies. The default is `npm ci --omit-dev`. + - **`build`**: The command to execute to build the application. + - **`development`**: The command to execute to start the application in development mode. + - **`production`**: The command to execute to start the application in production mode. + +## `logger` + +Configures the logger, see the [logger configuration](https://www.fastify.io/docs/latest/Reference/Server/#logger) for more information. + +## `server` + +Configures the HTTP server, see the [runtime](../../runtime/configuration.md#server) documentation. + +## `watch` + +Manages watching of the service, see the [service](../../service/configuration.md#watch) documentation. + + diff --git a/versioned_docs/version-2.4.0/packages/astro/overview.md b/versioned_docs/version-2.4.0/packages/astro/overview.md new file mode 100644 index 0000000000..bf36a6229f --- /dev/null +++ b/versioned_docs/version-2.4.0/packages/astro/overview.md @@ -0,0 +1,49 @@ +--- +title: Overview +label: Astro +--- + +import Issues from '../../getting-started/issues.md'; + +# Platformatic Astro + +The Platformatic Astro allows to run an [Astro](https://astro.build/) application as a Platformatic Runtime service with no modifications. + +## Getting Started + +Create or copy an Astro application inside the `web` or `services` folder. If you are not using [`autoload`](../../runtime/configuration.md#autoload), you also have to explictly add the new service. + +You are all set, you can now start your runtime as usual via `wattpm dev` or `plt start`. + +## Example configuration file + +```json +{ + "$schema": "https://schemas.platformatic.dev/@platformatic/astro/2.0.0.json", + "application": { + "basePath": "/frontend" + } +} +``` + +## Architecture + +When running in development mode, the Astro Vite development server is run a in worker thread in the same process of the Platformatic runtime. The server port is chosen randomly and it will override any user setting. + +When running in production mode, a custom Fastify server will serve the static or dynamic (for SSR) application. The service is run a in worker thread in the same process of the Platformatic runtime and it will not start a TCP server unless it's the runtime entrypoint. + +In both modes if the service uses the `commands` property then it's responsible to start a HTTP server. The Platformatic runtime will modify the server port replacing it with a random port and then it will integrate the external service in the runtime. + +## Configuration + +See the [configuration](./configuration.md) page. + +## API + +- **`platformatic.setBasePath(path)`**: This function can be use to override the base path for the service. If not properly configure in the composer, this can make your application unaccessible. +- **`platformatic.id`**: The id of the service. +- **`platformatic.root`**: The root directory of the service. +- **`platformatic.basePath`**: The base path of the service in the composer. +- **`platformatic.logLevel`**: The log level configured for the service. + + diff --git a/versioned_docs/version-2.2.1/packages/errors.md b/versioned_docs/version-2.4.0/packages/errors.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/errors.md rename to versioned_docs/version-2.4.0/packages/errors.md diff --git a/versioned_docs/version-2.4.0/packages/next/configuration.md b/versioned_docs/version-2.4.0/packages/next/configuration.md new file mode 100644 index 0000000000..5bf94f8b38 --- /dev/null +++ b/versioned_docs/version-2.4.0/packages/next/configuration.md @@ -0,0 +1,33 @@ +import Issues from '../../getting-started/issues.md'; + +# Configuration + +Platformatic Next is configured with a configuration file. It supports the use +of environment variables as setting values with [configuration placeholders](#configuration-placeholders). + +## `application` + +Supported object properties: + +- **`basePath`**: Service proxy base path when exposing this application in a [composer](../../composer/configuration.md) when setting the `proxy` property. If not specified, the service will be exposed on the service or a value specified in the service code via `platformatic.setBasePath()`. +- **`outputDirectory`**: The subdirectory where production build is stored at when using `wattpm build` or `plt build`. The default is `dist`. +- **`include`**: The paths to include when deploying the service. The default is `['dist']`. +- **`commands`**: An object specifying the commands to manage the application instead of using the Next defaults. Supported commands are: + - **`install`**: The command to execute to install the service dependencies. The default is `npm ci --omit-dev`. + - **`build`**: The command to execute to build the application. + - **`development`**: The command to execute to start the application in development mode. + - **`production`**: The command to execute to start the application in production mode. + +## `logger` + +Configures the logger, see the [logger configuration](https://www.fastify.io/docs/latest/Reference/Server/#logger) for more information. + +## `server` + +Configures the HTTP server, see the [runtime](../../runtime/configuration.md#server) documentation. + +## `watch` + +Manages watching of the service, see the [service](../../service/configuration.md#watch) documentation. + + diff --git a/versioned_docs/version-2.4.0/packages/next/overview.md b/versioned_docs/version-2.4.0/packages/next/overview.md new file mode 100644 index 0000000000..da97a0f6d6 --- /dev/null +++ b/versioned_docs/version-2.4.0/packages/next/overview.md @@ -0,0 +1,45 @@ +--- +title: Overview +label: Astro +--- + +import Issues from '../../getting-started/issues.md'; + +# Platformatic Next + +The Platformatic Next allows to run a [Next](https://nextjs.org/) application as a Platformatic Runtime service with no modifications. + +## Getting Started + +Create or copy an Next application inside the `web` or `services` folder. If you are not using [`autoload`](../../runtime/configuration.md#autoload), you also have to explictly add the new service. + +You are all set, you can now start your runtime as usual via `wattpm dev` or `plt start`. + +## Example configuration file + +```json +{ + "$schema": "https://schemas.platformatic.dev/@platformatic/next/2.0.0.json", + "application": { + "basePath": "/frontend" + } +} +``` + +## Architecture + +When starting Next.js in development mode, production mode or by using the `commands` property, Platformatic will choose a random port for the HTTP server and it will override any user or application setting. + +## Configuration + +See the [configuration](./configuration.md) page. + +## API + +- **`platformatic.setBasePath(path)`**: This function can be use to override the base path for the service. If not properly configure in the composer, this can make your application unaccessible. +- **`platformatic.id`**: The id of the service. +- **`platformatic.root`**: The root directory of the service. +- **`platformatic.basePath`**: The base path of the service in the composer. +- **`platformatic.logLevel`**: The log level configured for the service. + + diff --git a/versioned_docs/version-2.4.0/packages/node/configuration.md b/versioned_docs/version-2.4.0/packages/node/configuration.md new file mode 100644 index 0000000000..f776d287d1 --- /dev/null +++ b/versioned_docs/version-2.4.0/packages/node/configuration.md @@ -0,0 +1,40 @@ +import Issues from '../../getting-started/issues.md'; + +# Configuration + +Platformatic Node is configured with a configuration file. It supports the use +of environment variables as setting values with [configuration placeholders](#configuration-placeholders). + +## `application` + +Supported object properties: + +- **`basePath`**: Service proxy base path when exposing this application in a [composer](../../composer/configuration.md) when setting the `proxy` property. If not specified, the service will be exposed on the service or a value specified in the service code via `platformatic.setBasePath()`. +- **`outputDirectory`**: The subdirectory where production build is stored at when using `wattpm build` or `plt build`. The default is `dist`. +- **`include`**: The paths to include when deploying the service. The default is `['dist']`. +- **`commands`**: An object specifying the commands to manage the application instead of directly executing the service entrypoint. Supported commands are: + - **`install`**: The command to execute to install the service dependencies. The default is `npm ci --omit-dev`. + - **`build`**: The command to execute to build the application. + - **`development`**: The command to execute to start the application in development mode. + - **`production`**: The command to execute to start the application in production mode. + +## `node` + +Configures Node. Supported object properties: + +- **`main`**: The entrypoint of the application. This is only needed if the `main` property is not set in the service `package.json` file. +- **`absoluteUrl`**: If set to `true`, then the service will receive the full URL from a Platformatic Composer. The default is `false`. + +## `logger` + +Configures the logger, see the [logger configuration](https://www.fastify.io/docs/latest/Reference/Server/#logger) for more information. + +## `server` + +Configures the HTTP server, see the [runtime](../../runtime/configuration.md#server) documentation. + +## `watch` + +Manages watching of the service, see the [service](../../service/configuration.md#watch) documentation. + + diff --git a/versioned_docs/version-2.4.0/packages/node/overview.md b/versioned_docs/version-2.4.0/packages/node/overview.md new file mode 100644 index 0000000000..52c821d720 --- /dev/null +++ b/versioned_docs/version-2.4.0/packages/node/overview.md @@ -0,0 +1,92 @@ +--- +title: Overview +label: Astro +--- + +import Issues from '../../getting-started/issues.md'; + +# Platformatic Node + +The Platformatic Node allows to run a [Fastify](https://fastify.io/), [Express](https://expressjs.com/), [Koa](https://koajs.com/#) or plain Node application as a Platformatic Runtime service with no modifications. + +## Getting Started + +Create or copy your application inside the `web` or `services` folder. If you are not using [`autoload`](../../runtime/configuration.md#autoload), you also have to explictly add the new service. + +You are all set, you can now start your runtime as usual via `wattpm dev` or `plt start`. + +## Example configuration file + +```json +{ + "$schema": "https://schemas.platformatic.dev/@platformatic/node/2.0.0.json", + "application": { + "basePath": "/frontend" + } +} +``` + +## Architecture + +If your server entrypoint exports a `create` or `build` function, then Platformatic Node will execute it and then will wait for it to return a server object. In this situation the server will be used without starting a TCP server. The TCP server is started if the service is the runtime entrypoint. + +If your server entrypoint does not export a function, then Platformatic runtime will execute the function and wait for a TCP server to be started. + +In both cases, the listening port is always modified and chosen randomly, overriding any user or application setting. + +If the service uses the `commands` property then it's always responsible to start a HTTP server and the `create` or `build` functions are not supported anymore. + +In all cases, Platformatic runtime will modify the server port replacing it with a random port and then it will integrate the external service in the runtime. + +## Example services entrypoints + +### Fastify with build function + +```js +import fastify from 'fastify' + +export function create() { + const app = fastify({ + logger: { level: globalThis.platformatic?.logLevel ?? 'info' } + }) + + const prefix = globalThis.platformatic?.basePath ?? '' + + app.get(`${prefix}/env`, async () => { + return { production: process.env.NODE_ENV === 'production' } + }) + + return app +} +``` + +### Express with no build function + +```js +import express from 'express' + +const app = express() + +const prefix = globalThis.platformatic?.basePath ?? '' + +app.get(`${prefix}/env`, (req, res) => { + res.send({ production: process.env.NODE_ENV === 'production' }) +}) + +app.listen(3000) +``` + +## Configuration + +See the [configuration](./configuration.md) page. + +## API + +- **`platformatic.setBasePath(path)`**: This function can be use to override the base path for the service. If not properly configure in the composer, this can make your application unaccessible. +- **`platformatic.id`**: The id of the service. +- **`platformatic.root`**: The root directory of the service. +- **`platformatic.basePath`**: The base path of the service in the composer. +- **`platformatic.logLevel`**: The log level configured for the service. + + +```` diff --git a/versioned_docs/version-2.4.0/packages/remix/configuration.md b/versioned_docs/version-2.4.0/packages/remix/configuration.md new file mode 100644 index 0000000000..3acd80b002 --- /dev/null +++ b/versioned_docs/version-2.4.0/packages/remix/configuration.md @@ -0,0 +1,16 @@ +import Issues from '../../getting-started/issues.md'; + +# Configuration + +Platformatic Remix is configured with a configuration file. It supports the use +of environment variables as setting values with [configuration placeholders](#configuration-placeholders). + +It supports all the [settings supported by Platformatic Vite](../vite/configuration.md), plus the following one: + +- **`remix.outputDirectory`**: The subdirectory where production build is stored at when using `wattpm build` or `plt build`. The default is `build`. + +:::note +Platformatic Remix uses this property instead of `application.outputDirectory` (which is ignored). +::: + + diff --git a/versioned_docs/version-2.4.0/packages/remix/overview.md b/versioned_docs/version-2.4.0/packages/remix/overview.md new file mode 100644 index 0000000000..be4c41ab53 --- /dev/null +++ b/versioned_docs/version-2.4.0/packages/remix/overview.md @@ -0,0 +1,49 @@ +--- +title: Overview +label: Astro +--- + +import Issues from '../../getting-started/issues.md'; + +# Platformatic Vite + +The Platformatic Remix allows to run a [Remix](https://remix.run/) application as a Platformatic Runtime service with no modifications. + +## Getting Started + +Create or copy a Vite application inside the `web` or `services` folder. If you are not using [`autoload`](../../runtime/configuration.md#autoload), you also have to explictly add the new service. + +You are all set, you can now start your runtime as usual via `wattpm dev` or `plt start`. + +## Example configuration file + +```json +{ + "$schema": "https://schemas.platformatic.dev/@platformatic/remix/2.0.0.json", + "application": { + "basePath": "/frontend" + } +} +``` + +## Architecture + +When running in development mode, the Vite development server instrumented with [@remix-run/dev](https://www.npmjs.com/package/@remix-run/dev) is run a in worker thread in the same process of the Platformatic runtime. The server port is chosen randomly and it will override any user setting. + +When running in production mode, a custom Express server instrumented with [@remix-run/express](https://www.npmjs.com/package/@remix-run/express) will serve the built application. The service is run a in worker thread in the same process of the Platformatic runtime and it will not start a TCP server unless it's the runtime entrypoint. + +In both modes if the service uses the `commands` property then it's responsible to start a HTTP server. The Platformatic runtime will modify the server port replacing it with a random port and then it will integrate the external service in the runtime. + +## Configuration + +See the [configuration](./configuration.md) page. + +## API + +- **`platformatic.setBasePath(path)`**: This function can be use to override the base path for the service. If not properly configure in the composer, this can make your application unaccessible. +- **`platformatic.id`**: The id of the service. +- **`platformatic.root`**: The root directory of the service. +- **`platformatic.basePath`**: The base path of the service in the composer. +- **`platformatic.logLevel`**: The log level configured for the service. + + diff --git a/versioned_docs/version-2.2.1/packages/sql-events/fastify-plugin.md b/versioned_docs/version-2.4.0/packages/sql-events/fastify-plugin.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-events/fastify-plugin.md rename to versioned_docs/version-2.4.0/packages/sql-events/fastify-plugin.md diff --git a/versioned_docs/version-2.2.1/packages/sql-events/overview.md b/versioned_docs/version-2.4.0/packages/sql-events/overview.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-events/overview.md rename to versioned_docs/version-2.4.0/packages/sql-events/overview.md diff --git a/versioned_docs/version-2.2.1/packages/sql-graphql/examples/deleteEntity.js b/versioned_docs/version-2.4.0/packages/sql-graphql/examples/deleteEntity.js similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-graphql/examples/deleteEntity.js rename to versioned_docs/version-2.4.0/packages/sql-graphql/examples/deleteEntity.js diff --git a/versioned_docs/version-2.2.1/packages/sql-graphql/examples/insertEntity.js b/versioned_docs/version-2.4.0/packages/sql-graphql/examples/insertEntity.js similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-graphql/examples/insertEntity.js rename to versioned_docs/version-2.4.0/packages/sql-graphql/examples/insertEntity.js diff --git a/versioned_docs/version-2.2.1/packages/sql-graphql/examples/query.js b/versioned_docs/version-2.4.0/packages/sql-graphql/examples/query.js similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-graphql/examples/query.js rename to versioned_docs/version-2.4.0/packages/sql-graphql/examples/query.js diff --git a/versioned_docs/version-2.2.1/packages/sql-graphql/examples/saveEntity.js b/versioned_docs/version-2.4.0/packages/sql-graphql/examples/saveEntity.js similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-graphql/examples/saveEntity.js rename to versioned_docs/version-2.4.0/packages/sql-graphql/examples/saveEntity.js diff --git a/versioned_docs/version-2.2.1/packages/sql-graphql/ignore.md b/versioned_docs/version-2.4.0/packages/sql-graphql/ignore.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-graphql/ignore.md rename to versioned_docs/version-2.4.0/packages/sql-graphql/ignore.md diff --git a/versioned_docs/version-2.2.1/packages/sql-graphql/many-to-many.md b/versioned_docs/version-2.4.0/packages/sql-graphql/many-to-many.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-graphql/many-to-many.md rename to versioned_docs/version-2.4.0/packages/sql-graphql/many-to-many.md diff --git a/versioned_docs/version-2.2.1/packages/sql-graphql/mutations.md b/versioned_docs/version-2.4.0/packages/sql-graphql/mutations.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-graphql/mutations.md rename to versioned_docs/version-2.4.0/packages/sql-graphql/mutations.md diff --git a/versioned_docs/version-2.2.1/packages/sql-graphql/overview.md b/versioned_docs/version-2.4.0/packages/sql-graphql/overview.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-graphql/overview.md rename to versioned_docs/version-2.4.0/packages/sql-graphql/overview.md diff --git a/versioned_docs/version-2.2.1/packages/sql-graphql/queries.md b/versioned_docs/version-2.4.0/packages/sql-graphql/queries.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-graphql/queries.md rename to versioned_docs/version-2.4.0/packages/sql-graphql/queries.md diff --git a/versioned_docs/version-2.2.1/packages/sql-graphql/subscriptions.md b/versioned_docs/version-2.4.0/packages/sql-graphql/subscriptions.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-graphql/subscriptions.md rename to versioned_docs/version-2.4.0/packages/sql-graphql/subscriptions.md diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/entities/api.md b/versioned_docs/version-2.4.0/packages/sql-mapper/entities/api.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/entities/api.md rename to versioned_docs/version-2.4.0/packages/sql-mapper/entities/api.md diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/entities/example.md b/versioned_docs/version-2.4.0/packages/sql-mapper/entities/example.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/entities/example.md rename to versioned_docs/version-2.4.0/packages/sql-mapper/entities/example.md diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/entities/fields.md b/versioned_docs/version-2.4.0/packages/sql-mapper/entities/fields.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/entities/fields.md rename to versioned_docs/version-2.4.0/packages/sql-mapper/entities/fields.md diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/entities/hooks.md b/versioned_docs/version-2.4.0/packages/sql-mapper/entities/hooks.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/entities/hooks.md rename to versioned_docs/version-2.4.0/packages/sql-mapper/entities/hooks.md diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/entities/overview.md b/versioned_docs/version-2.4.0/packages/sql-mapper/entities/overview.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/entities/overview.md rename to versioned_docs/version-2.4.0/packages/sql-mapper/entities/overview.md diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/entities/relations.md b/versioned_docs/version-2.4.0/packages/sql-mapper/entities/relations.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/entities/relations.md rename to versioned_docs/version-2.4.0/packages/sql-mapper/entities/relations.md diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/entities/timestamps.md b/versioned_docs/version-2.4.0/packages/sql-mapper/entities/timestamps.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/entities/timestamps.md rename to versioned_docs/version-2.4.0/packages/sql-mapper/entities/timestamps.md diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/entities/transactions.md b/versioned_docs/version-2.4.0/packages/sql-mapper/entities/transactions.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/entities/transactions.md rename to versioned_docs/version-2.4.0/packages/sql-mapper/entities/transactions.md diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/examples/count.js b/versioned_docs/version-2.4.0/packages/sql-mapper/examples/count.js similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/examples/count.js rename to versioned_docs/version-2.4.0/packages/sql-mapper/examples/count.js diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/examples/delete.js b/versioned_docs/version-2.4.0/packages/sql-mapper/examples/delete.js similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/examples/delete.js rename to versioned_docs/version-2.4.0/packages/sql-mapper/examples/delete.js diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/examples/fastify-plugin.js b/versioned_docs/version-2.4.0/packages/sql-mapper/examples/fastify-plugin.js similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/examples/fastify-plugin.js rename to versioned_docs/version-2.4.0/packages/sql-mapper/examples/fastify-plugin.js diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/examples/fields.js b/versioned_docs/version-2.4.0/packages/sql-mapper/examples/fields.js similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/examples/fields.js rename to versioned_docs/version-2.4.0/packages/sql-mapper/examples/fields.js diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/examples/find.js b/versioned_docs/version-2.4.0/packages/sql-mapper/examples/find.js similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/examples/find.js rename to versioned_docs/version-2.4.0/packages/sql-mapper/examples/find.js diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/examples/hooks.js b/versioned_docs/version-2.4.0/packages/sql-mapper/examples/hooks.js similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/examples/hooks.js rename to versioned_docs/version-2.4.0/packages/sql-mapper/examples/hooks.js diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/examples/insert.js b/versioned_docs/version-2.4.0/packages/sql-mapper/examples/insert.js similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/examples/insert.js rename to versioned_docs/version-2.4.0/packages/sql-mapper/examples/insert.js diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/examples/relations.js b/versioned_docs/version-2.4.0/packages/sql-mapper/examples/relations.js similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/examples/relations.js rename to versioned_docs/version-2.4.0/packages/sql-mapper/examples/relations.js diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/examples/save.js b/versioned_docs/version-2.4.0/packages/sql-mapper/examples/save.js similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/examples/save.js rename to versioned_docs/version-2.4.0/packages/sql-mapper/examples/save.js diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/fastify-plugin.md b/versioned_docs/version-2.4.0/packages/sql-mapper/fastify-plugin.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/fastify-plugin.md rename to versioned_docs/version-2.4.0/packages/sql-mapper/fastify-plugin.md diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/images/plt-db-hooks.svg b/versioned_docs/version-2.4.0/packages/sql-mapper/images/plt-db-hooks.svg similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/images/plt-db-hooks.svg rename to versioned_docs/version-2.4.0/packages/sql-mapper/images/plt-db-hooks.svg diff --git a/versioned_docs/version-2.2.1/packages/sql-mapper/overview.md b/versioned_docs/version-2.4.0/packages/sql-mapper/overview.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-mapper/overview.md rename to versioned_docs/version-2.4.0/packages/sql-mapper/overview.md diff --git a/versioned_docs/version-2.2.1/packages/sql-openapi/api.md b/versioned_docs/version-2.4.0/packages/sql-openapi/api.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-openapi/api.md rename to versioned_docs/version-2.4.0/packages/sql-openapi/api.md diff --git a/versioned_docs/version-2.2.1/packages/sql-openapi/explicit-include.md b/versioned_docs/version-2.4.0/packages/sql-openapi/explicit-include.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-openapi/explicit-include.md rename to versioned_docs/version-2.4.0/packages/sql-openapi/explicit-include.md diff --git a/versioned_docs/version-2.2.1/packages/sql-openapi/ignore.md b/versioned_docs/version-2.4.0/packages/sql-openapi/ignore.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-openapi/ignore.md rename to versioned_docs/version-2.4.0/packages/sql-openapi/ignore.md diff --git a/versioned_docs/version-2.2.1/packages/sql-openapi/overview.md b/versioned_docs/version-2.4.0/packages/sql-openapi/overview.md similarity index 100% rename from versioned_docs/version-2.2.1/packages/sql-openapi/overview.md rename to versioned_docs/version-2.4.0/packages/sql-openapi/overview.md diff --git a/versioned_docs/version-2.4.0/packages/vite/configuration.md b/versioned_docs/version-2.4.0/packages/vite/configuration.md new file mode 100644 index 0000000000..bd68879074 --- /dev/null +++ b/versioned_docs/version-2.4.0/packages/vite/configuration.md @@ -0,0 +1,45 @@ +import Issues from '../../getting-started/issues.md'; + +# Configuration + +Platformatic Vite is configured with a configuration file. It supports the use +of environment variables as setting values with [configuration placeholders](#configuration-placeholders). + +## `application` + +Supported object properties: + +- **`basePath`**: Service proxy base path when exposing this application in a [composer](../../composer/configuration.md) when setting the `proxy` property. If not specified, the service will be exposed on the service or a value specified in the service code via `platformatic.setBasePath()`. +- **`outputDirectory`**: The subdirectory where production build is stored at when using `wattpm build` or `plt build`. The default is `dist`. +- **`include`**: The paths to include when deploying the service. The default is `['dist']`. +- **`commands`**: An object specifying the commands to manage the application instead of using the Vite defaults. Supported commands are: + - **`install`**: The command to execute to install the service dependencies. The default is `npm ci --omit-dev`. + - **`build`**: The command to execute to build the application. + - **`development`**: The command to execute to start the application in development mode. + - **`production`**: The command to execute to start the application in production mode. + +## `vite` + +Configures Vite. Supported object properties: + +- **`configFile`**: The configuration file path or `false` to disable autodetection. +- **`devServer.strict`**: Restrict serving files outside of workspace root. By default is `false`. +- **`ssr`**: Configures the application as SSR. Supported object properties: + - **`enabled`**: If the application is a SSR application. + - **`entrypoint`**: The application entrypoint file. The default is `server.js`. + - **`clientDirectory`**: The directory containing client files. The default is `client`. + - **`serverDirectory`**: The directory containing server files. The default is `server`. + +## `logger` + +Configures the logger, see the [logger configuration](https://www.fastify.io/docs/latest/Reference/Server/#logger) for more information. + +## `server` + +Configures the HTTP server, see the [runtime](../../runtime/configuration.md#server) documentation. + +## `watch` + +Manages watching of the service, see the [service](../../service/configuration.md#watch) documentation. + + diff --git a/versioned_docs/version-2.4.0/packages/vite/overview.md b/versioned_docs/version-2.4.0/packages/vite/overview.md new file mode 100644 index 0000000000..9238da1087 --- /dev/null +++ b/versioned_docs/version-2.4.0/packages/vite/overview.md @@ -0,0 +1,51 @@ +--- +title: Overview +label: Astro +--- + +import Issues from '../../getting-started/issues.md'; + +# Platformatic Vite + +The Platformatic Vite allows to run a [Vite](https://vitejs.dev/) application as a Platformatic Runtime service with no modifications. + +## Getting Started + +Create or copy a Vite application inside the `web` or `services` folder. If you are not using [`autoload`](../../runtime/configuration.md#autoload), you also have to explictly add the new service. + +You are all set, you can now start your runtime as usual via `wattpm dev` or `plt start`. + +## Example configuration file + +```json +{ + "$schema": "https://schemas.platformatic.dev/@platformatic/vite/2.0.0.json", + "application": { + "basePath": "/frontend" + } +} +``` + +## Architecture + +When running in development mode, the Vite development server is run a in worker thread in the same process of the Platformatic runtime. The server port is chosen randomly and it will override any user setting. + +When running in production mode, a custom Fastify server will serve the built application. The service is run a in worker thread in the same process of the Platformatic runtime and it will not start a TCP server unless it's the runtime entrypoint. + +In both modes if the service uses the `commands` property then it's responsible to start a HTTP server. The Platformatic runtime will modify the server port replacing it with a random port and then it will integrate the external service in the runtime. + +If the application is a SSR application, it is only supported if using [`@fastify/vite`](https://fastify-vite.dev/). + +## Configuration + +See the [configuration](./configuration.md) page. + +## API + +- **`platformatic.setBasePath(path)`**: This function can be use to override the base path for the service. If not properly configure in the composer, this can make your application unaccessible. +- **`platformatic.id`**: The id of the service. +- **`platformatic.root`**: The root directory of the service. +- **`platformatic.basePath`**: The base path of the service in the composer. +- **`platformatic.logLevel`**: The log level configured for the service. + + diff --git a/versioned_docs/version-2.2.1/runtime/configuration.md b/versioned_docs/version-2.4.0/runtime/configuration.md similarity index 100% rename from versioned_docs/version-2.2.1/runtime/configuration.md rename to versioned_docs/version-2.4.0/runtime/configuration.md diff --git a/versioned_docs/version-2.2.1/runtime/overview.md b/versioned_docs/version-2.4.0/runtime/overview.md similarity index 100% rename from versioned_docs/version-2.2.1/runtime/overview.md rename to versioned_docs/version-2.4.0/runtime/overview.md diff --git a/versioned_docs/version-2.2.1/runtime/programmatic.md b/versioned_docs/version-2.4.0/runtime/programmatic.md similarity index 100% rename from versioned_docs/version-2.2.1/runtime/programmatic.md rename to versioned_docs/version-2.4.0/runtime/programmatic.md diff --git a/versioned_docs/version-2.2.1/service/configuration.md b/versioned_docs/version-2.4.0/service/configuration.md similarity index 98% rename from versioned_docs/version-2.2.1/service/configuration.md rename to versioned_docs/version-2.4.0/service/configuration.md index d3edc4b1a3..e82f10d81e 100644 --- a/versioned_docs/version-2.2.1/service/configuration.md +++ b/versioned_docs/version-2.4.0/service/configuration.md @@ -19,6 +19,12 @@ For detailed information on supported file formats and extensions, please visit Configuration settings containing sensitive data, such as database connection URLs and passwords, should be set using [configuration placeholders](#configuration-placeholders). +### `basePath` + +Service proxy base path when exposing this service in a [composer](../composer/configuration.md) when setting the `proxy` property. + +If not specified, the service will be exposed on the service or a value specified in the service code via `platformatic.setBasePath()`. + ### `server` An object with the following settings: diff --git a/versioned_docs/version-2.2.1/service/overview.md b/versioned_docs/version-2.4.0/service/overview.md similarity index 100% rename from versioned_docs/version-2.2.1/service/overview.md rename to versioned_docs/version-2.4.0/service/overview.md diff --git a/versioned_docs/version-2.2.1/service/plugin.md b/versioned_docs/version-2.4.0/service/plugin.md similarity index 100% rename from versioned_docs/version-2.2.1/service/plugin.md rename to versioned_docs/version-2.4.0/service/plugin.md diff --git a/versioned_docs/version-2.2.1/service/programmatic.md b/versioned_docs/version-2.4.0/service/programmatic.md similarity index 100% rename from versioned_docs/version-2.2.1/service/programmatic.md rename to versioned_docs/version-2.4.0/service/programmatic.md diff --git a/versioned_docs/version-2.2.1/watt/overview.md b/versioned_docs/version-2.4.0/watt/overview.md similarity index 100% rename from versioned_docs/version-2.2.1/watt/overview.md rename to versioned_docs/version-2.4.0/watt/overview.md diff --git a/versioned_docs/version-2.2.1/watt/reference.md b/versioned_docs/version-2.4.0/watt/reference.md similarity index 100% rename from versioned_docs/version-2.2.1/watt/reference.md rename to versioned_docs/version-2.4.0/watt/reference.md diff --git a/versioned_sidebars/version-2.2.1-sidebars.json b/versioned_sidebars/version-2.4.0-sidebars.json similarity index 86% rename from versioned_sidebars/version-2.2.1-sidebars.json rename to versioned_sidebars/version-2.4.0-sidebars.json index 2f036312fd..34911b5e04 100644 --- a/versioned_sidebars/version-2.2.1-sidebars.json +++ b/versioned_sidebars/version-2.4.0-sidebars.json @@ -84,6 +84,42 @@ "label": "Packages", "collapsed": true, "items": [ + { + "type": "category", + "label": "Astro", + "collapsed": true, + "items": [ + "packages/astro/overview", + "packages/astro/configuration" + ] + }, + { + "type": "category", + "label": "Next", + "collapsed": true, + "items": [ + "packages/next/overview", + "packages/next/configuration" + ] + }, + { + "type": "category", + "label": "Remix", + "collapsed": true, + "items": [ + "packages/remix/overview", + "packages/remix/configuration" + ] + }, + { + "type": "category", + "label": "Vite", + "collapsed": true, + "items": [ + "packages/vite/overview", + "packages/vite/configuration" + ] + }, { "type": "category", "label": "SQL-to-OpenAPI", diff --git a/versions.json b/versions.json index 49e6854f3e..789e7cc9d9 100644 --- a/versions.json +++ b/versions.json @@ -1,4 +1,4 @@ [ - "2.2.1", + "2.4.0", "1.53.3" ] \ No newline at end of file