Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document how docker-compose-image-tag requires -dev suffixed images #30144

Merged
merged 5 commits into from
Sep 4, 2024

Conversation

mistercrunch
Copy link
Member

@mistercrunch mistercrunch commented Sep 4, 2024

Realized here that docker-compose-image-tag.yml requires a -dev suffixed image to work as expected. Updating default TAG to latest-dev and related docs.

Side mission: removing warning related to version key in docker-compose*.* that are not used/supported anymore

…ages

Realized
[here](#29999 (comment))
that `docker-compose-image-tag.yml` requires a -dev suffixed image to
work as expected. Updating default TAG to latest-dev and related docs.

Side mission: removing warning related to version key in
docker-compose*.* that are not used/supported anymore
@github-actions github-actions bot added the doc Namespace | Anything related to documentation label Sep 4, 2024
@dosubot dosubot bot added the install:docker Installation - docker container label Sep 4, 2024
Copy link
Member

@sfirke sfirke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this will clarify things for a lot of people! I have a few suggestions for clarity and to move from "docker-compose" to "docker compose" as in #30030

docs/docs/installation/docker-compose.mdx Outdated Show resolved Hide resolved
docs/docs/installation/docker-compose.mdx Outdated Show resolved Hide resolved
@@ -30,7 +30,6 @@ x-superset-volumes:
- ./docker:/app/docker
- superset_home:/app/superset_home

version: "3.7"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice touch to get rid of these!

pre-built images from docker-hub. For `docker-compose` to work along with the
Postgres image it boots up, you'll want to point to a `-dev`-suffixed TAG, as in
`export TAG=4.0.0-dev` or `export TAG=3.0.0-dev`, `latest-dev` being the default.
That's because The `dev` builds happen to package the `psycopg2-binary` required to connect
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
That's because The `dev` builds happen to package the `psycopg2-binary` required to connect
That's because `dev` builds package the `psycopg2-binary` required to connect

docs/docs/installation/docker-compose.mdx Outdated Show resolved Hide resolved
mistercrunch and others added 3 commits September 4, 2024 08:54
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
@mistercrunch mistercrunch merged commit 34e240e into master Sep 4, 2024
35 checks passed
@mistercrunch mistercrunch deleted the docs_TAG branch September 4, 2024 16:31
@michael-s-molina michael-s-molina added the v4.1 Label added by the release manager to track PRs to be included in the 4.1 branch label Sep 4, 2024
sadpandajoe pushed a commit that referenced this pull request Sep 5, 2024
…ages (#30144)

Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
(cherry picked from commit 34e240e)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Namespace | Anything related to documentation install:docker Installation - docker container preset-io size/S v4.1 Label added by the release manager to track PRs to be included in the 4.1 branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants