lingwei.kong/hawkbit
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Fix markdown formatting of some documentation tables (#1315)

Browse Source 
* Fix markdown formatting of release tables
* Fix markdown table formatting in documentation

Signed-off-by: Zygmunt Krynicki <me@zygoon.pl>
This commit is contained in:
Zygmunt Krynicki
2023-02-01 15:18:30 +01:00
committed by GitHub
parent 4bf0f878be
commit 498c9fa7e8
7 changed files with 339 additions and 346 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/content/concepts/authorization.md
View File

@@ -87,13 +87,13 @@ An example configuration is given below.
### Permission Matrix for example uses cases that need more than one permission
Use Case | Needed permissions
-------------------------------------------------------------------------- | ---------------------------------------------------------------------------
Search _targets_ by installed or assigned _distribution set_ | READ_REPOSITORY, READ_TARGET
Assign _DS_ to a _target_ | READ_REPOSITORY, UPDATE_TARGET
Assign DS to target through a _Rollout_, i.e. _Rollout_ creation and start | READ_REPOSITORY, READ_TARGET, READ_ROLLOUT, CREATE_ROLLOUT, HANDLE_ROLLOUT
Read _Rollout_ status including its _deployment groups_ | READ_REPOSITORY, READ_ROLLOUT
Checks _targets_ inside _Rollout deployment group_ | READ_REPOSITORY, READ_TARGET, READ_ROLLOUT
| Use Case | Needed permissions |
|----------------------------------------------------------------------------|----------------------------------------------------------------------------|
| Search _targets_ by installed or assigned _distribution set_ | READ_REPOSITORY, READ_TARGET |
| Assign _DS_ to a _target_ | READ_REPOSITORY, UPDATE_TARGET |
| Assign DS to target through a _Rollout_, i.e. _Rollout_ creation and start | READ_REPOSITORY, READ_TARGET, READ_ROLLOUT, CREATE_ROLLOUT, HANDLE_ROLLOUT |
| Read _Rollout_ status including its _deployment groups_ | READ_REPOSITORY, READ_ROLLOUT |
| Checks _targets_ inside _Rollout deployment group_ | READ_REPOSITORY, READ_TARGET, READ_ROLLOUT |
## Device Management Federation API

14
docs/content/concepts/targetstate.md
View File

@@ -9,13 +9,13 @@ A target has a current state which reflects the provisioning status of the devic
## Defined states
State | Description
---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------
UNKNOWN | Set by default for a pre-commissioned target until first status update received from the target. Is the initial starting point for targets created by UI or management API.
IN_SYNC | Assigned _Distribution Set_ is installed.
PENDING | Installation of assigned _Distribution Set_ is not yet confirmed.
ERROR | Installation of assigned _Distribution Set_ has failed.
REGISTERED | Target registered at the update server but no _Distribution Set_ assigned. Is the initial starting point for plug-and-play devices.
| State | Description |
|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| UNKNOWN | Set by default for a pre-commissioned target until first status update received from the target. Is the initial starting point for targets created by UI or management API. |
| IN_SYNC | Assigned _Distribution Set_ is installed. |
| PENDING | Installation of assigned _Distribution Set_ is not yet confirmed. |
| ERROR | Installation of assigned _Distribution Set_ has failed. |
| REGISTERED | Target registered at the update server but no _Distribution Set_ assigned. Is the initial starting point for plug-and-play devices. |
## Transitions
![](../../images/architecture/targetStatusStates.png)