docs: review of Creating UI5 Web Components Packages.md #3318
Conversation
|
|
||
| *Please note that the usage of the `ui5-` prefix is strongly discouraged, although not forbidden, for third-party components. | ||
| This is due to the possibility of name clashes in the future. If you insist on using it* |
There was a problem hiding this comment.
The last part seems unfinished. I've removed it but if it makes sense to keep it, we need to finish the sentence.
| @@ -107,42 +107,42 @@ That's it! | |||
|
|
|||
| ## Understanding the project structure | |||
There was a problem hiding this comment.
I'd move the whole of the second part (Understanding the project structure) into a separate .md file/topic.
|
|
||
| The initialization script will create several NPM scripts for you in `package.json`. | ||
|
|
||
| Task | Purpose | ||
| -----|------- | ||
| clean | Deletes the `dist/` directory with the build output | ||
| build | Production build to the `dist/` directory |
There was a problem hiding this comment.
All of these are actions, so in this case Production build is the only definition that stands out. I'd replace it with the appropriate verb.
|
|
||
| The initialization script will create several NPM scripts for you in `package.json`. | ||
|
|
||
| Task | Purpose | ||
| -----|------- | ||
| clean | Deletes the `dist/` directory with the build output |
There was a problem hiding this comment.
Delete (forgot to remove the 's' in order to be identical with the other descriptions).
| *Note about assets:* The `Assets.js` module may import some relatively big `JSON` modules, containing CLDR data, i18n texts and theming parameters. | ||
| Therefore, it is recommended to guide your package's users to bundle their apps efficiently by configuring `rollup` or `webpack`, | ||
| *Note about assets:* The `Assets.js` module may import some relatively big `JSON` modules containing CLDR data, i18n texts and theming parameters. | ||
| Therefore, it is recommended to guide your package users to bundle their apps efficiently by configuring `rollup` or `webpack`, | ||
| depending on their choice, to not include the content of the assets `JSON` modules in their javascript bundle. | ||
| See the [Efficient asset bundling](../Assets.md#bundling) section of our [Assets](../Assets.md) documentation for details. |
There was a problem hiding this comment.
I couldn't find such a section in Assets.
| @@ -107,42 +107,42 @@ That's it! | |||
|
|
|||
| ## Understanding the project structure | |||
|
|
|||
| ### package.json | |||
| ### Package.json | |||
There was a problem hiding this comment.
package.json is the name of the file, should not be renamed
There was a problem hiding this comment.
It's also a title but if you think this may cause more confusion, then we'll not capitalize it.
There was a problem hiding this comment.
Then, The package.json perhaps?, or something like this, yes I would keep package.json as it is.
There was a problem hiding this comment.
If it's tagged as a technical name, it's OK to be written in lowercase and it wouldn't need the article.
| @@ -82,7 +82,7 @@ and once the project is built for the first time, open in your browser: | |||
|
|
|||
| `http://localhost:8080/test-resources/pages/index.html` | |||
|
|
|||
| *Note:* If you chose a different `port` earlier, change `8080` to its value. | |||
| *Note:* If you choose a different `port` earlier, change `8080` to its value. | |||
| `src/themes/sap_fiori_3_dark/parameters-bundle.css` | Values for the component-specific CSS Vars for the `sap_fiori_3_dark` theme. | ||
| `src/themes/sap_fiori_3_hcb/parameters-bundle.css` | Values for the component-specific CSS Vars for the `sap_fiori_3_hcb` theme. | ||
| `src/themes/sap_fiori_3_hcw/parameters-bundle.css` | Values for the component-specific CSS Vars for the `sap_fiori_3_hcw` theme. | ||
| `src/themes/MyFirstComponent.css` | All CSS rules for the Web Ccomponent, same for all themes; will be inserted in the shadow root. |
Review of documentation topic Creating UI5 Web Components Packages