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

Flesh out 'Deploy', sidequest to update 'Get Started' #540

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

Conversation

leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Feb 20, 2025

get-started/

  1. index.md: Major overhaul - Simplified to focus on first steps for users, with clear pathways to learn about Elasticsearch, Kibana, solutions, deployment options, and versioning. Clears out duplication as much possible.

  2. introduction.md: Significant restructuring - Combined Elasticsearch and Kibana overview into a single comprehensive overview, explaining what they are and their use cases. Lots of $$$ to clean up eventually on this page.

  3. the-stack.md: Streamlined - Made more concise and added clearer deployment options references.

  4. versioning-availability.md: New file - Added detailed explanation of:

    • Semantic versioning (X.Y.Z format)
    • Feature availability states (GA, Beta, Preview, etc.)
    • Deployment type variations
  5. deployment-options.md: Simplified to serve as a quick reference for deployment options, using content reuse outlined below.

  6. Removed: installing-elastic-stack.md - anchors moved to deploy-manage section for redirection

deploy-manage/

  1. deploy.md: New comprehensive deployment guide including:
    • Core components overview
    • Detailed deployment options
    • Version compatibility considerations
    • Decision framework for choosing deployment type
    • Cost considerations
  1. New snippet file _snippets/deployment-options-overview.md: Created to maintain consistent deployment options documentation across multiple pages, including:
    • Quick start option (Local development)
    • Hosted options (Cloud Hosted and Serverless)
    • Advanced options (Self-managed, Cloud Enterprise, Cloud on K8s)

@florent-leborgne
Copy link
Contributor

Nice!! Can you change the link to "Kibana" at the end of the-stack.md to point to explore-analyze/index.md?

karenzone
karenzone previously approved these changes Feb 21, 2025
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

Thanks for your work on this. Left comments inline.

GLOBAL:

  • Use present tense
  • Use attributes when available

Otherwise, LGTM

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