Skip to content

docs(docker): fix compose file name and update error message path #33858

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

Closed
wants to merge 1 commit into from

Conversation

hu-qi
Copy link

@hu-qi hu-qi commented Jun 23, 2025

SUMMARY

This PR updates the Superset Docker documentation to correct the filename from compose-image-tag.yml to docker-compose-image-tag.yml in the startup instructions. It also updates the related error message path for consistency.

These changes ensure users can start Superset using Docker Compose without confusion and avoid outdated filenames.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Not applicable

TESTING INSTRUCTIONS

  1. Check out the tags/4.1.2 release.

  2. Run the updated command:

    docker compose -f docker-compose-image-tag.yml up  
  3. Confirm that Superset starts correctly and the file reference matches.

  4. Optionally, test with an outdated docker-compose to verify the updated error message.

ADDITIONAL INFORMATION

  • Has associated issue:

  • Required feature flags:

  • Changes UI

  • Includes DB Migration (follow approval process in [SIP-59]([SIP-59] Proposal for Database migration standards #13351))

    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API

  • Removes existing feature or API


@github-actions github-actions bot added the doc Namespace | Anything related to documentation label Jun 23, 2025
Copy link

@korbit-ai korbit-ai bot left a comment

Choose a reason for hiding this comment

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

I've completed my review and didn't find any issues.

Files scanned
File Path Reviewed
docs/docs/quickstart.mdx

Explore our documentation to understand the languages and file types we support and the files we ignore.

Check out our docs on how you can make Korbit work best for you and your team.

Loving Korbit!? Share us on LinkedIn Reddit and X

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Congrats on making your first PR and thank you for contributing to Superset! 🎉 ❤️

We hope to see you in our Slack community too! Not signed up? Use our Slack App to self-register.

@hainenber
Copy link
Contributor

Hi and thanks for your 1st PR 👏 . This PR is correct but in the near future, when 4.1.3 is released, this PR will be reverted to reflect compose-image-tag.yml's presence.

From this post, I suppose you can make the small clarification note instead.

@dosubot dosubot bot mentioned this pull request Jun 24, 2025
3 tasks
@hu-qi
Copy link
Author

hu-qi commented Jun 24, 2025

Hi and thanks for your 1st PR 👏 . This PR is correct but in the near future, when 4.1.3 is released, this PR will be reverted to reflect compose-image-tag.yml's presence.嗨,感谢你的第一个 PR 👏。这个 PR 是正确的,但在不久的将来,当 4.1.3 发布时,这个 PR 将被撤销以反映 compose-image-tag.yml 的存在。

From this post, I suppose you can make the small clarification note instead.由此,我猜你可以做一个小小的澄清说明。

Thanks for the feedback from the maintainers and community. Following the suggestions, I'll close this PR for now.

I'll continue to follow this project and look forward to contributing more meaningful improvements in the future. Thanks for your time reviewing this!

@hu-qi hu-qi closed this Jun 24, 2025
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 size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants