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] Refactor quick start guide and README #71331

Merged
merged 27 commits into from
Apr 20, 2021
Merged

[DOCS] Refactor quick start guide and README #71331

merged 27 commits into from
Apr 20, 2021

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Apr 6, 2021

Changes:

  • Refactors the "Getting Started" content down to one page.
  • Refactors the README to reduce duplicated content and better mirror
    Kibana's README.
  • Focuses the quick start on time series data and features, including data streams
    and runtime fields.
  • Streamlines self-managed install instructions to Docker.

Preview

https://elasticsearch_71331.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/getting-started.html

Changes:

* Refactors the "Getting Started" content down to one page.
* Refactors the README to reduce duplicated content and better mirror
Kibana's.
* Focuses the quick start on time series data, including data streams
and runtime fields.
* Streamlines self-managed install instructions to Docker.
@jrodewig jrodewig marked this pull request as ready for review April 6, 2021 13:57
@jrodewig jrodewig requested a review from a team April 6, 2021 13:57
@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Apr 6, 2021
@elasticmachine
Copy link
Collaborator

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

Copy link
Contributor

@debadair debadair left a comment

Choose a reason for hiding this comment

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

Thanks for doing this--it was getting out of sync with how things have evolved.

docs/reference/getting-started.asciidoc Outdated Show resolved Hide resolved
docs/reference/getting-started.asciidoc Show resolved Hide resolved
docs/reference/getting-started.asciidoc Outdated Show resolved Hide resolved
docs/reference/getting-started.asciidoc Outdated Show resolved Hide resolved
docs/reference/getting-started.asciidoc Outdated Show resolved Hide resolved
docs/reference/getting-started.asciidoc Outdated Show resolved Hide resolved
docs/reference/getting-started.asciidoc Show resolved Hide resolved
docs/reference/tab-widgets/api-call.asciidoc Outdated Show resolved Hide resolved
docs/reference/tab-widgets/api-call.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor Author

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

Thanks so much for the review @debadair. I incorporated most of your changes and responded to some of your comments. Your feedback was really helpful and strengthened the guide.

This is ready for another look when convenient. Thanks again!

docs/reference/getting-started.asciidoc Show resolved Hide resolved
docs/reference/getting-started.asciidoc Outdated Show resolved Hide resolved
docs/reference/getting-started.asciidoc Outdated Show resolved Hide resolved
docs/reference/getting-started.asciidoc Outdated Show resolved Hide resolved
docs/reference/getting-started.asciidoc Outdated Show resolved Hide resolved
"_source": false,
"sort": [
{
"@timestamp": "desc",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good call. I'll remove it.

docs/reference/getting-started.asciidoc Outdated Show resolved Hide resolved
docs/reference/getting-started.asciidoc Show resolved Hide resolved
docs/reference/tab-widgets/api-call.asciidoc Outdated Show resolved Hide resolved
@jrodewig jrodewig requested a review from debadair April 9, 2021 17:46
@jrodewig
Copy link
Contributor Author

@elasticmachine update branch

@gwbrown gwbrown added v7.12.2 and removed v7.12.1 labels Apr 14, 2021
Copy link
Contributor

@debadair debadair left a comment

Choose a reason for hiding this comment

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

Left a couple comments/suggestions, but otherwise LGTM.

docs/reference/getting-started.asciidoc Outdated Show resolved Hide resolved
docs/reference/getting-started.asciidoc Outdated Show resolved Hide resolved
docs/reference/tab-widgets/quick-start-install.asciidoc Outdated Show resolved Hide resolved
@jrodewig
Copy link
Contributor Author

Thanks again @debadair!

@jrodewig jrodewig merged commit b213024 into elastic:master Apr 20, 2021
@jrodewig jrodewig deleted the docs__refactor-quick-start branch April 20, 2021 13:32
jrodewig added a commit that referenced this pull request Apr 20, 2021
Changes:

* Refactors the "Getting Started" content down to one page.
* Refactors the README to reduce duplicated content and better mirror
Kibana's.
* Focuses the quick start on time series data, including data streams
and runtime fields.
* Streamlines self-managed install instructions to Docker.

Co-authored-by: debadair <debadair@elastic.co>
jrodewig added a commit that referenced this pull request Apr 20, 2021
Changes:

* Refactors the "Getting Started" content down to one page.
* Refactors the README to reduce duplicated content and better mirror
Kibana's.
* Focuses the quick start on time series data, including data streams
and runtime fields.
* Streamlines self-managed install instructions to Docker.

Co-authored-by: debadair <debadair@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes Team:Docs Meta label for docs team v7.12.2 v7.13.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants