artefactual / artefactual/atom-docs

Problem: ES optimization recommendations in Admin manual are out of date for current ES version

Open
#321 0 comments 0 reactions 0 assignees View on GitHub
admin manual good first issue minor fix
Dominant language
Python
Stars
21
Forks
31
PR merge metrics
No merged PRs in 30d

Description

Reported in the user forum, 2025-06-18:

* https://groups.google.com/g/ica-atom-users/c/OmfPCKEMo4w/m/U6w3ECYLBgAJ

In the 2.9 Admin doc page on Elasticsearch, it recommends disabling auto-discovery by setting the Transport Type to Local for performance:

* https://www.accesstomemory.org/docs/2.9/admin-manual/maintenance/elasticsearch/#disable-auto-discovery

However, as of ES 6.0 and later, Local Transport has been removed. Attempting to make this change in AtoM 2.9 or later causes ES to crash. See:

* https://discuss.elastic.co/t/no-more-local-transport-on-6-0-x/102416

Contributor guide

No contributing guide indexed for this repository

Research direction

Open the 2.9 Admin manual’s Elasticsearch page and inspect the “Disable auto-discovery” section, using the linked Elasticsearch discussion to confirm that Local Transport was removed in ES 6. Update the recommendation so it no longer directs users to a setting that crashes Elasticsearch, then verify the rendered documentation reflects the current guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
elasticsearch
Domain
documentation, search
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.