Add dynamic metrics #286
Merged
Add dynamic metrics #286
Conversation
This file contains 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
testing js front Add precommit hook to create master record
…ould live somehwere else) and started building out the front-matter sections
…ed via browswer bundles to webpack. Creates a coupld 'profiles' for webpack buils one for development that will still allow source mapping and another for production
…e to webpack. Added ./dist/ to gitignore. Add wordcloud plugin for chartjs
…by category. Adds more metadata
… metadata to chapter 3
…st of the bootcamp
dreweth
reviewed
May 5, 2023
…that is supported (via their docs). Cleaned up dead code. Added newlines
jburns24
commented
May 5, 2023
Comment on lines
+36
to
+47
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: 18 | ||
|
|
||
| - name: Install dependencies | ||
| run: npm ci | ||
|
|
||
| - name: Run webpack build | ||
| run: npx webpack --config webpack.prod.js | ||
|
|
There was a problem hiding this comment.
This has not been tested. At least according to the readme for v3 of the setup-node they mention version 18 as a major version they support so we should be good there. I tested on node version 19 but dont think I am doing anything that broke between those major versions.
…ixed bug where canvas' id was changed but js was not updated.
…ng categories each loop. And added rounding to the tooltip for the doughnut graph
dreweth
approved these changes
May 9, 2023
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.
This PR introduces quite a bit of change all with the goal of creating a central location for bootcamp metadata and laying the foundation for generating visualizations off the metadata so we can answer business questions. I will highlight the major.
I made a choice that metadata should live with the bootcamp section. This feels like the location that will be least likely to be forgotten and thus has the best chance of staying accurate. In order to simplify the client side logic of aggregating the metadata and avoid maintaining things like a list of subsections where meta data lives. I opted for a pre-commit hook that looks at any staged
.mdfiles and checks them for metadata. This metadata is then aggregated into a master record on the root .md fileREADME.md. This master record is to be maintained by the pre-commit hook. For this pr there are many features missing and the hook really only handles adding or changing metadata. It does not handle things like deleting sections or renaming sections. I would like to address these cases in a follow up pr.Prior to this pr we relied on importing browser bundles in index.js. Early on in development I kept finding myself wanting to use npm packages on the client side. Specifically for packages that did not publish a browser bundle. We could have minified and published a bundle on CDN or we could have introduced a bundler like webpack. I picked the latter as we can now leverage any npm package on the front end. We also get the benifit of babble on our production js which will increase the browser support and minification which will help with asset size. This does introduce a new build dependency though
The bootcamp used to rely on some blackbox deploy magic from github. Now it uses a GitHub Action primarily so we can support the new build dependency. But also this will give us more control over how the bootcamp is deployed.
This is what it was all about. With metadata in place and a bundler to leverage npm packages we can now generate graphs and other visualizations off our metadata.
Here is what the new graph looks like on the home page
Warning
The GHA changes have not been tested!