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.

Sign up for GitHub

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

Jump to bottom

Generator: Update CDN reference #382

Closed
blackfalcon opened this issue Apr 4, 2023 · 0 comments
Closed

Generator: Update CDN reference #382

blackfalcon opened this issue Apr 4, 2023 · 0 comments
Assignees
@irma-kurnia-alaska
Labels
Type: Documentation Documentation only changes
Milestone
Generator RC v4.0

Comments

@blackfalcon
Copy link
Member

blackfalcon commented Apr 4, 2023 •
edited
Loading

Is your feature request related to a problem? Please describe.

Historically we have been using Unpkg and as of late, there have been real performance issues.

Describe the solution you'd like

The real issue is that Unpkg was intended to be an option, but accidentally became a standard. We need to update our install docs and possibly the docsite FAQ pages as well.

In the end, any CDN can be used as long as it has access to the npm resource. E.g. the current recommendation is Unpkg, but a dev could use JSDelivr just as easily.

See example commit

Exit criteria

Update the install docs to illustrate that any npm CDN utility could be used to consume the bundled version of any component. Options are:

  1. https://www.jsdelivr.com/
  2. https://www.unpkg.com/
  3. https://jspm.org/ (options that require more research)
@blackfalcon blackfalcon added Type: Feature New Feature auro-generator not-reviewed Issue has not been reviewed by Auro team members labels Apr 4, 2023
@blackfalcon blackfalcon added this to the wc-generator RC (perf) milestone Apr 4, 2023
@blackfalcon blackfalcon added Type: Documentation Documentation only changes and removed Type: Feature New Feature not-reviewed Issue has not been reviewed by Auro team members labels Apr 20, 2023
irma-kurnia-alaska pushed a commit that referenced this issue Apr 25, 2023
@irma-kurnia-phtn
fix: generator: update CDN reference #382
e8b6f40 
Change to be Commited:

newfile: template/README.md
@irma-kurnia-alaska irma-kurnia-alaska mentioned this issue Apr 25, 2023
Merged
3 tasks
@irma-kurnia-alaska irma-kurnia-alaska linked a pull request Apr 25, 2023 that will close this issue
Irmaku/wc generator issue #383
Merged
3 tasks
irma-kurnia-alaska pushed a commit that referenced this issue Apr 26, 2023
@irma-kurnia-phtn
fix: generator: update CDN reference #382
57f4b59 
Change to be Commited:

newfile: template/README.md
@blackfalcon blackfalcon removed a link to a pull request May 3, 2023
Irmaku/wc generator issue #383
Merged
3 tasks
blackfalcon pushed a commit that referenced this issue May 9, 2023
@irma-kurnia-phtn @blackfalcon
fix: generator: update CDN reference #382
cb65617 
Change to be Commited:

newfile: template/README.md
@settings settings bot removed the auro-generator label May 9, 2023
blackfalcon pushed a commit that referenced this issue May 9, 2023
@semantic-release-bot
chore(release): 4.0.0 [skip ci]
d1b5930 
# [4.0.0](v3.17.4...v4.0.0) (2023-05-09)

### Bug Fixes

* automatically generate TypeScript description files ([dea833e](dea833e))
* generator: update CDN reference [#382](#382) ([cb65617](cb65617))
* **reference:** update to use [@AuroDesignSystem](https://github.com/aurodesignsystem) [#345](#345) ([1a628fa](1a628fa))
* **sec:** remove inefficient regular expression [#357](#357) ([c726423](c726423))
* update docs on issue template ([acd5531](acd5531))

### Features

* address general issues to get build working ([a4eba9a](a4eba9a))
* **typescript:** add typescript support ([a2d48e0](a2d48e0))

### Performance Improvements

* **ignore:** update configs [#385](#385) ([ea52043](ea52043))
* **labs:** remove auroLabs functionality [#339](#339) ([f32d69f](f32d69f))
* remove deprecated stylelint rules [#381](#381) ([568016e](568016e))
* remove IE support [#181](#181) ([c8543b3](c8543b3))
* remove polyfill focus visible ([6b68814](6b68814))
* **review:** add all suggested updates ([268e86a](268e86a))
* **settings:** update labels [#377](#377) ([c2cccf7](c2cccf7))
* **watch:** add apiExamples to generate docs [#320](#320) ([32c005f](32c005f))
* **windows:** update dev script [#274](#274) ([5efb6f8](5efb6f8))

### Reverts

* .npmignore and update .npmignore.temp ([85a135f](85a135f))
* return removed regex [#357](#357) ([08e2957](08e2957))

### BREAKING CHANGES

* **labs:** This commit will remove all functionality related
to the use of AuroLabs as a concept.

Changes to be committed:
modified:   bin/generate.js
modified:   componentDocs/README.md
modified:   componentDocs/README_v4.md
deleted:    componentDocs/partials/labsDisclaimer.md
deleted:    template/.github/settings__labs.yml
modified:   template/scripts/generateDocs.js
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@irma-kurnia-alaska irma-kurnia-alaska

Labels
Type: Documentation Documentation only changes
Projects
None yet
Milestone
Generator RC v4.0
Development

No branches or pull requests
3 participants
@blackfalcon @braven112 @irma-kurnia-alaska