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.

Sign up for GitHub

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

Jump to bottom

Added 'Upgrading Kibana' section to install docs #7807

Merged
merged 5 commits into from
Aug 5, 2016
Merged

Added 'Upgrading Kibana' section to install docs #7807

merged 5 commits into from
Aug 5, 2016

Conversation

LeeDr
Copy link

@LeeDr LeeDr commented Jul 22, 2016

Addressing the first task "Upgrade documentation, especially in the context of rolling upgrades" of #5347

NOTE: This section for installs from repositories was commented out before. I uncommented it. Maybe it was temporarily commented out just during 5.0 alphas?

[float]
include::kibana-repositories.asciidoc[]

@epixa
Copy link
Contributor

epixa commented Jul 22, 2016

The repositories stuff is commented out because you cannot install master from package repos. The section gets uncommented in the actual release branches (5.0, 4.5, etc.).

epixa
epixa reviewed Jul 22, 2016
View reviewed changes
docs/setup.asciidoc
. https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[snapshot] existing `.kibana` index in Elasticsearch
. save a backup copy of the existing `config/kibana.yml`
. take note of the Kibana plugins that are installed;
.. `/opt/kibana/bin/kibana plugin --list` on 4.x versions of Kibana.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we should hardcode these absolute paths in the docs since different install mechanisms are going to result in different paths.

@tbragin
Copy link
Contributor

tbragin commented Jul 23, 2016

@LeeDr Thanks for getting this started!

A couple of comments:

  • Versioning
    • We have versioned documentation, so instead of saying in 4.x and 5.x we should simply show correct instructions in each version.
  • Consistency
    • Capitalization: Generally should use a capital letter at the beginning or end of bullet
  • Content
    • I like the "upgrading" section, but it feels like the new install from packages section is still light (or even gone?). Where is this section in this version of the docs? With 4.6 changes we're planning, will our install locations be more consistent with ES? Regardless, I still think we should document them (see this issue).

@LeeDr
Copy link
Author

LeeDr commented Jul 27, 2016

@debadair you had made a comment about bullets instead of numbered list for the upgrade section. The basic install steps above it are bullets. But the Install and Start Kibana from Archive File section below it was numbered. Should I change just the upgrade section from numbers to bullets? And should I also change the Install and Start Kibana from Archive File section to bullets?

debadair
debadair reviewed Jul 28, 2016
View reviewed changes
docs/setup.asciidoc

. Create a https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[snapshot] of the existing .kibana index.
. Back up the `kibana.yml` configuration file.
. Take note of the Kibana plugins that are installed;
Copy link
Contributor

Choose a reason for hiding this comment

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

Colon, instead of semicolon. :-)

@debadair
Copy link
Contributor

Made a few very picky comments--incorporate or ignore as you see fit. Other than that, LGTM!

@LeeDr
Copy link
Author

LeeDr commented Aug 3, 2016

@debadair ready for another review. Thanks!

@debadair
Copy link
Contributor

debadair commented Aug 3, 2016

LGTM!

@LeeDr LeeDr merged commit 13bdc52 into elastic:master Aug 5, 2016
@elastic-jasper elastic-jasper mentioned this pull request Aug 10, 2016
Closed
elastic-jasper added a commit that referenced this pull request Aug 10, 2016
@elastic-jasper
Backport PR #7807
fdd99ee 
---------

**Commit 1:**
Added 'Upgrading Kibana' section

* Original sha: 32ed1ce
* Authored by LeeDr <[email protected]> on 2016-07-22T18:25:11Z

**Commit 2:**
Updated from review comments, re-commented-out repository part for master

* Original sha: 50d540d
* Authored by LeeDr <[email protected]> on 2016-07-25T15:52:16Z

**Commit 3:**
Change some indented numbered items to bullets

* Original sha: ee42c47
* Authored by Lee Drengenberg <[email protected]> on 2016-07-28T21:44:16Z
* Committed by GitHub <[email protected]> on 2016-07-28T21:44:16Z

**Commit 4:**
Update setup.asciidoc

* Original sha: 9ccf1df
* Authored by Lee Drengenberg <[email protected]> on 2016-07-29T13:40:39Z
* Committed by GitHub <[email protected]> on 2016-07-29T13:40:39Z

