From b0a067258e96fbace931f20c4a0724c527289594 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adnan=20Rahi=C4=87?= Date: Thu, 12 Oct 2023 17:50:19 +0200 Subject: [PATCH] docs(saas): add orgs and envs in concepts (#3239) * docs(redirects): fix broken links * docs(concepts): add envs and orgs * Apply suggestions from code review Co-authored-by: Julianne Fermi --------- Co-authored-by: Julianne Fermi --- docs/docs/concepts/environments.mdx | 25 ++++++++++++++++++ docs/docs/concepts/organizations.mdx | 38 ++++++++++++++++++++++++++++ docs/docusaurus.config.js | 33 +++++++++++++++++++++--- docs/sidebars.js | 10 ++++++++ 4 files changed, 102 insertions(+), 4 deletions(-) create mode 100644 docs/docs/concepts/environments.mdx create mode 100644 docs/docs/concepts/organizations.mdx diff --git a/docs/docs/concepts/environments.mdx b/docs/docs/concepts/environments.mdx new file mode 100644 index 0000000000..ef598a2f3b --- /dev/null +++ b/docs/docs/concepts/environments.mdx @@ -0,0 +1,25 @@ +--- +id: environments +title: Environments +description: Tracetest allows you to quickly build integration and end-to-end tests, powered by your OpenTelemetry traces. +hide_table_of_contents: false +keywords: + - tracetest + - trace-based testing + - observability + - distributed tracing + - testing +image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1689693872/docs/Blog_Thumbnail_28_ugy2yy.png +--- + +Environments are workspaces where you keep tests, test suites, variable sets, and all other Tracetest resources. + +![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1697028288/docs/app.tracetest.io_organizations_ttorg_7e8e767d64dbdb25_environments_ttenv_a39dc7d303f25454_settings_iebfhs.png) + +Connect an Agent and/or Trace Data Store to an environment to start creating tests. + +You get a `localMode` environment by default. This environment is dedicated to your local development environment for you to play around with while developing your apps. + +Create additional environments by clicking the `+ Create a New Environment` button. + +Additional environments can be shared between team members, or used as dedicated environments for QA, staging, test, production, or any other shared environment of your choosing. diff --git a/docs/docs/concepts/organizations.mdx b/docs/docs/concepts/organizations.mdx new file mode 100644 index 0000000000..0fc28fbe63 --- /dev/null +++ b/docs/docs/concepts/organizations.mdx @@ -0,0 +1,38 @@ +--- +id: organizations +title: Organizations +description: Tracetest allows you to quickly build integration and end-to-end tests, powered by your OpenTelemetry traces. +hide_table_of_contents: false +keywords: + - tracetest + - trace-based testing + - observability + - distributed tracing + - testing +image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1689693872/docs/Blog_Thumbnail_28_ugy2yy.png +--- + +Organizations contain a collection of environments, team members, and settings. + +When signing up to Tracetest you get a `personal-org` by default. You can create additional organizations by clicking the organization dropdown and selecting `+ Create a New Organization`. + +![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1697025940/docs/app.tracetest.io_organizations_ttorg_7e8e767d64dbdb25_environments_n6xnhh.png) + + +To manage environments in the currect organization, navigate to the `Environments` tab. + +![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1697026127/docs/app.tracetest.io_organizations_ttorg_7e8e767d64dbdb25_environments_ttenv_a39dc7d303f25454_settings_tab_agent_jjgvle.png) + +You can edit or delete existing environments and create new environments. + +To edit the currect organization settings, select the `Settings` tab. + +![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1697026240/docs/app.tracetest.io_organizations_ttorg_7e8e767d64dbdb25_environments_ttenv_a39dc7d303f25454_settings_tab_agent_1_m0mbn1.png) + +Here you can delete the organization if you have the required permissions. + +To manage team members and permissions, navigate to the `Members` tab. + +Here you can add new team members to the organization and manage their permissions. + +![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1697026707/docs/app.tracetest.io_organizations_ttorg_7e8e767d64dbdb25_environments_ttenv_a39dc7d303f25454_settings_tab_agent_2_cy5wha.png) diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 5bd1071cae..02c60df9c2 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -131,7 +131,11 @@ const config = { }, { to: '/getting-started/installation', - from: ['/getting-started/cli', '/getting-started/detailed-installation' /*, '/docs/legacyDocFrom2016'*/], + from: ['/getting-started/cli', '/getting-started/detailed-installation', '/installing' /*, '/docs/legacyDocFrom2016'*/], + }, + { + to: '/getting-started/open', + from: ['/accessing-dashboard' /*, '/docs/legacyDocFrom2016'*/], }, { to: '/configuration/overview', @@ -155,7 +159,7 @@ const config = { }, { to: '/cli/creating-tests', - from: ['/cli/test-definition-file' /*, '/docs/legacyDocFrom2016'*/], + from: ['/cli/test-definition-file', '/test-definition-file' /*, '/docs/legacyDocFrom2016'*/], }, { to: '/cli/configuring-your-cli/', @@ -206,8 +210,16 @@ const config = { from: ['/web-ui/creating-transactions'], }, { - to: '/getting-started/installation', - from: ['/installing'], + to: '/web-ui/creating-tests', + from: ['/create-test'], + }, + { + to: '/web-ui/creating-test-specifications', + from: ['/adding-assertions'], + }, + { + to: '/web-ui/test-results', + from: ['/test-results'], }, // SaaS to Core { @@ -230,6 +242,19 @@ const config = { to: '/core/configuration/upgrade', from: ['/configuration/upgrade'], }, + // Live Examples + { + to: '/live-examples/pokeshop/use-cases/add-pokemon', + from: ['/pokeshop/add-pokemon/'], + }, + { + to: '/live-examples/pokeshop/use-cases/import-pokemon', + from: ['/pokeshop/import-pokemon/'], + }, + { + to: '/live-examples/pokeshop/overview', + from: ['/pokeshop'], + }, ], // createRedirects(existingPath) { // if (existingPath.includes('/community')) { diff --git a/docs/sidebars.js b/docs/sidebars.js index 1c1a73fc26..5c2461a2d3 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -605,6 +605,16 @@ const sidebars = { id: "concepts/architecture", label: "Architecture", }, + { + type: "doc", + id: "concepts/organizations", + label: "Organizations", + }, + { + type: "doc", + id: "concepts/environments", + label: "Environments", + }, { type: "doc", id: "concepts/assertions",