Closed friendly-wolfbat closed 4 months ago
Hi @friendly-wolfbat, thanks for opening this issue. You are correct, the documentation isn’t up to date in this regard. We do plan to address this as part of a larger overhaul of the technical documentation. But this may take some time, so we should probably address the issue you brought up earlier than that.
Hi @tillprochaska, thanks for responding. If you can clarify on points 2 and 3 briefly (or link me to some code where I can find the answer), I can put together a pull request for this particular issue to correct the documentation.
Hi @friendly-wolfbat , thanks for noticing and for offering to fix this.
convert-document
is still mentioned. ingest-file
).We're very happy to review your contribution as a PR, but otherwise I can take care of these changes, just let me know. Thanks either way!
I tried my hand at the PR. I think one piece that I'm missing is, if a user wishes to disable threading, how many workers should they have relative to the number of cores, and how many ingest-file containers should they have relative to the number of cores?
On a separate note, I see that the installation instructions also say, "[f]or the purpose of scaling workers and getting more predictable performance [...]"--does this mean that disabling threading and having more containers is "better" in terms of performance, or just more predictable?
@stchris Says we're done here. Thanks for your help @friendly-wolfbat much appreciated
Is your feature request related to a problem? Please describe. The Technical FAQ in docs/src/pages/developers/technical-faq/index.mdx and https://docs.aleph.occrp.org/developers/technical-faq/ mentions
convert-document
, which has been removed per https://github.com/alephdata/aleph/pull/2755. References to this should be removed because right now, users reading the documentation will be confused and unable to apply the steps from the FAQ.Describe the solution you'd like
convert-document
imageingest-file
containers, fourconvert-document
containers and twoworkers
. Depending on howconvert-document
was deprecated, the documentation should say that only four or two workers are recommended in an eight core environmentDescribe alternatives you've considered The alternative is to leave the documentation as is. Doing so will leave it inconsistent with the current state of the stable version of Aleph, negatively impacting user experience.
Additional context See pull request https://github.com/alephdata/aleph/pull/2755