Misc documentation enhancements#3819
Merged
tillprochaska merged 10 commits intodevelopfrom Aug 1, 2024
Merged
Conversation
tillprochaska
force-pushed
the
docs/misc-follow-ups
branch
from
1bc1819 to
a83beee
Compare
…t-file containers It seems to be a common issue that admins set config options only for some of the containers which leads to problems.
…G` env variable `ALEPH_TAG` is different from other config options (it cannot be specified in `aleph.env`). Also, changing the Aleph version will often require more than just updating this env variable. I think it’s safer for most users to just set the Aleph version/tag in `docker-compose.yml`, because they don’t have to remember to set `ALEPH_TAG` whenever they run a `docker compose` command.
Starting Aleph before running migrations/creating ES indices can cause errors.
Without specifying any services, Docker Compose will start all of them. The default `docker-compose.yml` includes a `shell` service (which is just a bash session) that will exit immediately. This isn’t a problem per se, but it was confusing some users.
tillprochaska
force-pushed
the
docs/misc-follow-ups
branch
from
a83beee to
c9958e3
Compare
Contributor
Author
|
Also fix these two errors:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains a few small documentation enhancements as follow-ups to #3064. The changes are mostly informed by bug reports/questions from users and admins. For details, see the commit messages.