**Commit 5:**
Update setup.asciidoc

* Original sha: 48371a4
* Authored by Lee Drengenberg <[email protected]> on 2016-08-03T16:27:32Z
* Committed by GitHub <[email protected]> on 2016-08-03T16:27:32Z
elastic-jasper added a commit that referenced this pull request Aug 10, 2016
@elastic-jasper
Backport PR #7807
cc63450 
---------

**Commit 1:**
Added 'Upgrading Kibana' section

* Original sha: 32ed1ce
* Authored by LeeDr <[email protected]> on 2016-07-22T18:25:11Z

**Commit 2:**
Updated from review comments, re-commented-out repository part for master

* Original sha: 50d540d
* Authored by LeeDr <[email protected]> on 2016-07-25T15:52:16Z

**Commit 3:**
Change some indented numbered items to bullets

* Original sha: ee42c47
* Authored by Lee Drengenberg <[email protected]> on 2016-07-28T21:44:16Z
* Committed by GitHub <[email protected]> on 2016-07-28T21:44:16Z

**Commit 4:**
Update setup.asciidoc

* Original sha: 9ccf1df
* Authored by Lee Drengenberg <[email protected]> on 2016-07-29T13:40:39Z
* Committed by GitHub <[email protected]> on 2016-07-29T13:40:39Z

**Commit 5:**
Update setup.asciidoc

* Original sha: 48371a4
* Authored by Lee Drengenberg <[email protected]> on 2016-08-03T16:27:32Z
* Committed by GitHub <[email protected]> on 2016-08-03T16:27:32Z
@elastic-jasper elastic-jasper mentioned this pull request Aug 10, 2016
Closed
elastic-jasper added a commit that referenced this pull request Aug 10, 2016
@elastic-jasper
Backport PR #7807
83ebe06 
---------

**Commit 1:**
Added 'Upgrading Kibana' section

* Original sha: 32ed1ce
* Authored by LeeDr <[email protected]> on 2016-07-22T18:25:11Z

**Commit 2:**
Updated from review comments, re-commented-out repository part for master

* Original sha: 50d540d
* Authored by LeeDr <[email protected]> on 2016-07-25T15:52:16Z

**Commit 3:**
Change some indented numbered items to bullets

* Original sha: ee42c47
* Authored by Lee Drengenberg <[email protected]> on 2016-07-28T21:44:16Z
* Committed by GitHub <[email protected]> on 2016-07-28T21:44:16Z

**Commit 4:**
Update setup.asciidoc

* Original sha: 9ccf1df
* Authored by Lee Drengenberg <[email protected]> on 2016-07-29T13:40:39Z
* Committed by GitHub <[email protected]> on 2016-07-29T13:40:39Z

**Commit 5:**
Update setup.asciidoc

* Original sha: 48371a4
* Authored by Lee Drengenberg <[email protected]> on 2016-08-03T16:27:32Z
* Committed by GitHub <[email protected]> on 2016-08-03T16:27:32Z
@elastic-jasper elastic-jasper mentioned this pull request Aug 10, 2016
Closed
LeeDr pushed a commit that referenced this pull request Aug 10, 2016
[BACKPORT] PR #7807 to 4.5 setup.asciidoc
117eadd 
Manually backporting because jarvis didn't work
LeeDr pushed a commit that referenced this pull request Aug 10, 2016
[BACKPORT] PR #7807 to 4.x setup.asciidoc
2868233
airow pushed a commit to airow/kibana that referenced this pull request Feb 16, 2017
Merge pull request elastic#7807 from LeeDr/installDocUpdate
8097f9f 
Added 'Upgrading Kibana' section to install docs

Former-commit-id: 13bdc52
@LeeDr LeeDr deleted the installDocUpdate branch May 23, 2017 13:57
adiupendra added a commit to voziq/kibana that referenced this pull request Jan 5, 2021
@adiupendra
Story elastic#7807
1f77b75 
Tooltip issue in HeatMap (Need to display Label value )
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@debadair debadair

Labels
review Team:Docs v5.0.0-beta1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@LeeDr @epixa @tbragin @debadair