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] Clarify when to use kbn clean #101155

Merged
merged 1 commit into from
Jun 2, 2021
Merged

Conversation

lockewritesdocs
Copy link
Contributor

Summary

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.

Here's a screenshot:
image

Checklist

Delete any items that are not applicable to this PR.

For maintainers

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.
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

Copy link
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@stacey-gammon
Copy link
Contributor

Funny timing, just sent an email about this. All new developer guide content should go in the new docs system. This file hasn't been migrated over yet however.

@lockewritesdocs lockewritesdocs merged commit 119969e into master Jun 2, 2021
@lockewritesdocs lockewritesdocs deleted the docs__clarify-kbn-clean branch June 2, 2021 15:26
lockewritesdocs pushed a commit to lockewritesdocs/kibana that referenced this pull request Jun 2, 2021
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.
lockewritesdocs pushed a commit that referenced this pull request Jun 2, 2021
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.
lockewritesdocs pushed a commit that referenced this pull request Jun 2, 2021
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.
gmmorris added a commit to gmmorris/kibana that referenced this pull request Jun 2, 2021
* master: (68 commits)
  Unskip advanced settings a11y test (elastic#100558)
  [App Search] Crawler Landing Page (elastic#100822)
  [DOCS] Clarify when to use kbn clean (elastic#101155)
  change label behavior (elastic#100991)
  skip flaky suite (elastic#101126)
  Fix cases plugin ownership (elastic#101073)
  [Home] Adding file upload to add data page (elastic#100863)
  [ML] Functional tests - reenable categorization tests (elastic#101137)
  [DOCS] Adds server.uuid to settings docs (elastic#101121)
  Fix newsfeed unread notifications always on when reloading Kibana (elastic#100357)
  [Lens] Time shift metrics (elastic#98781)
  [Deprecations service] make `correctiveActions.manualSteps` required (elastic#100997)
  Add "Risk Matrix" section to the PR template (elastic#100649)
  [Maps] spatially filter by all geo fields (elastic#100735)
  [Security Solution] Add Ransomware canary advanced policy option (elastic#101068)
  [Exploratory view] Core web vitals (elastic#100320)
  [Security solution][Endpoint] Add unit tests for fleet event filters/trusted apps cards (elastic#101034)
  [Lens] Use a setter function for the dimension panel (elastic#101123)
  [Index Patterns] Fix return saved index pattern object (elastic#101051)
  [CI] For PRs, build TS refs before public api docs check (elastic#100791)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants