Use 'Install' wording for self-managed docs#5310
Conversation
✅ Vale Linting ResultsNo issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
🔍 Preview links for changed docs |
| @@ -6,7 +6,7 @@ navigation_title: Deploy an orchestrator | |||
There was a problem hiding this comment.
Should the nav title be updated to reflect this as well?
There was a problem hiding this comment.
I left that on purpose (at least temporary :) ), as I like the "Deploy an orchestrator" in the navigation, but the title of the doc would be better for SEO and clarity purposes to be called "Install an {{ece}} orchestrator".
Anyway I'd like to wait for Shaina's feedback as maybe we prefer the "deploy" message everywhere for this doc set. In that case I'd undo the change entirely.
But yes, if we go for "install" we also need to decide if we change the nav title too (as I've done in Elasticsearch --> well I haven't because that doc didn't have explicit nav_title :) ). Thanks!
There was a problem hiding this comment.
I prefer them matching the verb as well :)
|
@shainaraskas , I'd like to get your opinion here:
In this PR I've made small update for the ECE doc, and discarded any change on ECK. But if you prefer I can undo all changes and keep only the Elasticsearch change, which is the change originally requested at https://github.com/elastic/docs-content-internal/issues/806 |
yetanothertw
left a comment
There was a problem hiding this comment.
Looks good to me, thanks!
I left a small q about the nav title.
|
@eedugon given the cause of this issue, I'd go with matching whatever is in the old docs. So, you're correct. ECE uses "install" https://www.elastic.co/guide/en/cloud-enterprise/3.8/ece-installing.html thanks for checking in (but I trust your instincts here!) |
Summary
Why
This is a small SEO-driven wording update: users are more likely to search for install than deploy when they are setting up self-managed platforms like installing Elasticsearch on premises (and I'd also expect the same to install ECE).
For self-managed platforms, install is the most accurate verb. In contrast, for ECH or Serverless, different wording is more appropriate because users are not installing any component themselves.
Closes https://github.com/elastic/docs-content-internal/issues/806
Made with Cursor