Skip to content

doc: improve accountability/statuses page #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

doc: improve accountability/statuses page #218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/en/modules/admin/assets/images/components/accountability/example01.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/en/modules/admin/assets/images/components/accountability/example02.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 10 additions & 4 deletions docs/en/modules/admin/pages/components/accountability/statuses.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,14 @@

== Understand the basics

Statuses allow to create progress states for results. Once you created statuses, you are able to make your results evolve
according to their implementation evolution. It also allows to give results progress percentages, ranging from 0 to 100%.
A status represents the current state of a result.
For participants, statuses clearly indicate the state of each result, as status names are always shown with results.

Check failure on line 6 in docs/en/modules/admin/pages/components/accountability/statuses.adoc

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[alex.Condescending] Using 'clearly' may come across as condescending.

Raw Output:
{"message": "[alex.Condescending] Using 'clearly' may come across as condescending.", "location": {"path": "docs/en/modules/admin/pages/components/accountability/statuses.adoc", "range": {"start": {"line": 6, "column": 28}}}, "severity": "ERROR"}
For administrators, statuses help to keep result's progress updated, since each status can have a default progress percentage.

After configuring statuses, you can assign xref:admin:components/accountability/results.adoc[a status to a result].
Once a result have its status updated, its progress is automatically set to the default progress defined in the status.

Updating a result's status won't update the result history, but may xref:admin:features/participant_actions/notifications.adoc[send notifications].

== Configuration

Expand All @@ -15,7 +21,7 @@

image::components/accountability/statuses_list.png[Statuses list]

Click on the "New status" button to start creating statuses.
Click on the "New status" button to start creating statuses.

image:components/accountability/new_status.png[New status form]

Expand All @@ -37,6 +43,6 @@

|Progress
|Optional
|Number with percentage (from 0 to 100) of the progress.
|Default progress for a result assigned to this state (percentage from 0 to 100).

Check warning on line 46 in docs/en/modules/admin/pages/components/accountability/statuses.adoc

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/en/modules/admin/pages/components/accountability/statuses.adoc", "range": {"start": {"line": 46, "column": 55}}}, "severity": "INFO"}

|===