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

[D&M] Drafts maintenance content #421

Open
wants to merge 33 commits into
base: main
Choose a base branch
from
Open

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Feb 12, 2025

Overview

Related to https://github.com/elastic/docs-projects/issues/353
This PR:

  • adds an introductory paragraph to the Maintenance overview that lists the main topics covered in the section
  • adds a "super-brief" intro to the Start and stop services section
  • drafts the Start and stop ES section by merging the contents of two source files (starting-elasticsearch.md and stopping-elasticsearch.md) and adding an intro to the page
  • drafts ECE maintenance intro and adds Enabling Kibana content to the page (as a temporary solution)
  • drafts Maintenance activities section
  • drafts Start and stop services section
  • refines existing pieces.

@szabosteve szabosteve added the documentation Improvements or additions to documentation label Feb 12, 2025
@szabosteve szabosteve changed the title [D&M] Drafts maintenance intro [D&M] Drafts maintenance content Feb 13, 2025
Copy link
Collaborator

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

this looks very very good!

most of my comments are nitpicks and little typo things I saw. overall:

  • Please add applies_to to all pages (the new syntax is out now)
  • From overview pages, link down to the pages you're referring to
  • Duplicate content about adding nodes can be removed from the "start/stop es" topic
  • Noted where some small glue content and clarification about what procedures apply to what deployment types would be helpful (and hopefully quick)

deploy-manage/maintenance.md Outdated Show resolved Hide resolved
deploy-manage/maintenance.md Show resolved Hide resolved
deploy-manage/maintenance.md Outdated Show resolved Hide resolved
deploy-manage/maintenance.md Outdated Show resolved Hide resolved
deploy-manage/maintenance.md Show resolved Hide resolved
deploy-manage/maintenance/start-stop-services.md Outdated Show resolved Hide resolved
deploy-manage/maintenance/start-stop-services.md Outdated Show resolved Hide resolved
deploy-manage/maintenance.md Show resolved Hide resolved
Copy link
Collaborator

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

I've provided some suggestions re: changes to the "applies_to" tags. most of my reasoning is based on extrapolating other info in the page (e.g. the install methods on start/stop es are just self-managed install methods). let me know if you disagree with any of the labeling.

sry for the second round of comments - it's looking vv great, just want to make sure we have the page scopes right 🎯

@@ -1,6 +1,13 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-kibana.html
applies_to:
stack:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we can leave the stack label out of here because all of these pages are very deployment type specific. same for all pages

Suggested change
stack:

Comment on lines +37 to +39
* [ECE](../deploy/cloud-enterprise/resize-deployment.md)
* [ECH](../deploy/elastic-cloud/configure.md)
* [ECK](../deploy/cloud-on-k8s/update-deployments.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* [ECE](../deploy/cloud-enterprise/resize-deployment.md)
* [ECH](../deploy/elastic-cloud/configure.md)
* [ECK](../deploy/cloud-on-k8s/update-deployments.md)
* [{{ece}}](../deploy/cloud-enterprise/resize-deployment.md)
* [{{ech}}](../deploy/elastic-cloud/configure.md)
* [{{eck}}](../deploy/cloud-on-k8s/update-deployments.md)

* [starting and stopping Elasticsearch](start-stop-services/start-stop-elasticsearch.md)
* [starting and stopping Kibana](start-stop-services/start-stop-kibana.md)
* [restarting an ECE deployment](start-stop-services/restart-an-ece-deployment.md)
* [restarting cloud-hosted deployments](start-stop-services/restart-cloud-hosted-deployment.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* [restarting cloud-hosted deployments](start-stop-services/restart-cloud-hosted-deployment.md)
* [restarting {{ech}} deployments](start-stop-services/restart-cloud-hosted-deployment.md)

applies_to:
stack:
deployment:
eck:
Copy link
Collaborator

Choose a reason for hiding this comment

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

none of this applies to ECK

Suggested change
eck:

Comment on lines +4 to +10
applies_to:
stack:
deployment:
eck:
ess:
ece:
self:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
applies_to:
stack:
deployment:
eck:
ess:
ece:
self:
applies_to:
deployment:
self:

Comment on lines +5 to +9
applies_to:
deployment:
eck:
ess:
ece:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
applies_to:
deployment:
eck:
ess:
ece:
applies_to:
deployment:
ess:

Comment on lines +5 to +11
applies_to:
stack:
deployment:
eck:
ess:
ece:
self:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
applies_to:
stack:
deployment:
eck:
ess:
ece:
self:
applies_to:
deployment:
self:

Comment on lines +4 to +10
applies_to:
stack:
deployment:
eck:
ess:
ece:
self:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
applies_to:
stack:
deployment:
eck:
ess:
ece:
self:
applies_to:
deployment:
self:

Comment on lines +15 to +16
* [starting and stopping Elasticsearch](start-stop-services/start-stop-elasticsearch.md)
* [starting and stopping Kibana](start-stop-services/start-stop-kibana.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* [starting and stopping Elasticsearch](start-stop-services/start-stop-elasticsearch.md)
* [starting and stopping Kibana](start-stop-services/start-stop-kibana.md)
* [starting and stopping self-managed Elasticsearch nodes](start-stop-services/start-stop-elasticsearch.md)
* [starting and stopping self-managed Kibana instances](start-stop-services/start-stop-kibana.md)

* [starting and stopping Kibana](start-stop-services/start-stop-kibana.md)
* [restarting an ECE deployment](start-stop-services/restart-an-ece-deployment.md)
* [restarting cloud-hosted deployments](start-stop-services/restart-cloud-hosted-deployment.md)
* [full cluster and rolling restarts](start-stop-services/full-cluster-restart-rolling-restart-procedures.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* [full cluster and rolling restarts](start-stop-services/full-cluster-restart-rolling-restart-procedures.md)
* [full cluster and rolling restarts for self-managed clusters](start-stop-services/full-cluster-restart-rolling-restart-procedures.md)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants