Skip to content

Commit

Permalink
Merge pull request #136 from grafana/feature/update-docs
Browse files Browse the repository at this point in the history
Update docs for v0.7.0
  • Loading branch information
szkiba authored Jan 12, 2024
2 parents c2dd637 + 08354f1 commit a0f6ec6
Show file tree
Hide file tree
Showing 13 changed files with 46 additions and 45 deletions.
5 changes: 5 additions & 0 deletions .dashboard-noop.js → .dashboard-custom.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,10 @@
// SPDX-License-Identifier: AGPL-3.0-only

export default function (config) {
config.tabs.push({
title: "Custom",
id: "custom",
sections: [],
});
return config;
}
5 changes: 0 additions & 5 deletions .dashboard.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,5 @@
// SPDX-License-Identifier: AGPL-3.0-only

export default function (config) {
config.tabs.push({
title: "Custom",
id: "custom",
sections: [],
});
return config;
}
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ SPDX-License-Identifier: AGPL-3.0-only

[![Go Report Card](https://goreportcard.com/badge/github.com/grafana/xk6-dashboard)](https://goreportcard.com/report/github.com/grafana/xk6-dashboard)
[![GitHub Actions](https://github.com/grafana/xk6-dashboard/workflows/Test/badge.svg)](https://github.com/grafana/xk6-dashboard/actions?query=workflow%3ATest+branch%3Amaster)
[![codecov](https://codecov.io/gh/szkiba/xk6-dashboard/branch/master/graph/badge.svg?token=ORDNEEZIV3)](https://codecov.io/gh/szkiba/xk6-dashboard)
[![REUSE status](https://api.reuse.software/badge/github.com/grafana/xk6-dashboard)](https://api.reuse.software/info/github.com/grafana/xk6-dashboard)
[![codecov](https://codecov.io/gh/grafana/xk6-dashboard/graph/badge.svg?token=ORDNEEZIV3)](https://codecov.io/gh/grafana/xk6-dashboard)


# xk6-dashboard <!-- omit in toc -->
Expand Down Expand Up @@ -67,9 +66,10 @@ See [sample HTML report](screenshot/k6-dashboard-html-report.html) or try the [o
- [Environment](#environment)
- [Docker](#docker)
- [Save report](#save-report)
- [Events](#events)
- [Command Line](#command-line)
- [Docker](#docker-1)
- [How It Works](#how-it-works)
- [Events](#events)

## Download

Expand Down
18 changes: 18 additions & 0 deletions releases/v0.7.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
xk6-dashboard `v0.7.0` is here 🎉! This release includes:

- New design
- New CLI tool
- Preparation for k6 experimental module

## New design

The new user interface design fits better with the k6 cloud user interface. The implementation of the UI has also changed, its size has decreased a bit, the code has become more structured and maintainable.

## New CLI tool

Subcommands that do not require running k6 have been added to a dedicated CLI tool (`k6-web-dashboard`). The main reason for this is that soon the xk6-dashboard will be included in k6 as an experimental module and it will no longer be possible to use subcommands. The `aggregate`, `replay` and `report` commands will still be available with the help of the dedicated CLI.

## Preparation for k6 experimental module

The xk6-dashboard will soon be integrated into k6 as an experimental module. Therefore, certain changes in the configuration management were necessary. For example, the names of the configuration environment variables were given the `K6_WEB_DASHBOARD_` prefix.

57 changes: 20 additions & 37 deletions screenshot/k6-dashboard-html-report.html

Large diffs are not rendered by default.

Binary file modified screenshot/k6-dashboard-html-report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshot/k6-dashboard-overview-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshot/k6-dashboard-overview-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshot/k6-dashboard-report.pdf
Binary file not shown.
Binary file modified screenshot/k6-dashboard-summary-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshot/k6-dashboard-summary-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshot/k6-dashboard-timings-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshot/k6-dashboard-timings-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a0f6ec6

Please sign in to comment.