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: Detail front-end development instructions #19870

Merged
merged 3 commits into from
May 11, 2022

Conversation

EBoisseauSierra
Copy link
Contributor

SUMMARY

Based on the silly error that led to this
discussion
,
we clarify that when modifying the front-end locally, one should access
the Webpack dev servers, rather than Flask directly, to see the latest
changes take effect.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

n/a

TESTING INSTRUCTIONS

n/a

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • 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

@EBoisseauSierra EBoisseauSierra changed the title docs: Detail front-end development instructions [WIP] docs: Detail front-end development instructions Apr 27, 2022
Automatically done using the Markdown-All-In-One extension for VSCode:
https://open-vsx.org/extension/yzhang/markdown-all-in-one

Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io>
Based on the silly error that led to [this
discussion](https://apache-superset.slack.com/archives/C014LS99C1K/p1650969237848999),
we clarify that when modifying the front-end locally, one should access
the Webpack dev servers, rather than Flask directly, to see the latest
changes take effect.

Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io>
@EBoisseauSierra EBoisseauSierra changed the title [WIP] docs: Detail front-end development instructions docs: Detail front-end development instructions Apr 27, 2022
CONTRIBUTING.md Outdated
Concretely, it means that you will want to:

1. [run Superset locally](#flask-server) using Flask, on port `8088`,
2. in parallel, run the Webpack dev server locally on port `9000`,
Copy link
Member

Choose a reason for hiding this comment

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

Not sure if this is a good place to mention that you can run npm run dev or (what most people do) npm run dev-server for hot reloading

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks! Would that make things clearer?

Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io>
Copy link
Member

@rusackas rusackas left a comment

Choose a reason for hiding this comment

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

Thanks for this, and sorry for the lag in revisiting it! Feel free to ping folks if we neglect to circle back to things :D

@rusackas rusackas merged commit 3a379af into apache:master May 11, 2022
hughhhh pushed a commit to hve-labs/superset that referenced this pull request May 11, 2022
* chore: Beautify CONTRIBUTING

Automatically done using the Markdown-All-In-One extension for VSCode:
https://open-vsx.org/extension/yzhang/markdown-all-in-one

Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io>

* docs: Detail front-end development instructions

Based on the silly error that led to [this
discussion](https://apache-superset.slack.com/archives/C014LS99C1K/p1650969237848999),
we clarify that when modifying the front-end locally, one should access
the Webpack dev servers, rather than Flask directly, to see the latest
changes take effect.

Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io>

* docs: Underline typical workflow

Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io>
@EBoisseauSierra EBoisseauSierra deleted the docs_for_dummies branch May 11, 2022 16:53
philipher29 pushed a commit to ValtechMobility/superset that referenced this pull request Jun 9, 2022
* chore: Beautify CONTRIBUTING

Automatically done using the Markdown-All-In-One extension for VSCode:
https://open-vsx.org/extension/yzhang/markdown-all-in-one

Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io>

* docs: Detail front-end development instructions

Based on the silly error that led to [this
discussion](https://apache-superset.slack.com/archives/C014LS99C1K/p1650969237848999),
we clarify that when modifying the front-end locally, one should access
the Webpack dev servers, rather than Flask directly, to see the latest
changes take effect.

Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io>

* docs: Underline typical workflow

Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io>
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 2.0.0 labels Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/M 🚢 2.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants