Skip to content

Commit eb81b29

Browse files
author
Adam Locke
authored
[DOCS] Clarify when to use kbn clean (#101155) (#101173)
When building a PR locally, I ran into an issue where the server kept crashing. I ran `yarn kbn clean`, and saw this message in my terminal: >warn This command is only necessary for the rare circumstance where you need to recover a consistent state when problems arise. If you need to run this command often, >please let us know by filling out this form: https://ela.st/yarn-kbn-clean I think it makes sense to add this information to the docs so that if users are reading it, they know that this command is not typically necessary.
1 parent 3e755cc commit eb81b29

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/developer/getting-started/index.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,10 @@ may need to run:
9292
yarn kbn clean
9393
----
9494

95+
NOTE: Running this command is only necessary in rare circumstance where you need to recover
96+
a consistent state when problems arise. If you need to run this command often, complete
97+
this form to provide feedback: https://ela.st/yarn-kbn-clean
98+
9599
If you have failures during `yarn kbn bootstrap` you may have some
96100
corrupted packages in your yarn cache which you can clean with:
97101

0 commit comments

Comments
 (0)