Skip to content

Commit

Permalink
Add docs for process types (#138)
Browse files Browse the repository at this point in the history
* Add docs for process types

* Add to main nav

* Fix images path after merge

* Doc was in the wrong location.

* Fix syntax

* Fix incorrect reference

* Maybe it needs the module name?

* Apply suggestions from code review

Co-authored-by: Andrés Pereira de Lucena <[email protected]>

---------

Co-authored-by: Ruth Cheesley <[email protected]>
Co-authored-by: Ruth Cheesley <[email protected]>
Co-authored-by: Ruth Cheesley <[email protected]>
  • Loading branch information
4 people authored Jan 8, 2024
1 parent 0d6254c commit f759be7
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/en/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
**** xref:admin:spaces/processes/private_participants.adoc[Private participants]
**** xref:admin:spaces/processes/moderations.adoc[Moderations]
**** xref:admin:spaces/processes/groups.adoc[Process Groups]
**** xref:admin:spaces/processes/types.adoc[Process Types]
*** xref:admin:spaces/assemblies.adoc[Assemblies]
**** xref:admin:spaces/assemblies/components.adoc[Components]
**** xref:admin:spaces/assemblies/categories.adoc[Categories]
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 40 additions & 0 deletions docs/en/modules/admin/pages/spaces/processes/types.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
= Process types

In some cases it is necessary to organize participatory processes by more than just xref:spaces/processes/groups.adoc[Process Groups]. This is where Process Types can be useful.

Process Types work similarly to xref:admin:spaces/assemblies.adoc#_assemblies_types[Assembly types].

== New process type form

For creating a new process type:

. Sign in as administrator
. Go to the Processes section in the sidebar
. Click on the Process types link in the sidebar
. Click on the "New process type" button
. Fill in the form

image:spaces/processes/process-types-admin-backend.png[A screenshot of the back-end showing the button to create a new process type,title="Create a new process type in the back-end"]

.New participatory process type form: General information
|===
|Field |Type |Description

|Title
|Required
|Title of the participatory process type. For instance, "Consultative".

|===

== Add process type to existing processes

It's possible to add a process type to existing processes. Edit the process, and select the process type under the section labelled Other.

image:spaces/processes/process-types-edit-process.png[A screenshot of editing an existing process to add a process type,title="Add process type to an existing process"]

== Process type filter

In the front-end if there is at least one Process Type defined, a filter shows, allowing filtering of Processes.

image:spaces/processes/process-types-front-end.png[A screenshot of the front-end showing a filter for Process types,title="Front-end filter for Process Types"]

0 comments on commit f759be7

Please sign in to comment.