This repository has been archived by the owner on Jan 30, 2025. It is now read-only.
Add troubleshooting document #569
Merged
Conversation
This file contains 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
mstoykov
approved these changes
Oct 5, 2022
ankur22
approved these changes
Oct 5, 2022
inancgumus
approved these changes
Oct 6, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This is part of what we discussed in grafana/k6#4425.
It will also have to be part of k6-docs, but I figured we might want to start it here. How great it would be if the docs were only in this repo and https://k6.io/docs/ would be built from them... 💭🙏
It would also be great if all of these documents, like SUPPORT.md, CONTRIBUTING.md and the inline examples were in a
/docssubdirectory, to avoid cluttering the repo root and make the README shorter. See how Puppeteer structures this. But we can tackle this later.This is not an exhaustive list of common issues, and we should integrate the
command not foundissue we mention on the front page, and have a separate "Troubleshooting" page, like we do for k6. But that also can be done later.