Web dashboard documentation updated to reflect the default enabled state #2002
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
This PR updates all relevant documentation to reflect that the built-in web dashboard is now enabled by default. The core concept has been shifted from "opting-in" to "opting-out."
Key changes include:
/results-output/web-dashboardpage has been rewritten to explain the new default behavior.K6_NO_WEB_DASHBOARD).Why
This documentation update is necessary to align with a core feature change in an upcoming release of k6. The web dashboard will now run by default, and failing to update the documentation would cause significant confusion for both new and existing users. This PR ensures that the documentation is accurate and reflects the new, improved user experience at the time of release.
Checklist
I have used a meaningful title for the PR.
I have described the changes I've made in the "What?" section above.
I have performed a self-review of my changes.
I have run the
npm startcommand locally and verified that the changes look good.I have made my changes in the
docs/sources/k6/nextfolder of the documentation.Related PR(s)/Issue(s)
Related to: grafana/k6#4913
Closes: #2001