-
Notifications
You must be signed in to change notification settings - Fork 159
Added back ECH plan for production page #1484
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
Conversation
Added back ECH plan for production page as it's important to have
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
blocking while investigating
➕ with the requested changes. In the new docs, the information we used to have in a single place for ECH "plan for production" best practices is now scattered across multiple pages. We definitely need to restructure the content here. |
Thanks @shainaraskas and @romain-chanu Hi Shaina, is there anything we are waiting on? |
thanks @kunisen and @romain-chanu for bringing this. During the migration we merged the content of the original ECH page into multiple pages because of two reasons:
But it's true that after the changes, the interesting parts for ECH users are now spread in multiple pages, together with content that might not be that interesting for pure ECH users. Let me share some responses to your original message:
That's clearly a bug, we shouldn't have redirected it there, you are right.
More than Anyway we understand that having a single source doc to point ECH customers to the most important recommendations for them is really important, instead of sharing multiple links (the I'm ok with bringing this page back, in the TOC either at What I'd like to do afterwards (but this could be in a different PR), would be to enrich the page you are adding back with links towards interesting and relevant areas of the Let me check this with @shainaraskas and we will get back to you with a proposal (either merge this PR and prepare some extra changes soon or directly with a different PR). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also approve with requested changes, and ++++ on (re) separating the ec-*
docs so that we have a dedicated and clear documentation that contains all of the ECH documentation. While I do appreciate the consolidation intent to reduce pages and reduce redundancy, because ECH and Serverless have a number of exceptions, it is much more difficult to find what was once dedicated documentation, which are shared quite often.
I'm ok with bringing this page back, in the TOC either at Deploy -> ECH -> Plan for production or at Production Guidance -> (new page).
+1 for new page - these should be explicit and clear instructions (same as details for host maintenance that we're addressing here). "Bundling" a lot of information can end up creating more questions than providing answers, and is not easy to search for or find if page names are not intuitive.
What I'd like to do afterwards (but this could be in a different PR), would be to enrich the page you are adding back with links towards interesting and relevant areas of the Production Guidance section.
Sounds good to me. Let's please bring the pages back and I'm ok with another PR to help revisit what all needs to come back over into the new docs format so that important ECH documentation is still accurate and easy to understand for all users.
@kunisen , I have applied very small refinement to the added doc, and moved it in the TOC to the third position on the ECH section, right after Create a deployment and Access Kibana elements, to better align with other deploy sections that we have in the docs. Let's add the page back and we will work from there about extra refinements and improving the quality of the content and the doc. |
Edu's comment represents the views of the docs team :)
Thank you @eedugon I am also fine with we have a dedicated section about "production guidance", however, previously we put ECE/ECH under "Elasticsearch" which was wrong IMHO. I think we should consider talking with ECE / ECH / ECK teams, also maybe serverless, and make each product a separate page about "production guidance". For sure there might be overlap, and we can call it out if we feel to put the overlap out is more concise and succinct. Thanks! |
@kunisen :
Yes, we will work on that area. Wait for the next PRs, I'll ping you in everything related with this area. |
Added back ECH plan for production page as it's important to have.
Background & Motivation
Internal GH ticket: https://github.com/elastic/support-tech-lead/issues/1576
TL;DR: This is part of the internal ticket work. In this doc PR, we add the original elastic cloud plan for production page - https://web.archive.org/web/20250404052823/https://www.elastic.co/guide/en/cloud/current/ec-planning.html back to docs v3.
Details:
After PR is merged
a) ECH plan for production page will be back
b) The page will be referenced in below 2 places:
c) The mapped page will change
The mapped page for https://www.elastic.co/guide/en/cloud/current/ec-planning.html will be changed from https://www.elastic.co/docs/deploy-manage/production-guidance/elasticsearch-in-production-environments (because the current map is not very meaningful) to https://www.elastic.co/docs/deploy-manage/deploy/elastic-cloud/elastic-cloud-hosted-planning (available after PR merge).
d) Some minor change
Additional Notes
If we decide not to use the structure I proposed above, please help us at least make the elastic cloud plan for production page a separate page and make it searchable from internet. It's crucial for us (support) to guide customer the proper context. (The deletion of this page actually should not have happened actually but we understand it's during docs migration so it's fine this time.)
Thanks!