From 5d8546a4704de7548d8f3f19a87be913c32df926 Mon Sep 17 00:00:00 2001 From: Abdallah Abedraba Date: Mon, 15 May 2023 12:50:02 +0200 Subject: [PATCH] docs: create a Testkube Dashboard category in docs (#3834) --- .../testkube-dashboard-api-endpoint.md | 13 ++++++++++++ docs/docs/articles/testkube-dashboard.md | 8 ------- docs/sidebars.js | 21 +++++++++++-------- 3 files changed, 25 insertions(+), 17 deletions(-) create mode 100644 docs/docs/articles/testkube-dashboard-api-endpoint.md diff --git a/docs/docs/articles/testkube-dashboard-api-endpoint.md b/docs/docs/articles/testkube-dashboard-api-endpoint.md new file mode 100644 index 00000000000..ee33492cfb0 --- /dev/null +++ b/docs/docs/articles/testkube-dashboard-api-endpoint.md @@ -0,0 +1,13 @@ +# API Endpoint + +The API Endpoint connects the dashboard to your Testkube API endpoint that is part of your Testkube installation. + +In case you're starting the dashboard from the CLI using the `testkube dashboard` command it should be automatically set for you. + +But if you are [exposing Testkube Dashboard over an Ingress Controller](./exposing-testkube-with-ingress-nginx.md) you will have to also expose the API Endpoint and connect the Testkube Dashboard through the Testkube API Endpoint modal which you can find in *Settings* > *General* > *Testkube API endpoint*: + +![dashboard-endpoint-prompt.png](../img/dashboard-endpoint-prompt-1.6.png) + +You can also append it to the above URL (as an apiEndpoint parameter) for a direct link to the dashboard with your results: + +`https://demo.testkube.io/?apiEndpoint=...` \ No newline at end of file diff --git a/docs/docs/articles/testkube-dashboard.md b/docs/docs/articles/testkube-dashboard.md index fdb9c31c378..6f28f6d4355 100644 --- a/docs/docs/articles/testkube-dashboard.md +++ b/docs/docs/articles/testkube-dashboard.md @@ -6,14 +6,6 @@ The Testkube Dashboard provides a simple web-based user interface for monitoring The URL to access the Testkube Dashboard is [https://demo.testkube.io](https://demo.testkube.io), which, when first loaded, will prompt for the results endpoint of your Testkube installation. Click the **Settings** icon at the bottom left of the screen to return to change the Testkube API endpoint. -![dashboard-endpoint-prompt.png](../img/dashboard-endpoint-prompt-1.6.png) - -See the [UI Results Endpoint section](#ui-results-endpoint) below to find the endpoint to open the dashboard. Once you have the results endpoint, you can append it to the above URL (as an apiEndpoint parameter) for a direct link to the dashboard with your results: - -`https://demo.testkube.io/?apiEndpoint=...` - -Alternatively, the Testkube Dashboard can be opened on your local machine using the command `sh kubectl testkube dashboard` which uses port forwarding for accessing your local results endpoint (see more [here](../cli/testkube_dashboard.md)). - ## Explore the Testkube Dashboard The Testkube Dashboard displays the current status of Tests and Test Suites executed in your environment. diff --git a/docs/sidebars.js b/docs/sidebars.js index b7c333e7585..927a12dce67 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -60,7 +60,15 @@ const sidebars = { "articles/getting-test-suites-results", ], }, - "articles/testkube-dashboard", + { + type: "category", + label: "Testkube Dashboard", + link: { + type: "doc", + id: "articles/testkube-dashboard", + }, + items: ["articles/testkube-dashboard-api-endpoint"], + }, "articles/adding-tests-secrets", "articles/scheduling-tests", "articles/artifacts-storage", @@ -68,7 +76,7 @@ const sidebars = { "articles/test-triggers", "articles/testkube-dependencies", "articles/common-issues", - "articles/test-sources" + "articles/test-sources", ], }, { @@ -86,17 +94,12 @@ const sidebars = { type: "doc", id: "articles/exposing-testkube", }, - items: [ - "articles/exposing-testkube-with-ingress-nginx", - ], + items: ["articles/exposing-testkube-with-ingress-nginx"], }, { type: "category", label: "Authentication", - items: [ - "articles/oauth-cli", - "articles/oauth-dashboard", - ], + items: ["articles/oauth-cli", "articles/oauth-dashboard"], }, "articles/deploying-in-aws", ],