fix(docs): Update development setup documentation for port changes#39705
fix(docs): Update development setup documentation for port changes#39705Ilphrin wants to merge 1 commit into
Conversation
The actual basic docker setup defaults to port 8088 first, and only tries 9000 afterward if not available.
|
Bito Automatic Review Skipped - Files Excluded |
✅ Deploy Preview for superset-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![codeant-ai-for-open-source[bot]](https://avatars.githubusercontent.com/u/151810221?s=60&v=4){kind=small}
| @@ -588,18 +588,18 @@ So a typical development workflow is the following: | |||
| superset run -p 8088 --with-threads --reload --debugger --debug | |||
| ``` | |||
|
|
|||
| 2. in parallel, run the Webpack dev server locally on port `9000`,<br/> | |||
| 2. in parallel, run the Webpack dev server locally on port `8088`,<br/> | |||
|
|
|||
| ```bash | |||
| npm run dev-server | |||
| ``` | |||
|
|
|||
| 3. access `http://localhost:9000` (the Webpack server, _not_ Flask) in your web browser. This will use the hot-reloading front-end assets from the Webpack development server while redirecting back-end queries to Flask/Superset: your changes on Superset codebase — either front or back-end — will then be reflected live in the browser. | |||
| 3. access `http://localhost:8088` (the Webpack server, _not_ Flask) in your web browser. This will use the hot-reloading front-end assets from the Webpack development server while redirecting back-end queries to Flask/Superset: your changes on Superset codebase — either front or back-end — will then be reflected live in the browser. | |||
|
|
|||
| It's possible to change the Webpack server settings: | |||
|
|
|||
| ```bash | |||
| # Start the dev server at http://localhost:9000 | |||
| # Start the dev server at http://localhost:8088 | |||
| npm run dev-server | |||
There was a problem hiding this comment.
🟠 Architect Review — HIGH
The Webpack dev server docs now state that the dev server "by default starts at http://localhost:8088", and steps 2–3 describe running it "on port 8088" and accessing http://localhost:8088, but the actual webpack config still defaults the dev server to port 9000 and proxies to a backend on 8088. This makes the documented default port and access URL incorrect and breaks the described hot-reload workflow for someone following these instructions literally.
Suggestion: Update this section to reflect the actual behavior (Webpack dev server on 9000 proxying to Flask on 8088, with users visiting http://localhost:9000), or if 8088 is the intended new default, change the dev-server defaults in webpack.config.js and related scripts to 8088 and then document that behavior consistently.
Fix in Cursor | Fix in VSCode Claude
(Use Cmd/Ctrl + Click for best experience)
Prompt for AI Agent 🤖
This is an **Architect / Logical Review** comment left during a code review. These reviews are first-class, important findings — not optional suggestions. Do NOT dismiss this as a 'big architectural change' just because the title says architect review; most of these can be resolved with a small, localized fix once the intent is understood.
**Path:** docs/developer_docs/contributing/development-setup.md
**Line:** 580:603
**Comment:**
*HIGH: The Webpack dev server docs now state that the dev server "by default starts at http://localhost:8088", and steps 2–3 describe running it "on port 8088" and accessing http://localhost:8088, but the actual webpack config still defaults the dev server to port 9000 and proxies to a backend on 8088. This makes the documented default port and access URL incorrect and breaks the described hot-reload workflow for someone following these instructions literally.
Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise.
If a suggested approach is provided above, use it as the authoritative instruction. If no explicit code suggestion is given, you MUST still draft and apply your own minimal, localized fix — do not punt back with 'no suggestion provided, review manually'. Keep the change as small as possible: add a guard clause, gate on a loading state, reorder an await, wrap in a conditional, etc. Do not refactor surrounding code or expand scope beyond the finding.
Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix
|
The flagged issue is correct—the documentation now states the Webpack dev server starts at http://localhost:8088, but the actual webpack.config.js still defaults to port 9000 and proxies to the backend on 8088. To resolve, update the docs to reflect the actual behavior: dev server on 9000, users visit http://localhost:9000. docs/developer_docs/contributing/development-setup.md Webpack dev serverThe dev server by default starts at So a typical development workflow is the following:
It's possible to change the Webpack server settings: # Start the dev server at http://localhost:9000
npm run dev-server
# Run the dev server on a non-default port |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates port references in the development setup documentation from 9000 to 8088 to reflect the current Docker default port.
Changes:
- Updates Docker Compose access URL from port 9000 to 8088
- Updates frontend
npm run devdocumentation to reference port 8088 - Updates Webpack dev server documentation to reference port 8088
| #### Webpack dev server | ||
|
|
||
| The dev server by default starts at `http://localhost:9000` and proxies the backend requests to `http://localhost:8088`. | ||
| The dev server by default starts at `http://localhost:8088` and proxies the backend requests to `http://localhost:8088`. |
SUMMARY
Hi, first of all thank you for your awesome project!
It seems that the actual basic docker setup defaults to port 8088 first, and only tries 9000 afterward if not available, so I updated the setup docs accordingly. Please let me know if this is incorrect
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
TESTING INSTRUCTIONS
ADDITIONAL INFORMATION