diff --git a/docs/en/modules/ROOT/nav.adoc b/docs/en/modules/ROOT/nav.adoc index f4df9cfb8d..bdbefbc405 100644 --- a/docs/en/modules/ROOT/nav.adoc +++ b/docs/en/modules/ROOT/nav.adoc @@ -24,7 +24,6 @@ ** xref:services:index.adoc[Services] *** xref:services:activejob.adoc[Active Job] *** xref:services:activestorage.adoc[Active Storage] -*** xref:services:elections_bulletin_board.adoc[Elections Bulletin Board] *** xref:services:etherpad.adoc[Etherpad] *** xref:services:maps.adoc[Maps] *** xref:services:sms.adoc[SMS] @@ -32,9 +31,6 @@ *** xref:services:social_providers.adoc[Social Providers] * Admin -** xref:admin:index.adoc[Introduction] -*** xref:admin:system.adoc[System panel] -*** xref:admin:dashboard.adoc[Dashboard] ** Settings *** xref:admin:configuration.adoc[Configuration] *** xref:admin:appearance.adoc[Appearance] @@ -110,11 +106,9 @@ *** xref:admin:features/badges.adoc[Badges] *** xref:admin:features/comments.adoc[Comments] *** xref:admin:features/conversations.adoc[Conversations] -*** xref:admin:features/embed.adoc[Embed] *** xref:admin:features/endorsements.adoc[Endorsements] *** xref:admin:features/fingerprint.adoc[Fingerprint] *** xref:admin:features/follows.adoc[Follows] -*** xref:admin:features/metrics.adoc[Metrics] *** xref:admin:features/my_account.adoc[My account] **** xref:admin:features/my_account/account.adoc[Account] **** xref:admin:features/my_account/notifications_settings.adoc[Notifications settings] @@ -137,8 +131,6 @@ *** xref:admin:features/versions.adoc[Versions] ** xref:admin:newsletters.adoc[Newsletters] ** xref:admin:global_moderations.adoc[Global moderations] -** Deprecated -*** xref:admin:information-pages.adoc[Information pages] * xref:contribute:index.adoc[Contribute] ** xref:contribute:governance.adoc[Governance] @@ -184,7 +176,7 @@ *** xref:develop:fixing_locales.adoc[Fixing locales] *** xref:develop:maps.adoc[Maps] *** xref:develop:managing_translations_i18n.adoc[i18n] -*** xref:develop:maintainers/index.adoc[Maintainers] +*** Maintainers **** xref:develop:backports.adoc[Backports] **** xref:develop:guide_github_projects.adoc[GitHub Projects Workflow] **** xref:develop:maintainers/releases.adoc[Releasing new versionss] diff --git a/docs/en/modules/admin/assets/images/spaces/processes/process-type-edit-process.png b/docs/en/modules/admin/assets/images/spaces/processes/process-types-edit-process.png similarity index 100% rename from docs/en/modules/admin/assets/images/spaces/processes/process-type-edit-process.png rename to docs/en/modules/admin/assets/images/spaces/processes/process-types-edit-process.png diff --git a/docs/en/modules/admin/assets/images/system-dashboard.png b/docs/en/modules/admin/assets/images/system-dashboard.png deleted file mode 100644 index 18d28390e8..0000000000 Binary files a/docs/en/modules/admin/assets/images/system-dashboard.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/system-log_in.png b/docs/en/modules/admin/assets/images/system-log_in.png deleted file mode 100644 index 674a6c1179..0000000000 Binary files a/docs/en/modules/admin/assets/images/system-log_in.png and /dev/null differ diff --git a/docs/en/modules/admin/pages/dashboard.adoc b/docs/en/modules/admin/pages/dashboard.adoc deleted file mode 100644 index cf0fdffcce..0000000000 --- a/docs/en/modules/admin/pages/dashboard.adoc +++ /dev/null @@ -1,23 +0,0 @@ -= Dashboard - -For your first time accessing to a Decidim plaform as Admin, you'll receive an invitation email so you can finish setting up your account with your nickname, name and password. - -Once you've finished and you're logged-in, you'll be able to access the Admin panel, starting with the Dashboard page. For this you'll need to click on your username, and click on "Admin dashboard". - -image::admin_dashboard_menu.png[Decidim Admin Dashboard in user menu] - -Here, you'll have a summary of the last activity of the platform. - -image::admin_dashboard.png[Decidim Admin Dashboard] - -You'll have three blocks: - -1. Activity: participants and admins that had logged in in last month, last week and last day. -2. Metrics: the graphics for the evolution of multiple things inside of Decidim: - * Participants - * Proposals - * Comments - * Meetings - * Accepted proposals - * Results -3. Admin log: last actions made by Administrator users in the platform. \ No newline at end of file diff --git a/docs/en/modules/admin/pages/features/embed.adoc b/docs/en/modules/admin/pages/features/embed.adoc deleted file mode 100644 index f83d8171b6..0000000000 --- a/docs/en/modules/admin/pages/features/embed.adoc +++ /dev/null @@ -1,23 +0,0 @@ -= Embed - -Sometimes you want to embed some content to an external page. For this you can use the `Embed` feature. - -image:features/embed/example.png[A proposal card embeded in another page] - -== How to embed - -. Navigate to the content you want to embed. -. Click on the `Embed` link in the sidebar. image:features/embed/link.png[] -image:features/embed/sidebar.png[] -. Copy the code from the modal. -image:features/embed/modal.png[] -. Paste that code in the external page where you want to embed it. The CMS or platform that you're using needs to supports -changing HTML code. - -An example of this code is: - -[source,html] ----- - - ----- diff --git a/docs/en/modules/admin/pages/features/metrics.adoc b/docs/en/modules/admin/pages/features/metrics.adoc deleted file mode 100644 index a9b2f4fa86..0000000000 --- a/docs/en/modules/admin/pages/features/metrics.adoc +++ /dev/null @@ -1,15 +0,0 @@ -= Metrics - -NOTE: Looking for how to enable this feature technically? Go to xref:develop:metrics.adoc[Metrics in Developers guide] - -With Metrics participants can see the evolution in time of some resources, such as Proposals, Supports, Endorsements, Followers, Participants, Accepted propsoals, Comments, etc. You can see a real world example of this in https://meta.decidim.org/processes/roadmap/all-metrics[Metadecidim Roadmap process]. - -For this to work it needs to be first xref:develop:metrics.adoc[configured technically] and also enabled by the setting in the participatory space (`Show metrics` checkbox). - -Then this section will be visible in the space landing page. - -image:features/metrics/example.png[Example of metrics] - -By clicking in "Show all metrics", visitors can see other metrics and download this data in CSV format. - -image:features/metrics/page.png[Metrics page] diff --git a/docs/en/modules/admin/pages/information-pages.adoc b/docs/en/modules/admin/pages/information-pages.adoc deleted file mode 100644 index 0873674249..0000000000 --- a/docs/en/modules/admin/pages/information-pages.adoc +++ /dev/null @@ -1,155 +0,0 @@ -= Information pages - -include::partial$legacy.adoc[] - -Here we offer you three informative pages that you can use as a template or re-use replacing the text highlighted in yellow with the correct text. You can find the same documents in spanish or catalan in their respective Administering Decidim document. - -== Information/FAQs - -[[t.6a4146f0a2c8ecae39afa2642bcb7f700ef842af]][[t.0]] - -[width="100%",cols="100%",] -|=== -|_FAQS (EN)_ -a| -If you’d like to take part in participatory processes and have your say, register! Note that to use some of the functions of certain processes (such as voting and prioritising) you will have to verify that you are registered with #Name of the Municipality/ Organization#, by following a very simple step. - -*What is #Name of the Municipality/ Organization?#* - -A platform for building a more participatory #Name of the Municipality/ Organization#, with a shared vision and for delving deeper into local participatory democracy. - -#Platformname# is a participatory platform based on open code. Citizens can see how it is built and can reuse or improve it. https://www.google.com/url?q=https://github.com/AjuntamentdeBarcelona/decidim.barcelona&sa=D&ust=1526042251888000[Check out the code here on GitHub]. - -*How can I participate in Platformname?* - -Get informed - -* Consult the active participatory processes. -* Browse through the proposals made by other citizens -* Access the face-to-face meetings' data and documents and the discussions and debates held there. -* Search contents of interest to you, by district, subject matter and tags. - -Take part - -* Make new proposals. -* Offer arguments in favour or against, or your general thoughts. -* Share the proposals on social media. - -a| -Follow the existing proposals - -* Follow the existing proposals: those started on the platform and those generated by face-to-face meetings. -* After the face-to-face meetings have taken place, you can follow the progress of the discussions and debates as well as the contributions generated. -* Tick a proposal of interest to you and follow its entire progress, from the comments made by others to the final documents. - -*What are...?* - -*Participatory processes* - -*#Platformname#* activities that involve citizens and which are carried out in several stages: information, diagnosis, contributions, decisions, results and evaluation of the proposals. - -*Assemblies* - -Permanent participatory channels and bodies. - -*Face-to-face meetings:* - -Meetings and work sessions for contributing to active participatory processes. - -*Surveys* - -Questionnaire for providing information and sharing your opinion. - -*Discussions and debates* - -Digital spaces for getting informed and deciding on the proposals in the processes that have this function enabled. - -*Proposals* - -Contributions you can make as a user. In some cases you will be able to receive votes from other users. Some of them will have a decision-taking function and others a merely consultative function. Each process will have its own characteristic rules. - -*Comments* - -Contributions you can make as a user in response to a proposal or discussion and debate. - -*My residency verification doesn't work.* - -Check the following possibilities: - -* Have you entered your national ID number or document without spaces between the digits, including the final letter? -* Are you sure you are a registered resident in the municipality of #Name of the Municipality/ Organization#? (The municipality is geographically smaller than the Barcelona Metropolitan Area and the Province of Barcelona) -* There may be a problem with your data in the residency register. Consult your nearest CITIZEN HELP AND INFORMATION OFFICE and confirm that your registration information is correct. - -If all the above steps do not solve the problem, email us at #Email# or come to the face-to-face discussions and debates for each process. - -*I am not a registered resident in #Name of the Municipality/ Organization#; why can't I vote for the proposals?* - -Only registered residents in #Name of the Municipality/ Organization# are allowed to vote in processes where proposals can be voted on. When it comes to questions that affect decisions to be taken that are specific to the city, it is the city’s residents who need to take part in such decision-taking. - -It is true that there are people not registered #Name of the Municipality/ Organization# residents who may still be affected by these decisions, but the Register is the broadest available census that we have in #Name of the Municipality/ Organization#: it allows us to reach the maximum number of people while also guaranteeing that the participatory process is secure. On the other hand, not all the processes launched from the platform require their participants to be registered residents in the city. - -*I am not a registered #Name of the Municipality/ Organization# resident. Can I participate?* - -Yes, you can take part even when you are not a registered resident. You can take part in several enabled processes, in face-to-face discussions and debates, and you can launch a proposal, without having to be a registered resident. It is only in some processes that voting for proposals is limited to registered residents, just as only registered residents can vote at municipal elections. - -*Why do I have to verify my account?* - -You need a user account to use the platform. You can do more or fewer things depending on the degree of verification: - -* If you register with the website through an email address without providing any further information (so the verification process is not carried out), you will be able to comment on and debate proposals. -* If after registering, you have carried out the basic verification, i.e. you have verified your residence through the platform (more info at "How do I create and verify my account?"), you can vote for proposals in processes that are feasible (in certain processes). -* You can always take part in person and at any of the face-to-face meetings there are for each participatory process. Contributions that are made face to face will be collected, published and accessible to the platform. - -*Do I need a mobile phone or access to internet to take part?* - -No. You can carry out any action relating to the proposals - whether for creating, supporting, voting for or getting informed about them - face to face at any of the discussions and debates that are held. You can also create a completely verified user account if you wish to use the platform. - -*How do I create and verify my account?* - -The first step is to create an account. Create the account and fill in the information you are asked for. You are required to tick the box stating that you accept our user terms and conditions. On creating a new account, an email will be sent to the address you have specified, and you will have to click on the link it contains (the "Confirm my account" link) to complete the creation of the account. - -Once your basic account has been created and you have logged in using your email and password, the system will give you the option of carrying out a basic verification. To do this, click on the "My account" link on the top right and then click on the "Verify my account" button. - -Some processes, where necessary, will also require you to enter your residency data, to verify you are a registered resident in #Name of the Municipality/ Organization# (it is important to enter the document number along with the letter and your date of birth, and tick the box stating you accept access to the Municipal Register). If your data is correct, your account will allow you to support the proposals. - -*I've forgotten my password and my account doesn't work. What can I do?* - -You can request a new password, which will be sent to your email address. If the above solution does not work, you can email us at #Email#, and we will solve the problem associated with your account. Processes that include face-to-face meetings are open to you to attend and take part in, without the need for you to register with the platform. - -*How can I change my email address, my user name, my password, unsubscribe or activate/deactivate the notifications that are sent to email address?* - -Click on the "Enter" link, enter your email address and password, and click on the "Enter" button. Once you have done so, click on the "My account" link, where you will find all the options, allowing you to change your email address or user name, unsubscribe, or activate/deactivate notifications. Once you have made the appropriate changes, make sure you click on the "Save changes" button. - -*I am unable to create my account correctly.* - -Review the section "My residency verification doesn't work", in case the problem lies in this step; generally speaking, this is the most frequent problem. If this does not solve your problem, review the section "How to create and verify my account", to ensure that your are following the steps correctly. If the problem persists, email us at #Email#, and you will be given assistance. -|=== - -[[h.mqwt6we7yoz]] -[[h.mkf6otb3mhlh]] -== Terms and conditions of use - -[[t.0c2d2bc083254e4010a82a1ac81ebd7f18f135ee]][[t.1]] - -[width="100%",cols="100%",] -|=== -|_Terms and conditions of use (EN)_ -a| -Legal aspects and conditions of use for the #Platformname# participatory platform at #Name of the Municipality/ Organization# City Council. - -(the ones that the legal services recommend you. You can use the https://www.google.com/url?q=https://decidim.barcelona/pages/terms-and-conditions&sa=D&ust=1526042251902000[Decidim.Barcelona terms and conditions of use] as a model). -|=== - -[[h.3oy7u29]] -== How the platform works - -[[t.44b67a895959076674b8c3aa044e22bbd448f440]][[t.2]] - -[width="100%",cols="100%",] -|=== -|_Accessibility (EN)_ -a| -This refers to the webpage's design and contents, which have to be accessible (without any visual or technological obstacles and for the largest number of users possible), and to standard regulations (WAI, Web Accessibility Initiative). - -Decidim.Barcelona example https://www.google.com/url?q=https://www.decidim.barcelona/pages/accessibility&sa=D&ust=1526042251903000[Accessibility]. -|=== diff --git a/docs/en/modules/admin/pages/system.adoc b/docs/en/modules/admin/pages/system.adoc deleted file mode 100644 index 111b0c8729..0000000000 --- a/docs/en/modules/admin/pages/system.adoc +++ /dev/null @@ -1,106 +0,0 @@ -= System - -Every Decidim is multi-tenant by default. That means that you can have multiple organizations inside of your same installation. This is being used for instance for the Barcelona and Girona Provincials Governments, for offering Decidim installations to many small cities, or by the City of Barcelona, for giving service to lots of organizations (NGOs, cooperatives, etc). - -Even if you only have one Organization you also need to create one through the System Panel. It's available after you've installed Decidim, at `/system`. For instance if you domain is `example.org`, then it should be available at `http://example.org/system`. - -After you've freshly installed Decidim, you'll be redirected to the System panel log-in page: - -image::system-log_in.png[system panel log in] - -== 1. Create an admin account - -For logging in to this dashboard, you'll need to create a system admin account from your terminal: - -[source, console] -.... -bin/rails decidim_system:create_admin -.... - -You'll be asked for an email and a password. For security, the password will not get displayed back at you and you'll need to confirm it. - -== 2. Access the Dashboard - -With the email and password that you've added in the past step, you'll be able to log in. After you've logged in, you'll see an empty dashboard: - -image::system-dashboard.png[system empty dashboard] - -== 3. Create a new organization - -Inside of the system panel, you need to create your Organization through the form: - -TIP: Please mind that some of these fields can't change through the System Form, as changing them could potentially leave your database in a broken state. You can change it through the console, but you'll be on your own. - -.System New Organization form -|=== -|Field |Type |Description - -|Name -|Required -|Name of your organization. For instance, "Decidim Barcelona". - -|Reference prefix -|Required -|The reference prefix is used to uniquely identify resources across all organizations. It's for identifying different resources inside of Decidim. For instance, "BCN". You can change how it's created this reference through xref:configure:initializer.adoc[Decidim's initializer] (see **Custom resource reference**). - -|Host -|Required -|Fully qualified domain name. For instance, "example.org" or "decidim.barcelona". - -|Secondary hosts -|Optional -|Others domains or subdomains that point to this same installation. Normally this shouldn't be used. Enter each one of them in a new line. For instance, "example.com" - -|Organization admin name -|Required -|Name of the admin account. For instance, "Admin" - -|Organization admin email -|Required -|Email for the admin account. For instance, "admin@example.org" - -|Organization locales -|Required -|You'll need to configure at least one language. Decidim is multilanguage, meaning that you can have most of the admin contents with any number of languages. For seeing other languages you'll need to configure first the xref:configure:initializer.adoc[Decidim's initializer]. - -|Force authentication -|Optional -|Check if you want to **Force users to authenticate before access organization**. That means that they don't see any published content and they only have access to the log-in form. - -|Users registration mode -|Optional -|Control how you want the login / participant register or signup to work. See below. - -|Available authorizations -|Optional -|How you want to authorize and verify that your participants are who they say they are. It depends a lot on your Organization, country, etc. See xref:customize:authorizations.adoc[Authorizations customization]. - -|SMTP settings -|Optional -|Allows you to configure different SMTP servers for every Organzation in this installation. See xref:services:smtp.adoc[SMTP configuration]. - -|Omniauth settings -|Optional -|Allows you to configure through external OAUTH providers for every Organization in this installation. See xref:services:social_providers.adoc[Social providers configuration]. -|=== - -=== Users registration mode - -==== Allow participants to register and login - -Most of the installations use this setting. Means that everyone can register a participant account and login, without restrictions, only with an email account confirmation (and you can disable that confirmation also if you want to through xref:configure:initializer.adoc[Decidim's initializer]) - -==== Don't allow participants to register, but allow existing participants to login - -This is for when you make a manual import of participants' accounts. - -==== Access only can be done with external accounts - -In the case where you have an external provider configured (like the `Omniauth settings`) and you want to have accounts from only this provider. - -== [Optional] 4. Edit an organization - -Finally, you can also Edit an organization, although some fields can not be changed as some contents in the database depends on them. - -For accessing your newly created Organization, you can do it going to the domain or subdomain that you've configured in `Host`. - diff --git a/docs/en/modules/admin/partials/components_list.adoc b/docs/en/modules/admin/partials/components_list.adoc index 521e07edb6..4c9e9198bf 100644 --- a/docs/en/modules/admin/partials/components_list.adoc +++ b/docs/en/modules/admin/partials/components_list.adoc @@ -7,8 +7,6 @@ It allows administrators to also relate them to the proposals and meetings that * xref:admin:components/budgets.adoc[*Budgets*]: allows participants to vote in projects with amounts predefined. Used for participatory budgeting processes. Allows to define different kind of rules, for instance a minimum percentage of the total budget or a minimum amount of projects. * xref:admin:components/debates.adoc[*Debates*]: allows participants to have debates. Debates can be time limited or not. -* xref:admin:components/elections.adoc[*Elections*]: to have end-to-end auditable elections in a space. Uses the same -external system as xref:admin:spaces/votings.adoc[Votings] space. * xref:admin:components/meetings.adoc[*Meetings*]: gatherings in person or online through videoconferences platforms. * xref:admin:components/pages.adoc[*Page*]: static pages with multi-language support. * xref:admin:components/proposals.adoc[*Proposals*]: contributions posted by participants which can be given support.