Skip to content

Conversation

kunisen
Copy link
Contributor

@kunisen kunisen commented Dec 20, 2024

Description

Relaunch #116892 since the original one seems to be outdated and hard to update branch. It's copying 10fb2b1 without any further contents update.

Thanks @stefnestor for reaching out and sync. As we chatted, since #116892 is outdated and seems hard to update branch (to merge current main branch to the PR), I copied the contents out from original one manually and created this one. Let's keep your style this time (on ES doc).

For the cloud side doc PR how to handle, let's discuss further offline. 🙏

Relaunch #116892 since the original one seems to be outdated and hard to update branch.
@kunisen kunisen added >enhancement >docs General docs changes Team:Docs Meta label for docs team external-contributor Pull request authored by a developer outside the Elasticsearch team v9.0.0 v8.18.0 labels Dec 20, 2024
@kunisen kunisen requested a review from stefnestor December 20, 2024 04:46
Copy link
Contributor

Documentation preview:

@kunisen kunisen requested a review from a team December 20, 2024 04:46
@elasticsearchmachine
Copy link
Collaborator

@kunisen please enable the option "Allow edits and access to secrets by maintainers" on your PR. For more information, see the documentation.

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

Copy link
Contributor

@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.

A couple of notes and a question!

Comment on lines +119 to +125
TIP: On {ess} and {ece}, indices may need to be temporarily deleted via
its {cloud}/ec-api-console.html[Elasticsearch API Console] to later
<<snapshots-restore-snapshot,snapshot restore>> in order to resolve
<<cluster-health,cluster health>> `status:red` which will block
{cloud}/ec-activity-page.html[attempted changes]. If you experience issues
with this resolution flow on {ess}, kindly reach out to
https://support.elastic.co[Elastic Support] for assistance.
Copy link
Contributor

Choose a reason for hiding this comment

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

can we explain why they have to do the deletion here? how does someone determine if this note applies to them?

@leemthompo
Copy link
Contributor

@kunisen @stefnestor @shainaraskas are we happy to try to merge this today?

@leemthompo
Copy link
Contributor

Important

Elastic documentation is migrating to Markdown for version 9.0+. See the migration guide for details.

ℹ️ What's happening?

  • Starting January 29, we will start closing all unmerged documentation PRs targeting main/master
  • We're migrating from AsciiDoc to Markdown for 9.0+
  • 9.0 docs will be frozen from January 29 until February 20 2024
  • NOTE: PRs that include both code and documentation changes will remain open

What do I need to do?

For <=8.x docs:

  1. Rebase your PR to target the relevant 8.x branch instead
  2. The content can remain in AsciiDoc format

For 9.0+ docs:

Option 1:

  • Draft docs in Markdown
  • Once migration freeze ends, find the relevant page in the new docs system and use the edit options to submit your changes

Option 2:

💡 Need help?

  1. For Elasticians: Ask in #docs Slack channel
  2. For external contributors: Open an issue in elastic/docs-content

@leemthompo leemthompo merged commit a0f1856 into main Jan 29, 2025
6 checks passed
@leemthompo leemthompo deleted the kunisen-docpr-es-116892 branch January 29, 2025 18:31
@leemthompo
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.x

Questions ?

Please refer to the Backport tool documentation

elasticsearchmachine pushed a commit that referenced this pull request Jan 29, 2025
* (Doc+) Expand watermark resolution

Relaunch #116892 since the original one seems to be outdated and hard to update branch.

* Apply suggestions from code review

Co-authored-by: shainaraskas <[email protected]>

---------

Co-authored-by: shainaraskas <[email protected]>
(cherry picked from commit a0f1856)

Co-authored-by: Kuni Sen <[email protected]>
@kunisen
Copy link
Contributor Author

kunisen commented Jan 30, 2025

Thank you all!

TIL from 9.0 we use markdown! thanks for the heads up too!
#119174 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes >enhancement external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Docs Meta label for docs team v8.18.0 v9.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants