[GitHub] [incubator-superset] nytai opened a new issue #8805: [SIP-28] Proposal for moving frontend assets to the base of the repo

[GitBox <gi...@apache.org>]

nytai opened a new issue #8805: [SIP-28] Proposal for moving frontend assets to the base of the repo
URL: https://github.com/apache/incubator-superset/issues/8805
 
 
   ## [SIP] Proposal for 
   
   ### Motivation
   Currently frontend assets are embedded in the superset package under `superset/assets/`, which is symlinked to `superset/assets/static`. This is really confusing for newcomers to the project as it's unclear why code appears to be duplicated. Additionally this symlink is managed by git, so it doesn't appear a symlink when `ls -la` is run, which only adds to the confusion. 
   
   Moreover is seems there's code (eg, `MANIFEST.in`, `Dockerfile` ) that tries to work around the fact that the entire frontend exists in the superset module and most of these files are not needed during runtime. Things like whitelisting files and removing files after builds are workarounds to the actual issue and only add complexity to the problem. 
   
   Description of the problem to be solved.
   
   ### Proposed Change
   - Move the frontend code into a top level directory, something like `frontend` or `client`
   - Configure webpack to output the built/dist files to `superset/assets/dist`. This can include the package.json (needed for version info) and any other necessary files. 
   - remove the symlinks. 
   - update build scripts
   - make sure everything works (local builds, docker builds, python package, etc.)
   - update documentation. 
   
   ### New or Changed Public Interfaces
   [no changes]
   
   ### New dependencies
   [no changes]
   
   ### Migration Plan and Compatibility
   
   No major/breaking changes should be necessary. The bulk of the work would be around making sure no existing builds/scripts break and documentation is updated. 
   
   ### Rejected Alternatives
   1. Remove the symlink and move everything to `superset/static/assets` and continue to support the whitelisting in `MANIFEST.in` and the cleanup in `Dockerfile` and possibly other places. 
   2. Continue to support the current file organization and continue to field questions such as: https://github.com/apache/incubator-superset/issues/8804
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org