Skip to content

Conversation

leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Nov 14, 2024

Addresses https://github.com/elastic/platform-docs-team/issues/537 + #78 (comment)

👁️ URL preview

ℹ️ These changes focus on the ES3 docs, I don't know if we'll have time to consolidate and collaborate with other docs teams on moving this stuff up to a higher level before GA.

ℹ️ This is very drafty, if you'd prefer to work in the shadow Google Doc then comment there

Summary

Consolidate Elasticsearch tech preview limitations + serverless differences,clarify API/setting availabilities

  • Better structural organization - Moving the serverless differences section earlier in the documentation hierarchy for visibility
  • More detailed explanations of:
    • Infrastructure management changes
    • Specific API and settings availability
    • Clear categorization of features into replaced, planned, and permanently unavailable
    • Added clarity around error handling - The inclusion of specific error message examples helps developers understand and handle unavailable API responses.

🔨 TODO

  • Update alerting link

@leemthompo leemthompo requested a review from a team as a code owner November 14, 2024 14:10
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

shainaraskas
shainaraskas previously approved these changes Nov 18, 2024
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.

✅ with some cosmetic / clarity recommendations to take or leave!


[discrete]
[[elasticsearch-differences-serverless-infrastructure-management]]
== Fully managed infrastructure
Copy link
Collaborator

Choose a reason for hiding this comment

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

vv helpful section

leemthompo and others added 4 commits November 18, 2024 16:25
- Reorganized sections for clearer structure
- Separated API and settings into distinct top-level sections
- Streamlined API error handling content
- Converted nested sections to bullet points

- Removed redundant API availability intro text
- Added "Replaced features" subsection
- Improved formatting of alternatives for unavailable features
- Enhanced documentation cross-references

- Added consistent section spacing
- Fixed bullet point formatting
- Standardized list presentation

Some features that are available in Elastic Cloud Hosted and self-managed offerings are not available in {es-serverless}.
These features have either been replaced by a new feature, or are not applicable in the new Serverless architecture:
These features have either been replaced by a new feature, or are not applicable in the new serverless architecture.
Copy link
Collaborator

Choose a reason for hiding this comment

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

this does not cover planned features

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.

finished my re-review - just a tiny bug to fix then I can ✅

shainaraskas
shainaraskas previously approved these changes Nov 20, 2024
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.

just made the lil tweak myself to save you some cycles hopefully

@leemthompo leemthompo merged commit 353b9dd into elastic:main Nov 21, 2024
2 checks passed
@leemthompo leemthompo deleted the dedupe branch November 21, 2024 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants