Skip to content

Commit eef141a

Browse files
authored
updated polyfill info, added info about Nexus (#2835)
* updated polyfill info, added info about Nexus * Update developers.md to clarify access request process for SL Design System packages * Update developers.md to correct capitalization and clarify access instructions for GitHub packages
1 parent 2358479 commit eef141a

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

website/src/categories/getting-started/developers.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,16 @@ Please follow the steps below when first getting started:
2323

2424
## Make sure you have access
2525

26-
Even though the SL Design System is open source, the packages are not publicly available. That is why you need to get access to the GitHub npm packages in order to install them locally. First the SL Design System team needs to add you to the list of users who can access the packages. To be added, you need to provide your @sanoma.com (or other company) email address to us in [our Slack channel](https://sanoma.slack.com/archives/C03SA9HUUA3) or you can <a href="mailto:[email protected]">send us an email</a>.
26+
Even though the SL Design System is open source, the packages are not publicly available. That is why you need to get access to the npm packages in order to install them locally.
27+
For use in a Sanoma Learning product it is possible to load the SLDS packages (and Font Awesome), via the company provided Nexus server. If you don't have access to that it is also possible to access the packages via GitHub.
28+
29+
### Nexus
30+
31+
A lot of products are getting their packages from nexus already, so you can check your team's documentation for the url and how to set up access. For technical questions about access to nexus you can contact TechOps. If you have access to the correct server but encounter a problem specific to the Design System packages you can contact us of course.
32+
33+
### GitHub
34+
35+
First the SL Design System team needs to add you to the list of users who can access the packages. To be added, you need to provide your @sanoma.com (or other company) email address to us in [our Slack channel](https://sanoma.slack.com/archives/C03SA9HUUA3) or you can <a href="mailto:[email protected]">send us an email</a>. Please mention which product you are working on so we can put you in the right team. For our admin it's also really helpful if you have a recognizable username, or use your actual name, so we can trace an account back to you if we ever need to contact you.
2736
You don't have to create a new, separate GitHub account with your Sanoma Learning email address if you have an existing GitHub account and want to use that. Just add your @sanoma.com email address to the list of email addresses in GitHub.
2837

2938
Once you are added you need to [create a *classic* personal access token on GitHub](https://docs.GitHub.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic). Make sure that this token has at least the `read_packages` privilege. This newly created token needs to be added to the `.npmrc` file in your home directory, along with a reference to where the `@sl-design-system` packages can be found:
@@ -154,29 +163,22 @@ The SL Design System tries to use modern web standards as much as possible. This
154163
Make sure you include the polyfills before you include the SLDS components. This is because the polyfills need to be loaded before the components are loaded.
155164

156165
The following web standards require polyfills at this time:
157-
- [Popover](https://caniuse.com/mdn-api_htmlelement_popover)
158166
- [Scoped Custom Element Registry](https://github.com/WICG/webcomponents/blob/gh-pages/proposals/Scoped-Custom-Element-Registries.md)
159167
- [Element Internals](https://caniuse.com/mdn-api_elementinternals)
160168

161169
To use these polyfills, you need to install the following packages:
162-
- `@oddbird/popover-polyfill`
163170
- `@webcomponents/scoped-custom-element-registry`
164-
- `element-internals-polyfill`
165171

166172
Once installed you need to import the polyfills in your application. You can do this by importing the polyfills in your main JS file:
167173

168174
```js
169-
import '@oddbird/popover-polyfill';
170175
import '@webcomponents/scoped-custom-element-registry/scoped-custom-element-registry.min.js';
171-
import 'element-internals-polyfill';
172176
```
173177

174178
Another option is to include them in your HTML:
175179

176180
```html
177-
<script src="./node_modules/@oddbird/popover-polyfill/dist/popover.min.js"></script>
178181
<script src="./node_modules/@webcomponents/scoped-custom-element-registry/scoped-custom-element-registry.min.js"></script>
179-
<script src="./node_modules/element-internals-polyfill"></script>
180182
```
181183

182184
</section>

0 commit comments

Comments
 (0)