Skip to content

Better docs for repo analysis failures #101190

Open
@DaveCTurner

Description

@DaveCTurner

Today the docs for the repository analysis API say that failures are evidence of incompatibilities, but we do not go into much detail about the exact error messages returned by the API. We should address this to avoid users needing to open support cases to ask for help interpreting its results:

  • Introduce specific docs for each error the API might return.
  • Use org.elasticsearch.common.ReferenceDocs to add a link to the specific docs from each error message.
  • Extend the "Implementation details" docs to mention register operations.
  • Document a little more detail about the compare-and-exchange implementation for each repository type, particularly S3.

Metadata

Metadata

Assignees

No one assigned

    Labels

    :Distributed Coordination/Snapshot/RestoreAnything directly related to the `_snapshot/*` APIs>docsGeneral docs changesSupportabilityImprove our (devs, SREs, support eng, users) ability to troubleshoot/self-service product better.Team:Distributed (Obsolete)Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination.Team:DocsMeta label for docs team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions