Skip to content

Problem: AtoM advanced search docs still reference ES 1.7 #359

@fiver-watson

Description

@fiver-watson

Issue found

Found this while looking at the AtoM 2.10 docs today:

AtoM currently uses Elasticsearch version 1.7 - you can find the documentation for AtoM’s ES version here:

See:

Proposed fix

I would recommend removing a specific ES version from this mention. Instead, I suggest something like:

AtoM currently used Elasticsearch - you can review the AtoM installation documentation to determine which ES version your installation is using.

... with a link added for the ES docs.

Note that the ES link I used above is for their legacy versions. It's not super intuitive to find this, but it includes links for all previous major versions back to 0.9, so it's a handy link to have. Given that AtoM will likely never be using the most recent dev or stable ES version, and that this page automatically updates when they version, it seems like a good way to include a stable link that is otherwise not easy to find in the ES documentation. That said, the link is optional and just a suggestion!

Alternatives

  • Just mention ES with no link back to the ES docs at all
  • Link to the most recent ES docs version and let users find the right version themselves
  • Link to the most recent ES docs version, and include an admonition in the docs on how to change the ES docs version
  • Don't even mention ES in this section?

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueAn issue that would be easy for someone who has not worked with the codebase/docs before.minor fixThe change requested by the issue will be minor in scopeuser manualThe issue affects content in the User manual

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions