Repository navigation
Docs: fix Full Stack dev container setup instructions (no post-start script) - #615
Open
Shahzeb-DataEngineer wants to merge 1 commit into
Open
Shahzeb-DataEngineer wants to merge 1 commit into
Shahzeb-DataEngineer wants to merge 1 commit into
Conversation
The development environment setup guide referenced a "post-start script" that builds the server, runs database migrations, and starts the OpenMetadata services. No such script exists: the Full Stack `.devcontainer` config only defines a `postCreateCommand` (running `.devcontainer/dev/post-create.sh`), and the server, migrations, and services are started by docker compose (`openmetadata-server`, `execute-migrate-all`, `mysql`, and `elasticsearch` services in `docker/development/docker-compose.yml`). Corrects the wording in the v1.13.x, v2.0.x, and v2.1.x-SNAPSHOT guides. Related: open-metadata/OpenMetadata#27517 Signed-off-by: Shahzeb Ali <126076773+Shahzeb-DataEngineer@users.noreply.github.com>
This branch has not been deployed
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
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.
Description
The Development Environment Setup guide told contributors that, for the Full Stack configuration, "the post-start script will additionally build the server, run database migrations, and start OpenMetadata services."
That script does not exist: the Full Stack
.devcontainer/devcontainer.jsondefines only apostCreateCommand(running.devcontainer/dev/post-create.sh). The server image build, database migrations, and service startup actually happen through docker compose — theopenmetadata-server,execute-migrate-all,mysql, andelasticsearchservices indocker/development/docker-compose.yml.This PR corrects the wording in the v1.13.x, v2.0.x, and v2.1.x-SNAPSHOT guides so contributors are not left looking for a script that is not there.
Related Issue
Related: open-metadata/OpenMetadata#27517