Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: create a Testkube Dashboard category in docs #3834

Merged
merged 1 commit into from
May 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/docs/articles/testkube-dashboard-api-endpoint.md
Original file line number Diff line number Diff line change
@@ -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=...`
8 changes: 0 additions & 8 deletions docs/docs/articles/testkube-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
21 changes: 12 additions & 9 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,23 @@ 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",
"articles/metrics",
"articles/test-triggers",
"articles/testkube-dependencies",
"articles/common-issues",
"articles/test-sources"
"articles/test-sources",
],
},
{
Expand All @@ -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",
],
Expand Down