Installation and Upgrade Documentation - #1
Conversation
This provides the cross-stack documentation for the Elastic Stack, by linking to the other repos and providing the required order for a low-impact upgrade.
There was a problem hiding this comment.
Table should say "Component"
There was a problem hiding this comment.
Table should say "Component"
|
Unsure if I should use "Component" versus "Product" everywhere. |
There was a problem hiding this comment.
Section IDs show up in URLs, so you should probably call this install-order-elastic-stack
There was a problem hiding this comment.
sentence is a bit hard to parse. Maybe just say, "We recommend that you install the Elastic Stack in the following order." (When you talk about upgrading, then you mention that order is important.)
There was a problem hiding this comment.
should be Installing Elasticsearch.... (to be consistent).
There was a problem hiding this comment.
Folks installing the Elastic Stack for the first time need this info, too. I'd suggest moving the general overview content to an overview topic that introduces the Elastic Stack and describes what the guide covers. Then all users will benefit, and you won't have to worry about the order that you list the products in.
There was a problem hiding this comment.
Moved it over to the overview section.
There was a problem hiding this comment.
This sentence doesn't read quite right (missing word). I'd suggest being more direct/less passive here. Maybe say: "To maintain the most compatibility, you must upgrade the stack in the recommended order."
There was a problem hiding this comment.
Change to "The upgrade requires a full cluster shutdown for both Elasticsearch... (fixes unclear antecedent and typo)
There was a problem hiding this comment.
I had to read this twice to parse it.
There was a problem hiding this comment.
Reworded and dropped mentioning of Kibana.
There was a problem hiding this comment.
Suggested edit: "The following table lists the upgrade instructions and breaking changes for each component. Before upgrading, make sure you read through the upgrade guide and breaking changes list for every component that you are upgrading."
I wouldn't even say should.
|
Added a few minor comments. Otherwise, LGTM. |
There was a problem hiding this comment.
Should there be just 2 columns here - Product and Installation?
There was a problem hiding this comment.
There was a problem hiding this comment.
Linking to both kind of goes against the flow. If I have to link to both, then that's okay, but I'd prefer to not have to distinguish between the installs.
There was a problem hiding this comment.
Since we are mentioning X-Pack in the previous table, maybe add a short statement on how Elastic Cloud will also install X-Pack for them?
There was a problem hiding this comment.
Include Reporting here, for Reporting is 2.4.
There was a problem hiding this comment.
Elasticsearch 1.x uses Lucene 4.x; Elasticsearch 2.x uses Lucene 5.x; and Elasticsearch 5.x uses Lucene 6.x. Lucene 6.x is not compatible with Lucene 4.x
Might be better to demonstrate this using a table with 3 columns, 1st column is Elasticsearch version, 2nd column is Lucene version, and 3rd column is Requires reindexing/Not compatible, etc..
There was a problem hiding this comment.
includes simple indices
How about "includes system indices"
There was a problem hiding this comment.
Perhaps we can link to https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-snapshots.html#modules-snapshots which has a paragraph that talks about what to do with 1.x snapshots.
There was a problem hiding this comment.
+4. Kibana
Which now includes Console (previously known as Sense) and Timelion
+5. X-Pack for Kibana (combines Marvel Agent, Shield, and Graph)
Add Reporting here.
Do we mean "Marvel", instead of "Marvel Agent" here?
|
@pickypg just seen this https://www.elastic.co/guide/en/elastic-stack/5.1/upgrading-elastic-stack.html and loving it. kudos for the great work! |
This provides the cross-stack documentation for the Elastic Stack, by linking to the other repos and providing the required order for a low-impact upgrade.
/cc @dedemorton @debadair @nrichers