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

[Serverless]: Project settings: Broken links, typos, and editorial stuff on project management docs main page #88

Closed
timto-elastic opened this issue Oct 21, 2024 · 2 comments
Assignees
Labels
Serverless bug bash 🐛 Issues discovered during the Serverless UX bug bash

Comments

@timto-elastic
Copy link

timto-elastic commented Oct 21, 2024

Serverless Docs

Project and management settings

Description

The solution links for observability, search, and security badged items on https://www.elastic.co/docs/current/serverless/project-and-management-settings are broken.

Broken links:

In main text:
https://www.elastic.co/docs/serverless/elasticsearch/what-is-elasticsearch-serverless
https://www.elastic.co/docs/serverless/observability/what-is-observability-serverless
https://www.elastic.co/docs/serverless/security/what-is-security-serverless

Typo: the link text for serverless Elasticsearch docs should be Elasticsearch serverless docs

Editorial:
Why does there need to be an admonition that has links that go to the same content in the main body text? Also I can't tell that those target pages (which are the what is pages) tell me about how project settings are different across solutions or if I am using a solution where I would look. Should we be just showing a list here?

Also Integrations and fleet/agent are also in this bucket. Should we be talking about what those are here? We are inferring project management here I think but not the broader category of things in this bucket and what they are for. Also connector clients are in the search docs and but not listed on the integrations page (https://www.elastic.co/docs/current/serverless/integrations). I would assume we want to link to
https://www.elastic.co/docs/current/serverless/elasticsearch/ingest-data-through-integrations-connector-client since we call the connectors "integrations" in search.

Resources and additional context

https://www.elastic.co/docs/current/serverless/project-and-management-settings
Image

@timto-elastic timto-elastic changed the title [Serverless]: Broken links, typos, and editorial stuff on project management docs main page [Serverless]: Project settings: Broken links, typos, and editorial stuff on project management docs main page Oct 21, 2024
@leemthompo
Copy link
Contributor

#149 addresses:

  • Broken links
  • Typo
  • Editorial (by deleting unnecessary admonition)

@KOTungseth KOTungseth added the Serverless bug bash 🐛 Issues discovered during the Serverless UX bug bash label Oct 29, 2024
@bmorelli25
Copy link
Member

Fixed by migration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Serverless bug bash 🐛 Issues discovered during the Serverless UX bug bash
Projects
None yet
Development

No branches or pull requests

4 participants