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] Updates 7.0 upgrade guide #34121

Merged
merged 11 commits into from
Apr 1, 2019
Merged

Conversation

schersh
Copy link
Contributor

@schersh schersh commented Mar 28, 2019

Summary

This PR updates the Upgrading Kibana docs for 7.0. You can build these docs locally by pulling down these changes and running node scripts/docs.js --open.

This PR makes the following changes:

  • Removes the table of historical upgrade information from this page: https://www.elastic.co/guide/en/kibana/7.0/upgrade.html and updates the page to highlight information that is relevant to upgrading to 7.0 (see screenshot below). Note: The information for earlier upgrades is still available in earlier branches.
  • Highlights the Stack upgrade guide as the main source of truth: https://www.elastic.co/guide/en/elastic-stack/7.0/upgrading-elastic-stack.html
  • Adds note about the Upgrade Assistant to all upgrade pages.
  • Incorporates information from the reindexing page to the main home page, and links to information about reindexing in the Stack upgrade guide. Removes "Standard Upgrade with Reindex" page.
  • Removes "New Installation" page for the 7.0 branch. This information is only relevant to users upgrading from 3.x or earlier, so it is not relevant to include in more recent branches.
  • Renames the "Saved object migrations" page to "Troubleshooting saved object migrations". This might not be the best title, but I want to make it clear to users that this page has additional reference material, but does not include any steps that are required to the standard upgrade process.

New "Upgrading Kibana" page:

Screen Shot 2019-03-29 at 10 16 50 AM

[skip ci]

Checklist

  • [x ] Documentation was added for features that require explanation or tutorials

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs

@schersh schersh marked this pull request as ready for review March 29, 2019 13:40
@schersh
Copy link
Contributor Author

schersh commented Mar 29, 2019

@lcawl I noticed that Deb included the x-pack label on the Upgrade Assistant in the Stack guide - the Kibana docs do not include this label for the UA: https://www.elastic.co/guide/en/kibana/7.0/upgrade-assistant.html, so I haven't included it here. I think we've only been using the x-pack label for Platinum and Gold licensed features (not Basic). Do you have any guidance here?

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

LGTM

@lcawl
Copy link
Contributor

lcawl commented Mar 29, 2019

I think we've only been using the x-pack label for Platinum and Gold licensed features (not Basic)....

We use that icon on pages related to basic features too.

docs/setup/upgrade.asciidoc Outdated Show resolved Hide resolved
docs/setup/upgrade.asciidoc Outdated Show resolved Hide resolved
system.
. Use `rpm` or `dpkg` to install the new package. All files should be placed in
their proper locations and config files should not be overwritten.
+
[NOTE]
--
Kibana 4.x used a different config location than 5.0+, so if you're upgrading
{kib} 4.x used a different config location than 5.0+, so if you're upgrading
Copy link
Contributor

Choose a reason for hiding this comment

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

This content seems out-dated to me. Is it still required?

@@ -1,40 +1,40 @@
[[upgrade-standard]]
=== Standard Upgrade
=== Standard upgrade
Copy link
Contributor

Choose a reason for hiding this comment

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

Something to consider... since there's no longer a non-standard upgrade, you could potentially split this content into two pages to match the pages under "Installing Kibana". For example:

Set Up Kibana
-- Installating Kibana
----Install Kibana with .tar.gz
----Install Kibana with Debian Package
...
-- Upgrading Kibana
---- Upgrade Kibana with .tar.gz
---- Upgrade Kibana with RPM or Debian package

docs/setup/upgrade.asciidoc Outdated Show resolved Hide resolved
lcawl and others added 3 commits April 1, 2019 08:22
Co-Authored-By: schersh <schersh@users.noreply.github.com>
Co-Authored-By: schersh <schersh@users.noreply.github.com>
@schersh schersh merged commit d1ec076 into elastic:7.0 Apr 1, 2019
@schersh schersh deleted the docs/kib-upgrade-7.0 branch April 1, 2019 18:28
schersh added a commit that referenced this pull request Apr 1, 2019
schersh added a commit to schersh/kibana that referenced this pull request Apr 2, 2019
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.

None yet

4 participants