There's a complicated issue related to deployment, references, Windows not being able to handle symlinks, etc. that is causing an issue. This ticket aims to solve that issue through package bundling and rearchitecture of the projects file structure.
Acceptance Criteria
[x] The project file structure is rearchitected to meet the needs of the bundler and deployment
Package bundling is added to compile the GDJ JS files into one JS file in the root
This was abandoned, for now
[x] Local testing works without the need for manual intervention on *nix and Windows
[x] Demo deployment works
[x] demo-hosting.yml GitHub Action/workflow is updated as needed
GitHub NPM package building works
release-package.yml GitHub Action/workflow is updated as needed
This was abandoned, for now
[x] All documentation references to file paths are updated
Most of the documentation that would be impacted has not yet been merged into development or main or it was created as part of this issue
[x] Build documentation is updated
Approach
Try using webpack.js.org for bundling src/*.js files into one guitar-diagrams.js file in the root
This may be a solution, but it was too complicated to go straight to this
Reference the src/*.js files from the docs/examples/index.html file
Consider moving examples/ out of docs/ if this helps
Update GitHub Actions as needed
Test locally, with deployment, with demo hosting, and with Windows
Notes
There is some overlap with the code pushed in this issue and the code that would be pushed in #30, specifically in the code-owner-docs.md file.
Background
There's a complicated issue related to deployment, references, Windows not being able to handle symlinks, etc. that is causing an issue. This ticket aims to solve that issue through package bundling and rearchitecture of the projects file structure.
Acceptance Criteria
Package bundling is added to compile the GDJ JS files into one JS file in the rootdemo-hosting.yml
GitHub Action/workflow is updated as neededGitHub NPM package building worksrelease-package.yml
GitHub Action/workflow is updated as neededdevelopment
ormain
or it was created as part of this issueApproach
Try using webpack.js.org for bundlingsrc/*.js
files into oneguitar-diagrams.js
file in the rootsrc/*.js
files from thedocs/examples/index.html
fileexamples/
out ofdocs/
if this helpsNotes
There is some overlap with the code pushed in this issue and the code that would be pushed in #30, specifically in the
code-owner-docs.md
file.