Altinn / Altinn/altinn-studio-docs
UI Component Library for Altinn Studio UI Designer
- Dominant language
- CSS
- Stars
- 15
- Forks
- 58
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 53
Description
### Description
We need a better component catalog for Altinn Studio UI Designer that show the user everything about the components
### Additional Information
Each component needs to describe
- What it looks like
- How it should be used
- Possible settings
- Advanced features like validation, dynamics ++
- Info about features available in Altinn Studio Designer and what you need to configure manually
### Tasks
- [x] Create a component template
- [x] Create doc files for all components
- [x] Create Hugo shortcodes and a system to inject documentation for common component properties.
- [ ] Update documentation for all components with the new template
### Acceptance Criterias
- [ ] All components are described according to the new template
# Update documentation
Template files have been generated for all components.
Questions or comments? -> @thestokkan
## New component docs
For the components lacking documentation, the basic templates have been published and need to be filled in. Follow the instructions in the template.
```[tasklist]
### Fill in templates (nb and en) for the following components
- [ ] https://github.com/Altinn/altinn-studio-docs/issues/1141
- [ ] https://github.com/Altinn/altinn-studio-docs/issues/1142
- [ ] https://github.com/Altinn/altinn-studio-docs/issues/1143
- [ ] https://github.com/Altinn/altinn-studio-docs/issues/1144
- [ ] https://github.com/Altinn/altinn-studio-docs/issues/1145
- [ ] Update Datepicker component docs (fill in template)
- [ ] Update FileUpload component docs (fill in template)
- [ ] Update FileUploadWithTag component docs (fill in template)
- [ ] Update Group component docs (fill in template)
- [ ] Update Header component docs (fill in template)
- [ ] Update Input component docs (fill in template)
- [ ] Update InstanceInformation component docs (fill in template)
- [ ] Update InstantiationButton component docs (fill in template)
- [ ] Update Map component docs (fill in template)
- [ ] Update NavigationBar component docs (fill in template)
- [ ] Update NavigationButtons component docs (fill in template)
- [ ] Update Paragraph component docs (fill in template)
- [ ] Update Summary component docs (fill in template)
```
## Update component docs
For components that have documentation, this must be updated with the new template.
The template files are located in `components/temp/components-to-update` with a folder for each component.
#### To update a component, do the following:
1. Rename the component's current folder (or move to temporary location).
2. Move the component's new folder with templates from `components/temp/components-to-update` into the `components` folder.
3. Copy content from the old docs to the new template and fill in any missing sections (follow the instructions in the template). If the new folder name differs from the old one, add an alias with the old name.
4. Delete the old folder
```[tasklist]
### Update components with new templates (nb and en)
- [ ] ButtonGroup
- [ ] https://github.com/Altinn/altinn-studio-docs/issues/1155
- [ ] https://github.com/Altinn/altinn-studio-docs/issues/1185
- [ ] Grid
- [ ] IFrame
- [ ] https://github.com/Altinn/altinn-studio-docs/issues/1147
- [ ] Likert
- [ ] Link
- [ ] List
- [ ] https://github.com/Altinn/altinn-studio-docs/issues/1186
- [ ] PrintButton
- [ ] https://github.com/Altinn/altinn-studio-docs/issues/1194
- [ ] Panel
```
## Components with templates still in need of update
The following components have been updated with the template and filled out but still need some work.
```[tasklist]
### Update components (updated with template but incomplete)
- [ ] Accordion (waiting for schema file and screenshot of different heading levels)
- [ ] AccordionGroup (WIP)
- [ ] Alert
```
Contributor guide
Assessment
This issue has not been assessed yet.