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

Added more robust doucmentation around updates. #10100

Merged
merged 6 commits into from
Oct 19, 2020

Conversation

Ferroin
Copy link
Member

@Ferroin Ferroin commented Oct 19, 2020

Summary
  • Add a section to help users figure out which method they originally used to install Netdata.
  • Update the description of how the manual update process works.
  • Add a fallback command to help users deal with failures using the normal update process for the kickstart.sh and kickstart-static64.sh install methods.
  • Don’t line wrap a long link that is causing problems with syntax highlighting in some editors when manually line-wrapped (it makes the whole document look like one big link).
Component Name

area/docs

Test Plan

n/a

This adds additional documentation about how to update installs with our
installer scripts to help users deal with failed updates.
@github-actions github-actions bot added area/docs area/packaging Packaging and operating systems support labels Oct 19, 2020
or `/opt/netdata/etc/netdata`. You can determine this from the system you installed by running the following command:

```bash
curl -sS http://localhost:19999/netdata.conf | grep 'config directory'

Choose a reason for hiding this comment

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

@Ferroin if the dashboard is down this won't work but it's ok

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, there’s unfortunately not any good way to do this without involving the dashboard or going through a long list of shell commands. I think it’s safe to assume that most users probably don’t actually need this command, but among those who do they are probably using default settings so it should work in most cases.

manos-saratsis
manos-saratsis previously approved these changes Oct 19, 2020
Copy link
Contributor

@joelhans joelhans left a comment

Choose a reason for hiding this comment

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

Looking good! Just a few small requests.

packaging/installer/UPDATE.md Outdated Show resolved Hide resolved
packaging/installer/UPDATE.md Outdated Show resolved Hide resolved
packaging/installer/UPDATE.md Outdated Show resolved Hide resolved
packaging/installer/UPDATE.md Outdated Show resolved Hide resolved
packaging/installer/UPDATE.md Outdated Show resolved Hide resolved
Co-authored-by: Joel Hans <joel.g.hans@gmail.com>
Ferroin and others added 3 commits October 19, 2020 11:07
Co-authored-by: Joel Hans <joel.g.hans@gmail.com>
Co-authored-by: Joel Hans <joel.g.hans@gmail.com>
Co-authored-by: Joel Hans <joel.g.hans@gmail.com>
joelhans
joelhans previously approved these changes Oct 19, 2020
This makes the section about determining your installation type shorter
and more concise and avoids duplication of documentation.
@Ferroin Ferroin merged commit c6476bb into netdata:master Oct 19, 2020
@Ferroin Ferroin deleted the updater-docs branch October 19, 2020 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs area/packaging Packaging and operating systems support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants