hasura / ddn-docs

Repository for the Hasura DDN version of docs
https://hasura.io/docs
2 stars 6 forks source link

Docker compose to start the development server by default #638

Closed nullxone closed 1 month ago

nullxone commented 1 month ago

Description 📝

Now you can just do "docker compose up"

Or even better "docker compose run -P app"

Quick Links 🚀

Assertion Tests 🤖

hasura-bot commented 1 month ago

Hey, @nullxone :wave:

Thanks for this PR! Since you changed docs files, our automated Action assigned Sean as your reviewer :tada:

Before Sean looks over the changes, we ask you to take care of a couple of items:

The docs team aims to get all PRs reviewed within 48 hours of your team doing a review in the form of a content pass. Let Sean know the level of urgency on Slack :+1:

hasura-bot commented 1 month ago

DX: Assertion Testing

✅ Diff

The changes from 'sleep inf' to the use of a bash entrypoint and 'yarn start' command likely make the container start the application immediately, which can be seen as an improvement for usability if the container's purpose is for development or production use.

❌ Integrated

Though the diff makes the service start the application, it's unclear from the context provided how this integrates with the broader set of files. For example, there's no explicit indication if other dependent services defined in the compose file are impacted. Additionally, the 'ports' configuration is missing the actual port mapping, which might affect usability by not exposing the application's port as was done previously. Further review and possibly expanding the documentation or configuration would ensure it contributes positively to the overall usability.

cloudflare-workers-and-pages[bot] commented 1 month ago

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 46c450d
Status: ✅  Deploy successful!
Preview URL: https://ddc7ebf3.v3-docs-eny.pages.dev
Branch Preview URL: https://ak-docker-compose-starts-ser.v3-docs-eny.pages.dev

View logs