feat: update configuration doc #1672
Conversation
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 9b25f62. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
github-actions
bot
added
documentation
|
I did not realize that there were already updates on this documentation in another PR: #1583 I also tried to resolve the comments from the other PR (which I will copy paste into the code to make it simpler to review). |
docs/configuration/OVERVIEW.md
Outdated
| __Pre-bootstrap configuration__ | ||
|
|
||
| - Defined in one interface extending the __AppBuildConfiguration__ from __@o3r/core__ in order to be identified by the extractor. | ||
| - Used for configurations needed before loading the Angular application component. They will be |
There was a problem hiding this comment.
comment from @pginoux-1A:
It's not injected by the CMS, there is no runtime interactions with the CMS, it's used as an edition panel for the customization and the files are exported in the dynamic content folder afterwards. We should advertise that this part is linked to a piece of code server side that updates the index.html and what requires to be added with an example
https://github.com/AmadeusITGroup/otter/pull/1583/files#r1557804902
sdo-1A
force-pushed
the
doc/config
branch
2 times, most recently
from
a3dca3d
to
87d0b96
Compare
sdo-1A
force-pushed
the
doc/config
branch
2 times, most recently
from
e88256f
to
5c020fc
Compare
| * If the __component extractor__ is run on an application with components from an Otter library, the `libraries` option can be used to concatenate the metadata files generated for the application with the ones from the specified libraries. | ||
| The extractor will search for the component configuration and style metadata files in the `node_modules` package of each configured library. | ||
| The name of the metadata files to search for is defined for each library in the `cmsMetadata` property defined in their respective `package.json` files. | ||
| * Here is an example of an `angular.json` file: |
There was a problem hiding this comment.
it looks weird to have an example of angular.json after a whole paragraph about package.json
There was a problem hiding this comment.
Would you suggest rephrasing or to remove the example?
docs/configuration/OVERVIEW.md
Outdated
| - the second priority is the priority by component type set in the store | ||
| - the lowest priority is the default config set on component (in the config.ts file of the component) | ||
| - The highest priority is the one passed as input from a parent component | ||
| - The second priority is the priority by component ID set dynamically |
There was a problem hiding this comment.
I'm not sure to understand this part
also, is it not already kind of covered by the schema in the Component configuration types section ?
There was a problem hiding this comment.
This corresponds to the customized configuration, I can rephrase if the sentence is not clear enough
docs/configuration/OVERVIEW.md
Outdated
|
|
||
| - At __library__ level we have the config for components (__blocks, components, elements__). | ||
| - At __library__ level, we have the configuration for `Block` and `ExposedComponent`, see [available component types](https://github.com/AmadeusITGroup/otter/blob/main/docs/components/INTRODUCTION.md#component-type). |
There was a problem hiding this comment.
You can define component in your application also
docs/configuration/OVERVIEW.md
Outdated
| injected by the CMS in the index.html body tag data-bootstrapconfig as a data attribute | ||
| - Defined in one interface extending the __AppBuildConfiguration__ from __@o3r/core__ in order to be identified by the extractor. | ||
| - Used for configurations needed before loading the Angular application component. It is up to the server to specify the body tag | ||
| `data-dynamiccontentpath` as a data attribute inside the `index.html` so the application can get the latest version of the dynamic |
There was a problem hiding this comment.
I'm not sure dynamiccontentpath as something related to the configuration
| 1) inline definition (see above `myUnionTypeField`) | ||
| 2) reference to a union type that is defined in the same configuration file (see above `myReferencedUnionTypeField` and `Position`). | ||
|
|
||
| ### Configuration tags |
There was a problem hiding this comment.
Maybe we can add that we expose a linter for that docs/linter/eslint-plugin/rules/o3r-categories-tags.md
There was a problem hiding this comment.
And a vscode extension for autocomplete
There was a problem hiding this comment.
I will open an issue once the PR is merged
| } | ||
| ``` | ||
|
|
||
| ### Configuration categories |
There was a problem hiding this comment.
Maybe we can add that we expose a linter for that docs/linter/eslint-plugin/rules/o3r-widget-tags.md
There was a problem hiding this comment.
And a vscode extension for autocomplete
There was a problem hiding this comment.
I will open an issue once the PR is merged
Proposed change
Update documentation on configuration