diff --git a/.github/styles/Google/AMPM.yml b/.github/styles/Google/AMPM.yml new file mode 100644 index 0000000000..fbdc6e4f84 --- /dev/null +++ b/.github/styles/Google/AMPM.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Use 'AM' or 'PM' (preceded by a space)." +link: 'https://developers.google.com/style/word-list' +level: error +nonword: true +tokens: + - '\d{1,2}[AP]M' + - '\d{1,2} ?[ap]m' + - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/.github/styles/Google/Acronyms.yml b/.github/styles/Google/Acronyms.yml new file mode 100644 index 0000000000..f41af0189b --- /dev/null +++ b/.github/styles/Google/Acronyms.yml @@ -0,0 +1,64 @@ +extends: conditional +message: "Spell out '%s', if it's unfamiliar to the audience." +link: 'https://developers.google.com/style/abbreviations' +level: suggestion +ignorecase: false +# Ensures that the existence of 'first' implies the existence of 'second'. +first: '\b([A-Z]{3,5})\b' +second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' +# ... with the exception of these: +exceptions: + - API + - ASP + - CLI + - CPU + - CSS + - CSV + - DEBUG + - DOM + - DPI + - FAQ + - GCC + - GDB + - GET + - GPU + - GTK + - GUI + - HTML + - HTTP + - HTTPS + - IDE + - JAR + - JSON + - JSX + - LESS + - LLDB + - NET + - NOTE + - NVDA + - OSS + - PATH + - PDF + - PHP + - POST + - RAM + - REPL + - RSA + - SCM + - SCSS + - SDK + - SQL + - SSH + - SSL + - SVG + - TBD + - TCP + - TODO + - URI + - URL + - USB + - UTF + - XML + - XSS + - YAML + - ZIP diff --git a/.github/styles/Google/Colons.yml b/.github/styles/Google/Colons.yml new file mode 100644 index 0000000000..99363fbd46 --- /dev/null +++ b/.github/styles/Google/Colons.yml @@ -0,0 +1,8 @@ +extends: existence +message: "'%s' should be in lowercase." +link: 'https://developers.google.com/style/colons' +nonword: true +level: warning +scope: sentence +tokens: + - ':\s[A-Z]' diff --git a/.github/styles/Google/Contractions.yml b/.github/styles/Google/Contractions.yml new file mode 100644 index 0000000000..3a61508141 --- /dev/null +++ b/.github/styles/Google/Contractions.yml @@ -0,0 +1,36 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: 'https://developers.google.com/style/contractions' +level: suggestion +ignorecase: true +action: + name: replace +swap: +# Decidim reverses this rule, and do not use contractions, so this is tweaked accordingly. + aren't: are not + can't: cannot + couldn't: could not + didn't: did not + don't: do not + doesn't: does not + hasn't: has not + haven't: have not + how's: how is + it'd: it would + isn't: is not + it'll: it will + it's: it is + shouldn't: should not + that'll: that will + that's: that is + they'll: they will + they're: they are + wasn't: was not + we're: we are + we've: we have + weren't: were not + what's: what is + when's: when is + where's: where is + won't: will not + you'll: you will diff --git a/.github/styles/Google/DateFormat.yml b/.github/styles/Google/DateFormat.yml new file mode 100644 index 0000000000..e9d227fa13 --- /dev/null +++ b/.github/styles/Google/DateFormat.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Use 'July 31, 2016' format, not '%s'." +link: 'https://developers.google.com/style/dates-times' +ignorecase: true +level: error +nonword: true +tokens: + - '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}' + - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/.github/styles/Google/Ellipses.yml b/.github/styles/Google/Ellipses.yml new file mode 100644 index 0000000000..1e070517bf --- /dev/null +++ b/.github/styles/Google/Ellipses.yml @@ -0,0 +1,9 @@ +extends: existence +message: "In general, don't use an ellipsis." +link: 'https://developers.google.com/style/ellipses' +nonword: true +level: warning +action: + name: remove +tokens: + - '\.\.\.' diff --git a/.github/styles/Google/EmDash.yml b/.github/styles/Google/EmDash.yml new file mode 100644 index 0000000000..1befe72aa8 --- /dev/null +++ b/.github/styles/Google/EmDash.yml @@ -0,0 +1,12 @@ +extends: existence +message: "Don't put a space before or after a dash." +link: 'https://developers.google.com/style/dashes' +nonword: true +level: error +action: + name: edit + params: + - remove + - ' ' +tokens: + - '\s[—–]\s' diff --git a/.github/styles/Google/EnDash.yml b/.github/styles/Google/EnDash.yml new file mode 100644 index 0000000000..b314dc4e98 --- /dev/null +++ b/.github/styles/Google/EnDash.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Use an em dash ('—') instead of '–'." +link: 'https://developers.google.com/style/dashes' +nonword: true +level: error +action: + name: edit + params: + - replace + - '-' + - '—' +tokens: + - '–' diff --git a/.github/styles/Google/Exclamation.yml b/.github/styles/Google/Exclamation.yml new file mode 100644 index 0000000000..eea5fd24bd --- /dev/null +++ b/.github/styles/Google/Exclamation.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Don't use exclamation points in text." +link: 'https://developers.google.com/style/exclamation-points' +nonword: true +level: error +action: + name: remove +tokens: + - '\w+!(?:\s|$)' diff --git a/.github/styles/Google/FirstPerson.yml b/.github/styles/Google/FirstPerson.yml new file mode 100644 index 0000000000..0b7b8828ca --- /dev/null +++ b/.github/styles/Google/FirstPerson.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Avoid first-person pronouns such as '%s'." +link: 'https://developers.google.com/style/pronouns#personal-pronouns' +ignorecase: true +level: warning +nonword: true +tokens: + - (?:^|\s)I\s + - (?:^|\s)I,\s + - \bI'm\b + - \bme\b + - \bmy\b + - \bmine\b diff --git a/.github/styles/Google/Gender.yml b/.github/styles/Google/Gender.yml new file mode 100644 index 0000000000..c8486181d6 --- /dev/null +++ b/.github/styles/Google/Gender.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Don't use '%s' as a gender-neutral pronoun." +link: 'https://developers.google.com/style/pronouns#gender-neutral-pronouns' +level: error +ignorecase: true +tokens: + - he/she + - s/he + - \(s\)he diff --git a/.github/styles/Google/GenderBias.yml b/.github/styles/Google/GenderBias.yml new file mode 100644 index 0000000000..9e70190863 --- /dev/null +++ b/.github/styles/Google/GenderBias.yml @@ -0,0 +1,47 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +link: 'https://developers.google.com/style/inclusive-documentation' +ignorecase: true +level: error +action: + name: replace +swap: + (?:alumna|alumnus): graduate + (?:alumnae|alumni): graduates + air(?:m[ae]n|wom[ae]n): pilot(s) + anchor(?:m[ae]n|wom[ae]n): anchor(s) + authoress: author + camera(?:m[ae]n|wom[ae]n): camera operator(s) + chair(?:m[ae]n|wom[ae]n): chair(s) + congress(?:m[ae]n|wom[ae]n): member(s) of congress + door(?:m[ae]|wom[ae]n): concierge(s) + draft(?:m[ae]n|wom[ae]n): drafter(s) + fire(?:m[ae]n|wom[ae]n): firefighter(s) + fisher(?:m[ae]n|wom[ae]n): fisher(s) + fresh(?:m[ae]n|wom[ae]n): first-year student(s) + garbage(?:m[ae]n|wom[ae]n): waste collector(s) + lady lawyer: lawyer + ladylike: courteous + landlord: building manager + mail(?:m[ae]n|wom[ae]n): mail carriers + man and wife: husband and wife + man enough: strong enough + mankind: human kind + manmade: manufactured + manpower: personnel + men and girls: men and women + middle(?:m[ae]n|wom[ae]n): intermediary + news(?:m[ae]n|wom[ae]n): journalist(s) + ombuds(?:man|woman): ombuds + oneupmanship: upstaging + poetess: poet + police(?:m[ae]n|wom[ae]n): police officer(s) + repair(?:m[ae]n|wom[ae]n): technician(s) + sales(?:m[ae]n|wom[ae]n): salesperson or sales people + service(?:m[ae]n|wom[ae]n): soldier(s) + steward(?:ess)?: flight attendant + tribes(?:m[ae]n|wom[ae]n): tribe member(s) + waitress: waiter + woman doctor: doctor + woman scientist[s]?: scientist(s) + work(?:m[ae]n|wom[ae]n): worker(s) diff --git a/.github/styles/Google/HeadingPunctuation.yml b/.github/styles/Google/HeadingPunctuation.yml new file mode 100644 index 0000000000..b538be5b42 --- /dev/null +++ b/.github/styles/Google/HeadingPunctuation.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Don't put a period at the end of a heading." +link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' +nonword: true +level: warning +scope: heading +action: + name: edit + params: + - remove + - '.' +tokens: + - '[a-z0-9][.]\s*$' diff --git a/.github/styles/Google/Headings.yml b/.github/styles/Google/Headings.yml new file mode 100644 index 0000000000..a53301338a --- /dev/null +++ b/.github/styles/Google/Headings.yml @@ -0,0 +1,29 @@ +extends: capitalization +message: "'%s' should use sentence-style capitalization." +link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' +level: warning +scope: heading +match: $sentence +indicators: + - ':' +exceptions: + - Azure + - CLI + - Code + - Cosmos + - Docker + - Emmet + - gRPC + - I + - Kubernetes + - Linux + - macOS + - Marketplace + - MongoDB + - REPL + - Studio + - TypeScript + - URLs + - Visual + - VS + - Windows diff --git a/.github/styles/Google/Latin.yml b/.github/styles/Google/Latin.yml new file mode 100644 index 0000000000..ca03b9154b --- /dev/null +++ b/.github/styles/Google/Latin.yml @@ -0,0 +1,11 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: 'https://developers.google.com/style/abbreviations' +ignorecase: true +level: error +nonword: true +action: + name: replace +swap: + '\b(?:eg|e\.g\.)(?=[\s,;])': for example + '\b(?:ie|i\.e\.)(?=[\s,;])': that is diff --git a/.github/styles/Google/LyHyphens.yml b/.github/styles/Google/LyHyphens.yml new file mode 100644 index 0000000000..ac8f557a4a --- /dev/null +++ b/.github/styles/Google/LyHyphens.yml @@ -0,0 +1,14 @@ +extends: existence +message: "'%s' doesn't need a hyphen." +link: 'https://developers.google.com/style/hyphens' +level: error +ignorecase: false +nonword: true +action: + name: edit + params: + - replace + - '-' + - ' ' +tokens: + - '\s[^\s-]+ly-' diff --git a/.github/styles/Google/OptionalPlurals.yml b/.github/styles/Google/OptionalPlurals.yml new file mode 100644 index 0000000000..f858ea6fee --- /dev/null +++ b/.github/styles/Google/OptionalPlurals.yml @@ -0,0 +1,12 @@ +extends: existence +message: "Don't use plurals in parentheses such as in '%s'." +link: 'https://developers.google.com/style/plurals-parentheses' +level: error +nonword: true +action: + name: edit + params: + - remove + - '(s)' +tokens: + - '\b\w+\(s\)' diff --git a/.github/styles/Google/Ordinal.yml b/.github/styles/Google/Ordinal.yml new file mode 100644 index 0000000000..d1ac7d27e8 --- /dev/null +++ b/.github/styles/Google/Ordinal.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Spell out all ordinal numbers ('%s') in text." +link: 'https://developers.google.com/style/numbers' +level: error +nonword: true +tokens: + - \d+(?:st|nd|rd|th) diff --git a/.github/styles/Google/OxfordComma.yml b/.github/styles/Google/OxfordComma.yml new file mode 100644 index 0000000000..b9ba21ebb2 --- /dev/null +++ b/.github/styles/Google/OxfordComma.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Use the Oxford comma in '%s'." +link: 'https://developers.google.com/style/commas' +scope: sentence +level: warning +tokens: + - '(?:[^,]+,){1,}\s\w+\s(?:and|or)' diff --git a/.github/styles/Google/Parens.yml b/.github/styles/Google/Parens.yml new file mode 100644 index 0000000000..3b8711d0c8 --- /dev/null +++ b/.github/styles/Google/Parens.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Use parentheses judiciously." +link: 'https://developers.google.com/style/parentheses' +nonword: true +level: suggestion +tokens: + - '\(.+\)' diff --git a/.github/styles/Google/Passive.yml b/.github/styles/Google/Passive.yml new file mode 100644 index 0000000000..3265890e52 --- /dev/null +++ b/.github/styles/Google/Passive.yml @@ -0,0 +1,184 @@ +extends: existence +link: 'https://developers.google.com/style/voice' +message: "In general, use active voice instead of passive voice ('%s')." +ignorecase: true +level: suggestion +raw: + - \b(am|are|were|being|is|been|was|be)\b\s* +tokens: + - '[\w]+ed' + - awoken + - beat + - become + - been + - begun + - bent + - beset + - bet + - bid + - bidden + - bitten + - bled + - blown + - born + - bought + - bound + - bred + - broadcast + - broken + - brought + - built + - burnt + - burst + - cast + - caught + - chosen + - clung + - come + - cost + - crept + - cut + - dealt + - dived + - done + - drawn + - dreamt + - driven + - drunk + - dug + - eaten + - fallen + - fed + - felt + - fit + - fled + - flown + - flung + - forbidden + - foregone + - forgiven + - forgotten + - forsaken + - fought + - found + - frozen + - given + - gone + - gotten + - ground + - grown + - heard + - held + - hidden + - hit + - hung + - hurt + - kept + - knelt + - knit + - known + - laid + - lain + - leapt + - learnt + - led + - left + - lent + - let + - lighted + - lost + - made + - meant + - met + - misspelt + - mistaken + - mown + - overcome + - overdone + - overtaken + - overthrown + - paid + - pled + - proven + - put + - quit + - read + - rid + - ridden + - risen + - run + - rung + - said + - sat + - sawn + - seen + - sent + - set + - sewn + - shaken + - shaven + - shed + - shod + - shone + - shorn + - shot + - shown + - shrunk + - shut + - slain + - slept + - slid + - slit + - slung + - smitten + - sold + - sought + - sown + - sped + - spent + - spilt + - spit + - split + - spoken + - spread + - sprung + - spun + - stolen + - stood + - stridden + - striven + - struck + - strung + - stuck + - stung + - stunk + - sung + - sunk + - swept + - swollen + - sworn + - swum + - swung + - taken + - taught + - thought + - thrived + - thrown + - thrust + - told + - torn + - trodden + - understood + - upheld + - upset + - wed + - wept + - withheld + - withstood + - woken + - won + - worn + - wound + - woven + - written + - wrung diff --git a/.github/styles/Google/Periods.yml b/.github/styles/Google/Periods.yml new file mode 100644 index 0000000000..d24a6a6c03 --- /dev/null +++ b/.github/styles/Google/Periods.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't use periods with acronyms or initialisms such as '%s'." +link: 'https://developers.google.com/style/abbreviations' +level: error +nonword: true +tokens: + - '\b(?:[A-Z]\.){3,}' diff --git a/.github/styles/Google/Quotes.yml b/.github/styles/Google/Quotes.yml new file mode 100644 index 0000000000..3cb6f1abd1 --- /dev/null +++ b/.github/styles/Google/Quotes.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Commas and periods go inside quotation marks." +link: 'https://developers.google.com/style/quotation-marks' +level: error +nonword: true +tokens: + - '"[^"]+"[.,?]' diff --git a/.github/styles/Google/Ranges.yml b/.github/styles/Google/Ranges.yml new file mode 100644 index 0000000000..3ec045e777 --- /dev/null +++ b/.github/styles/Google/Ranges.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't add words such as 'from' or 'between' to describe a range of numbers." +link: 'https://developers.google.com/style/hyphens' +nonword: true +level: warning +tokens: + - '(?:from|between)\s\d+\s?-\s?\d+' diff --git a/.github/styles/Google/Semicolons.yml b/.github/styles/Google/Semicolons.yml new file mode 100644 index 0000000000..bb8b85b420 --- /dev/null +++ b/.github/styles/Google/Semicolons.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Use semicolons judiciously." +link: 'https://developers.google.com/style/semicolons' +nonword: true +scope: sentence +level: suggestion +tokens: + - ';' diff --git a/.github/styles/Google/Slang.yml b/.github/styles/Google/Slang.yml new file mode 100644 index 0000000000..63f4c248a8 --- /dev/null +++ b/.github/styles/Google/Slang.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Don't use internet slang abbreviations such as '%s'." +link: 'https://developers.google.com/style/abbreviations' +ignorecase: true +level: error +tokens: + - 'tl;dr' + - ymmv + - rtfm + - imo + - fwiw diff --git a/.github/styles/Google/Spacing.yml b/.github/styles/Google/Spacing.yml new file mode 100644 index 0000000000..66e45a6b72 --- /dev/null +++ b/.github/styles/Google/Spacing.yml @@ -0,0 +1,10 @@ +extends: existence +message: "'%s' should have one space." +link: 'https://developers.google.com/style/sentence-spacing' +level: error +nonword: true +action: + name: remove +tokens: + - '[a-z][.?!] {2,}[A-Z]' + - '[a-z][.?!][A-Z]' diff --git a/.github/styles/Google/Spelling.yml b/.github/styles/Google/Spelling.yml new file mode 100644 index 0000000000..527ac07d31 --- /dev/null +++ b/.github/styles/Google/Spelling.yml @@ -0,0 +1,10 @@ +extends: existence +message: "In general, use American spelling instead of '%s'." +link: 'https://developers.google.com/style/spelling' +ignorecase: true +level: warning +tokens: + - '(?:\w+)nised?' + - 'colour' + - 'labour' + - 'centre' diff --git a/.github/styles/Google/Units.yml b/.github/styles/Google/Units.yml new file mode 100644 index 0000000000..53522ab2de --- /dev/null +++ b/.github/styles/Google/Units.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Put a nonbreaking space between the number and the unit in '%s'." +link: "https://developers.google.com/style/units-of-measure" +nonword: true +level: error +tokens: + - \b\d+(?:B|kB|MB|GB|TB) + - \b\d+(?:ns|ms|s|min|h|d) diff --git a/.github/styles/Google/We.yml b/.github/styles/Google/We.yml new file mode 100644 index 0000000000..c7ac7d3622 --- /dev/null +++ b/.github/styles/Google/We.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Try to avoid using first-person plural like '%s'." +link: 'https://developers.google.com/style/pronouns#personal-pronouns' +level: warning +ignorecase: true +tokens: + - we + - we'(?:ve|re) + - ours? + - us + - let's diff --git a/.github/styles/Google/Will.yml b/.github/styles/Google/Will.yml new file mode 100644 index 0000000000..128a918362 --- /dev/null +++ b/.github/styles/Google/Will.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Avoid using '%s'." +link: 'https://developers.google.com/style/tense' +ignorecase: true +level: warning +tokens: + - will diff --git a/.github/styles/Google/WordList.yml b/.github/styles/Google/WordList.yml new file mode 100644 index 0000000000..0d675f2372 --- /dev/null +++ b/.github/styles/Google/WordList.yml @@ -0,0 +1,81 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: "https://developers.google.com/style/word-list" +level: warning +ignorecase: false +action: + name: replace +swap: + "(?:API Console|dev|developer) key": API key + "(?:cell ?phone|smart ?phone)": phone|mobile phone + "(?:dev|developer|APIs) console": API console + "(?:e-mail|Email|E-mail)": email + "(?:file ?path|path ?name)": path + "(?:kill|terminate|abort)": stop|exit|cancel|end + "(?:OAuth ?2|Oauth)": OAuth 2.0 + "(?:ok|Okay)": OK|okay + "(?:WiFi|wifi)": Wi-Fi + '[\.]+apk': APK + '3\-D': 3D + 'Google (?:I\-O|IO)': Google I/O + "tap (?:&|and) hold": touch & hold + "un(?:check|select)": clear + above: preceding + account name: username + action bar: app bar + admin: administrator + Ajax: AJAX + a\.k\.a|aka: or|also known as + Android device: Android-powered device + android: Android + API explorer: APIs Explorer + application: app + approx\.: approximately + authN: authentication + authZ: authorization + autoupdate: automatically update + cellular data: mobile data + cellular network: mobile network + chapter: documents|pages|sections + check box: checkbox + check: select + CLI: command-line tool + click on: click|click in + Cloud: Google Cloud Platform|GCP + Container Engine: Kubernetes Engine + content type: media type + curated roles: predefined roles + data are: data is + Developers Console: Google API Console|API Console + disabled?: turn off|off + ephemeral IP address: ephemeral external IP address + fewer data: less data + file name: filename + firewalls: firewall rules + functionality: capability|feature + Google account: Google Account + Google accounts: Google Accounts + Googling: search with Google + grayed-out: unavailable + HTTPs: HTTPS + in order to: to + ingest: import|load + k8s: Kubernetes + long press: touch & hold + network IP address: internal IP address + omnibox: address bar + open-source: open source + overview screen: recents screen + regex: regular expression + SHA1: SHA-1|HAS-SHA1 + sign into: sign in to + sign-?on: single sign-on + static IP address: static external IP address + stylesheet: style sheet + synch: sync + tablename: table name + tablet: device + touch: tap + url: URL + vs\.: versus + World Wide Web: web diff --git a/.github/styles/Google/meta.json b/.github/styles/Google/meta.json new file mode 100644 index 0000000000..a5da2a8480 --- /dev/null +++ b/.github/styles/Google/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/errata-ai/Google/releases.atom", + "vale_version": ">=1.0.0" +} diff --git a/.github/styles/Google/vocab.txt b/.github/styles/Google/vocab.txt new file mode 100644 index 0000000000..e69de29bb2 diff --git a/.github/styles/Vocab/Decidim/accept.txt b/.github/styles/Vocab/Decidim/accept.txt new file mode 100644 index 0000000000..3fb591a17d --- /dev/null +++ b/.github/styles/Vocab/Decidim/accept.txt @@ -0,0 +1,12 @@ +AES +CMS +Decidim +DNI +Etherpad +gamification +GNU +Jitsi +Keka +NIE +ODT +XLSX \ No newline at end of file diff --git a/.github/styles/Vocab/Decidim/reject.txt b/.github/styles/Vocab/Decidim/reject.txt new file mode 100644 index 0000000000..e69de29bb2 diff --git a/.github/styles/alex/Ablist.yml b/.github/styles/alex/Ablist.yml new file mode 100644 index 0000000000..cd6ddb5bd3 --- /dev/null +++ b/.github/styles/alex/Ablist.yml @@ -0,0 +1,248 @@ +--- +extends: substitution +message: When referring to a person, consider using '%s' instead of '%s'. +ignorecase: true +level: warning +action: + name: replace +swap: + ablebodied: non-disabled + addict: person with a drug addiction|person recovering from a drug addiction + addicts: people with a drug addiction|people recovering from a drug addiction + adhd: disorganized|distracted|energetic|hyperactive|impetuous|impulsive|inattentive|restless|unfocused + afflicted with MD: person who has muscular dystrophy + afflicted with a disability: has a disability|person with a disability|people with + disabilities + afflicted with a intellectual disability: person with an intellectual disability + afflicted with a polio: polio|person who had polio + afflicted with aids: person with AIDS + afflicted with an injury: sustain an injury|receive an injury + afflicted with disabilities: has a disability|person with a disability|people with + disabilities + afflicted with injuries: sustain injuries|receive injuries + afflicted with intellectual disabilities: person with an intellectual disability + afflicted with multiple sclerosis: person who has multiple sclerosis + afflicted with muscular dystrophy: person who has muscular dystrophy + afflicted with polio: polio|person who had polio + afflicted with psychosis: person with a psychotic condition|person with psychosis + afflicted with schizophrenia: person with schizophrenia + aids victim: person with AIDS + alcohol abuser: someone with an alcohol problem + alcoholic: someone with an alcohol problem + amputee: person with an amputation + anorexic: thin|slim + asylum: psychiatric hospital|mental health hospital + barren: empty|sterile|infertile + batshit: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of + mental illness|person with mental illness|person with symptoms of a mental disorder|person + with a mental disorder + bedlam: chaos|hectic|pandemonium + binge: enthusiastic|spree + bipolar: fluctuating|person with bipolar disorder + birth defect: has a disability|person with a disability|people with disabilities + blind eye to: careless|heartless|indifferent|insensitive + blind to: careless|heartless|indifferent|insensitive + blinded by: careless|heartless|indifferent|insensitive + bony: thin|slim + bound to a wheelchair: uses a wheelchair + buckteeth: person with prominent teeth|prominent teeth + bucktoothed: person with prominent teeth|prominent teeth + challenged: has a disability|person with a disability|people with disabilities + cleftlipped: person with a cleft-lip and palate + confined to a wheelchair: uses a wheelchair + contard: disagreeable|uneducated|ignorant|naive|inconsiderate + crazy: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of mental + illness|person with mental illness|person with symptoms of a mental disorder|person + with a mental disorder + cretin: creep|fool + cripple: person with a limp + crippled: person with a limp + daft: absurd|foolish + deaf and dumb: deaf + deaf ear to: careless|heartless|indifferent|insensitive + deaf to: careless|heartless|indifferent|insensitive + deafened by: careless|heartless|indifferent|insensitive + deafmute: deaf + delirious: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of + mental illness|person with mental illness|person with symptoms of a mental disorder|person + with a mental disorder + demented: person with dementia + depressed: sad|blue|bummed out|person with seasonal affective disorder|person with + psychotic depression|person with postpartum depression + detox: treatment + detox center: treatment center + diffability: has a disability|person with a disability|people with disabilities + differently abled: has a disability|person with a disability|people with disabilities + disabled: turned off|has a disability|person with a disability|people with disabilities + downs syndrome: Down Syndrome + dumb: foolish|ludicrous|speechless|silent + dummy: test double|placeholder|fake|stub + dummyobject: test double|placeholder|fake|stub + dummyvalue: test double|placeholder|fake|stub + dummyvariable: test double|placeholder|fake|stub + dwarf: person with dwarfism|little person|little people|LP|person of short stature + dyslexic: person with dyslexia + epileptic: person with epilepsy + family burden: with family support needs + feeble minded: foolish|ludicrous|silly + feebleminded: foolish|ludicrous|silly + fucktard: disagreeable|uneducated|ignorant|naive|inconsiderate + gimp: person with a limp + handicapable: has a disability|person with a disability|people with disabilities + handicapped: person with a handicap|accessible + handicapped parking: accessible parking + hare lip: cleft-lip and palate + harelip: cleft-lip and palate + harelipped: person with a cleft-lip and palate + has intellectual issues: person with an intellectual disability + hearing impaired: hard of hearing|partially deaf|partial hearing loss|deaf + hearing impairment: hard of hearing|partially deaf|partial hearing loss|deaf + idiot: foolish|ludicrous|silly + imbecile: foolish|ludicrous|silly + infantile paralysis: polio|person who had polio + insane: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of mental + illness|person with mental illness|person with symptoms of a mental disorder|person + with a mental disorder + insanely: incredibly + insanity: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of + mental illness|person with mental illness|person with symptoms of a mental disorder|person + with a mental disorder + insomnia: restlessness|sleeplessness + insomniac: person who has insomnia + insomniacs: people who have insomnia + intellectually disabled: person with an intellectual disability + intellectually disabled people: people with intellectual disabilities + invalid: turned off|has a disability|person with a disability|people with disabilities + junkie: person with a drug addiction|person recovering from a drug addiction + junkies: people with a drug addiction|people recovering from a drug addiction + lame: boring|dull + learning disabled: person with learning disabilities + libtard: disagreeable|uneducated|ignorant|naive|inconsiderate + loony: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of mental + illness|person with mental illness|person with symptoms of a mental disorder|person + with a mental disorder + loony bin: chaos|hectic|pandemonium + low iq: foolish|ludicrous|unintelligent + lunacy: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of mental + illness|person with mental illness|person with symptoms of a mental disorder|person + with a mental disorder + lunatic: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of + mental illness|person with mental illness|person with symptoms of a mental disorder|person + with a mental disorder + madhouse: chaos|hectic|pandemonium + maniac: fanatic|zealot|enthusiast + manic: person with schizophrenia + mental: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of mental + illness|person with mental illness|person with symptoms of a mental disorder|person + with a mental disorder + mental case: rude|malicious|mean|disgusting|incredible|vile|person with symptoms + of mental illness|person with mental illness|person with symptoms of a mental + disorder|person with a mental disorder + mental defective: rude|malicious|mean|disgusting|incredible|vile|person with symptoms + of mental illness|person with mental illness|person with symptoms of a mental + disorder|person with a mental disorder + mentally ill: rude|malicious|mean|disgusting|incredible|vile|person with symptoms + of mental illness|person with mental illness|person with symptoms of a mental + disorder|person with a mental disorder + midget: person with dwarfism|little person|little people|LP|person of short stature + mongoloid: person with Down Syndrome + moron: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of mental + illness|person with mental illness|person with symptoms of a mental disorder|person + with a mental disorder + moronic: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of + mental illness|person with mental illness|person with symptoms of a mental disorder|person + with a mental disorder + multiple sclerosis victim: person who has multiple sclerosis + neurotic: has an anxiety disorder|obsessive|pedantic|niggly|picky + nuts: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of mental + illness|person with mental illness|person with symptoms of a mental disorder|person + with a mental disorder + o.c.d: has an anxiety disorder|obsessive|pedantic|niggly|picky + o.c.d.: has an anxiety disorder|obsessive|pedantic|niggly|picky + ocd: has an anxiety disorder|obsessive|pedantic|niggly|picky + panic attack: fit of terror|scare + paraplegic: person with paraplegia + psycho: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of mental + illness|person with mental illness|person with symptoms of a mental disorder|person + with a mental disorder + psychopathology: rude|malicious|mean|disgusting|incredible|vile|person with symptoms + of mental illness|person with mental illness|person with symptoms of a mental + disorder|person with a mental disorder + psychotic: person with a psychotic condition|person with psychosis + quadriplegic: person with quadriplegia + rehab: treatment + rehab center: treatment center + restricted to a wheelchair: uses a wheelchair + retard: silly|dullard|person with Down Syndrome|person with developmental disabilities|delay|hold + back + retarded: silly|dullard|person with Down Syndrome|person with developmental disabilities|delay|hold + back + retards: "sillies|dullards|people with developmental disabilities|people with Down\u2019\ + s Syndrome|delays|holds back" + sane: correct|adequate|sufficient|consistent|valid|coherent|sensible|reasonable + sanity check: check|assertion|validation|smoke test + schizo: person with schizophrenia + schizophrenic: person with schizophrenia + senile: person with dementia + short bus: silly|dullard|person with Down Syndrome|person with developmental disabilities|delay|hold + back + simpleton: foolish|ludicrous|unintelligent + small person: person with dwarfism|little person|little people|LP|person of short + stature + sociopath: person with a personality disorder|person with psychopathic personality + sociopaths: people with psychopathic personalities|people with a personality disorder + spastic: person with cerebral palsy|twitch|flinch + spaz: person with cerebral palsy|twitch|flinch|hectic + special: has a disability|person with a disability|people with disabilities + special needs: has a disability|person with a disability|people with disabilities + special olympians: athletes|Special Olympics athletes + special olympic athletes: athletes|Special Olympics athletes + specially abled: has a disability|person with a disability|people with disabilities + stammering: stuttering|disfluency of speech + stroke victim: individual who has had a stroke + stupid: foolish|ludicrous|unintelligent + stutterer: person who stutters + suffer from aids: person with AIDS + suffer from an injury: sustain an injury|receive an injury + suffer from injuries: sustain injuries|receive injuries + suffering from a disability: has a disability|person with a disability|people with + disabilities + suffering from a polio: polio|person who had polio + suffering from a stroke: individual who has had a stroke + suffering from aids: person with AIDS + suffering from an injury: sustain an injury|receive an injury + suffering from an intellectual disability: person with an intellectual disability + suffering from disabilities: has a disability|person with a disability|people with + disabilities + suffering from injuries: sustain injuries|receive injuries + suffering from intellectual disabilities: person with an intellectual disability + suffering from multiple sclerosis: person who has multiple sclerosis + suffering from polio: polio|person who had polio + suffering from psychosis: person with a psychotic condition|person with psychosis + suffering from schizophrenia: person with schizophrenia + suffers from MD: person who has muscular dystrophy + suffers from aids: person with AIDS + suffers from an injury: sustain an injury|receive an injury + suffers from disabilities: has a disability|person with a disability|people with + disabilities + suffers from injuries: sustain injuries|receive injuries + suffers from intellectual disabilities: person with an intellectual disability + suffers from multiple sclerosis: person who has multiple sclerosis + suffers from muscular dystrophy: person who has muscular dystrophy + suffers from polio: polio|person who had polio + suffers from psychosis: person with a psychotic condition|person with psychosis + suffers from schizophrenia: person with schizophrenia + tourettes disorder: Tourette syndrome + tourettes syndrome: Tourette syndrome + vertically challenged: person with dwarfism|little person|little people|LP|person + of short stature + victim of a stroke: individual who has had a stroke + victim of aids: person with AIDS + victim of an injury: sustain an injury|receive an injury + victim of injuries: sustain injuries|receive injuries + victim of multiple sclerosis: person who has multiple sclerosis + victim of polio: polio|person who had polio + victim of psychosis: person with a psychotic condition|person with psychosis + wacko: foolish|ludicrous|unintelligent + whacko: foolish|ludicrous|unintelligent + wheelchair bound: uses a wheelchair diff --git a/.github/styles/alex/Condescending.yml b/.github/styles/alex/Condescending.yml new file mode 100644 index 0000000000..4283a33671 --- /dev/null +++ b/.github/styles/alex/Condescending.yml @@ -0,0 +1,16 @@ +--- +extends: existence +message: Using '%s' may come across as condescending. +link: https://css-tricks.com/words-avoid-educational-writing/ +level: error +ignorecase: true +tokens: + - obvious + - obviously + - simple + - simply + - easy + - easily + - of course + - clearly + - everyone knows diff --git a/.github/styles/alex/Gendered.yml b/.github/styles/alex/Gendered.yml new file mode 100644 index 0000000000..c7b1f06b4f --- /dev/null +++ b/.github/styles/alex/Gendered.yml @@ -0,0 +1,108 @@ +--- +extends: substitution +message: "Consider using '%s' instead of '%s'." +ignorecase: true +level: warning +action: + name: replace +swap: + ancient man: ancient civilization|ancient people + authoress: author|writer + average housewife: average consumer|average household|average homemaker + average man: average person + average working man: average wage earner|average taxpayer + aviatrix: aviator + bitch: whine|complain|cry + bitching: whining|complaining|crying + brotherhood of man: the human family + calendar girl: model + call girl: escort|prostitute|sex worker + churchman: cleric|practicing Christian|pillar of the Church + english master: english coordinator|senior teacher of english + englishmen: the english + executrix: executor + father of *: founder of + fellowship: camaraderie|community|organization + founding father: the founders|founding leaders|forebears + frenchmen: french|the french + freshman: first-year student|fresher + freshwoman: first-year student|fresher + housemaid: house worker|domestic help + housewife: homemaker|homeworker + housewives: homemakers|homeworkers + industrial man: industrial civilization|industrial people + lady doctor: doctor + ladylike: courteous|cultured + leading lady: lead + like a man: resolutely|bravely + mad man: fanatic|zealot|enthusiast + mad men: fanatics|zealots|enthusiasts + madman: fanatic|zealot|enthusiast + madmen: fanatics|zealots|enthusiasts + maiden: virgin + maiden flight: first flight + maiden name: birth name + maiden race: first race + maiden speech: first speech + maiden voyage: first voyage + man a desk: staff a desk + man enough: strong enough + man hour: staff hour|hour of work + man hours: staff hours|hours of work|hours of labor|hours + man in the street: ordinary citizen|typical person|average person + man of action: dynamo + man of letters: scholar|writer|literary figure + man of the land: farmer|rural worker|grazier|landowner|rural community|country people|country + folk + man of the world: sophisticate + man sized task: a demanding task|a big job + man the booth: staff the booth + man the phones: answer the phones + manhour: staff hour|hour of work + manhours: staff hours|hours of work|hours of labor|hours + mankind: humankind + manmade: manufactured|artificial|synthetic|machine-made|constructed + manned: staffed|crewed|piloted + manpower: human resources|workforce|personnel|staff|labor|personnel|labor force|staffing|combat + personnel + mans best friend: a faithful dog + mansized task: a demanding task|a big job + master copy: pass key|original + master key: pass key|original + master of ceremonies: emcee|moderator|convenor + master plan: grand scheme|guiding principles + master the art: become skilled + masterful: skilled|authoritative|commanding + mastermind: genius|creator|instigator|oversee|launch|originate + masterpiece: "work of genius|chef d\u2019oeuvre" + masterplan: vision|comprehensive plan + masterstroke: trump card|stroke of genius + men of science: scientists + midwife: birthing nurse + miss\.: ms. + moan: whine|complain|cry + moaning: whining|complaining|crying + modern man: modern civilization|modern people + motherly: loving|warm|nurturing + mrs\.: ms. + no mans land: unoccupied territory|wasteland|deathtrap + office girls: administrative staff + oneupmanship: upstaging|competitiveness + poetess: poet + railwayman: railway worker + sportsmanlike: fair|sporting + sportsmanship: fairness|good humor|sense of fair play + statesman like: diplomatic + statesmanlike: diplomatic + stockman: cattle worker|farmhand|drover + tax man: tax commissioner|tax office|tax collector + tradesmans entrance: service entrance + unmanned: robotic|automated + usherette: usher + wife beater: tank top|sleeveless undershirt + wifebeater: tank top|sleeveless undershirt + woman lawyer: lawyer + woman painter: painter + working mother: wage or salary earning woman|two-income family + working wife: wage or salary earning woman|two-income family + workmanship: quality construction|expertise diff --git a/.github/styles/alex/LGBTQ.yml b/.github/styles/alex/LGBTQ.yml new file mode 100644 index 0000000000..842a9c6f1d --- /dev/null +++ b/.github/styles/alex/LGBTQ.yml @@ -0,0 +1,55 @@ +--- +extends: substitution +message: Consider using '%s' instead of '%s'. +ignorecase: true +level: warning +action: + name: replace +swap: + bathroom bill: non-discrimination law|non-discrimination ordinance + bi: bisexual + biologically female: assigned female at birth|designated female at birth + biologically male: assigned male at birth|designated male at birth + born a man: assigned male at birth|designated male at birth + born a woman: assigned female at birth|designated female at birth + dyke: gay + fag: gay + faggot: gay + gay agenda: gay issues + gay lifestyle: gay lives|gay/lesbian lives + gay rights: equal rights|civil rights for gay people + gender pronoun: pronoun|pronouns + gender pronouns: pronoun|pronouns + genetically female: assigned female at birth|designated female at birth + genetically male: assigned male at birth|designated male at birth + hermaphrodite: person who is intersex|person|intersex person + hermaphroditic: intersex + heshe: transgender person|person + homo: gay + homosexual: gay|gay man|lesbian|gay person/people + homosexual agenda: gay issues + homosexual couple: couple + homosexual lifestyle: gay lives|gay/lesbian lives + homosexual marriage: gay marriage|same-sex marriage + homosexual relations: relationship + homosexual relationship: relationship + preferred pronoun: pronoun|pronouns + preferred pronouns: pronoun|pronouns + pseudo hermaphrodite: person who is intersex|person|intersex person + pseudo hermaphroditic: intersex + pseudohermaphrodite: person who is intersex|person|intersex person + pseudohermaphroditic: intersex + sex change: transition|gender confirmation surgery + sex change operation: sex reassignment surgery|gender confirmation surgery + sexchange: transition|gender confirmation surgery + sexual preference: sexual orientation|orientation + she male: transgender person|person + shehe: transgender person|person + shemale: transgender person|person + sodomite: gay + special rights: equal rights|civil rights for gay people + tranny: transgender + transgendered: transgender + transgenderism: being transgender|the movement for transgender equality + transgenders: transgender people + transvestite: cross-dresser diff --git a/.github/styles/alex/Press.yml b/.github/styles/alex/Press.yml new file mode 100644 index 0000000000..06991dbf18 --- /dev/null +++ b/.github/styles/alex/Press.yml @@ -0,0 +1,11 @@ +--- +extends: substitution +message: Consider using '%s' instead of '%s'. +ignorecase: true +level: warning +action: + name: replace +swap: + islamist: muslim|person of Islamic faith|fanatic|zealot|follower of islam|follower + of the islamic faith + islamists: muslims|people of Islamic faith|fanatics|zealots diff --git a/.github/styles/alex/ProfanityLikely.yml b/.github/styles/alex/ProfanityLikely.yml new file mode 100644 index 0000000000..1c03e19897 --- /dev/null +++ b/.github/styles/alex/ProfanityLikely.yml @@ -0,0 +1,1289 @@ +extends: existence +message: Don't use '%s', it’s profane. +level: warning +ignorecase: true +tokens: + - abeed + - africoon + - alligator bait + - alligatorbait + - analannie + - arabush + - arabushs + - argie + - armo + - armos + - arse + - arsehole + - ass + - assbagger + - assblaster + - assclown + - asscowboy + - asses + - assfuck + - assfucker + - asshat + - asshole + - assholes + - asshore + - assjockey + - asskiss + - asskisser + - assklown + - asslick + - asslicker + - asslover + - assman + - assmonkey + - assmunch + - assmuncher + - asspacker + - asspirate + - asspuppies + - assranger + - asswhore + - asswipe + - backdoorman + - badfuck + - balllicker + - barelylegal + - barf + - barface + - barfface + - bazongas + - bazooms + - beanbag + - beanbags + - beaner + - beaners + - beaney + - beaneys + - beatoff + - beatyourmeat + - biatch + - bigass + - bigbastard + - bigbutt + - bitcher + - bitches + - bitchez + - bitchin + - bitching + - bitchslap + - bitchy + - biteme + - blowjob + - bluegum + - bluegums + - boang + - boche + - boches + - bogan + - bohunk + - bollick + - bollock + - bollocks + - bong + - boob + - boobies + - boobs + - booby + - boody + - boong + - boonga + - boongas + - boongs + - boonie + - boonies + - bootlip + - bootlips + - booty + - bootycall + - bosch + - bosche + - bosches + - boschs + - brea5t + - breastjob + - breastlover + - breastman + - buddhahead + - buddhaheads + - buffies + - bugger + - buggered + - buggery + - bule + - bules + - bullcrap + - bulldike + - bulldyke + - bullshit + - bumblefuck + - bumfuck + - bung + - bunga + - bungas + - bunghole + - "burr head" + - "burr heads" + - burrhead + - burrheads + - butchbabes + - butchdike + - butchdyke + - buttbang + - buttface + - buttfuck + - buttfucker + - buttfuckers + - butthead + - buttman + - buttmunch + - buttmuncher + - buttpirate + - buttplug + - buttstain + - byatch + - cacker + - "camel jockey" + - "camel jockeys" + - cameljockey + - cameltoe + - carpetmuncher + - carruth + - chav + - "cheese eating surrender monkey" + - "cheese eating surrender monkies" + - "cheeseeating surrender monkey" + - "cheeseeating surrender monkies" + - cheesehead + - cheeseheads + - cherrypopper + - chickslick + - "china swede" + - "china swedes" + - chinaman + - chinamen + - chinaswede + - chinaswedes + - "ching chong" + - "ching chongs" + - chingchong + - chingchongs + - chink + - chinks + - chinky + - choad + - chode + - chonkies + - chonky + - chonkys + - "christ killer" + - "christ killers" + - chug + - chugs + - chunger + - chungers + - chunkies + - chunky + - chunkys + - clamdigger + - clamdiver + - clansman + - clansmen + - clanswoman + - clanswomen + - clit + - clitoris + - clogwog + - cockblock + - cockblocker + - cockcowboy + - cockfight + - cockhead + - cockknob + - cocklicker + - cocklover + - cocknob + - cockqueen + - cockrider + - cocksman + - cocksmith + - cocksmoker + - cocksucer + - cocksuck + - cocksucked + - cocksucker + - cocksucking + - cocktease + - cocky + - cohee + - commie + - coolie + - coolies + - cooly + - coon + - "coon ass" + - "coon asses" + - coonass + - coonasses + - coondog + - coons + - cornhole + - cracka + - crackwhore + - crap + - crapola + - crapper + - crappy + - crotchjockey + - crotchmonkey + - crotchrot + - cum + - cumbubble + - cumfest + - cumjockey + - cumm + - cummer + - cumming + - cummings + - cumquat + - cumqueen + - cumshot + - cunn + - cunntt + - cunt + - cunteyed + - cuntfuck + - cuntfucker + - cuntlick + - cuntlicker + - cuntlicking + - cuntsucker + - "curry muncher" + - "curry munchers" + - currymuncher + - currymunchers + - cushi + - cushis + - cyberslimer + - dago + - dagos + - dahmer + - dammit + - damnit + - darkey + - darkeys + - darkie + - darkies + - darky + - datnigga + - deapthroat + - deepthroat + - dego + - degos + - "diaper head" + - "diaper heads" + - diaperhead + - diaperheads + - dickbrain + - dickforbrains + - dickhead + - dickless + - dicklick + - dicklicker + - dickman + - dickwad + - dickweed + - diddle + - dingleberry + - dink + - dinks + - dipshit + - dipstick + - dix + - dixiedike + - dixiedyke + - doggiestyle + - doggystyle + - dong + - doodoo + - dope + - "dot head" + - "dot heads" + - dothead + - dotheads + - dragqueen + - dragqween + - dripdick + - dumb + - dumbass + - dumbbitch + - dumbfuck + - "dune coon" + - "dune coons" + - dyefly + - easyslut + - eatballs + - eatme + - eatpussy + - "eight ball" + - "eight balls" + - ero + - esqua + - evl + - exkwew + - facefucker + - faeces + - fagging + - faggot + - fagot + - fannyfucker + - farty + - fastfuck + - fatah + - fatass + - fatfuck + - fatfucker + - fatso + - fckcum + - felch + - felcher + - felching + - fellatio + - feltch + - feltcher + - feltching + - fingerfuck + - fingerfucked + - fingerfucker + - fingerfuckers + - fingerfucking + - fister + - fistfuck + - fistfucked + - fistfucker + - fistfucking + - fisting + - flange + - floo + - flydie + - flydye + - fok + - footfuck + - footfucker + - footlicker + - footstar + - forni + - fornicate + - foursome + - fourtwenty + - fraud + - freakfuck + - freakyfucker + - freefuck + - fu + - fubar + - fuc + - fucck + - fuck + - fucka + - fuckable + - fuckbag + - fuckbook + - fuckbuddy + - fucked + - fuckedup + - fucker + - fuckers + - fuckface + - fuckfest + - fuckfreak + - fuckfriend + - fuckhead + - fuckher + - fuckin + - fuckina + - fucking + - fuckingbitch + - fuckinnuts + - fuckinright + - fuckit + - fuckknob + - fuckme + - fuckmehard + - fuckmonkey + - fuckoff + - fuckpig + - fucks + - fucktard + - fuckwhore + - fuckyou + - fudgepacker + - fugly + - fuk + - fuks + - funeral + - funfuck + - fungus + - fuuck + - gables + - gangbang + - gangbanged + - gangbanger + - gangsta + - "gator bait" + - gatorbait + - gaymuthafuckinwhore + - gaysex + - geez + - geezer + - geni + - getiton + - ginzo + - ginzos + - gipp + - gippo + - gippos + - gipps + - givehead + - glazeddonut + - godammit + - goddamit + - goddammit + - goddamn + - goddamned + - goddamnes + - goddamnit + - goddamnmuthafucker + - goldenshower + - golliwog + - golliwogs + - gonorrehea + - gonzagas + - gook + - "gook eye" + - "gook eyes" + - gookeye + - gookeyes + - gookies + - gooks + - gooky + - gora + - goras + - gotohell + - greaseball + - greaseballs + - greaser + - greasers + - gringo + - gringos + - groe + - groid + - groids + - gubba + - gubbas + - gubs + - gummer + - gwailo + - gwailos + - gweilo + - gweilos + - gyopo + - gyopos + - gyp + - gyped + - gypo + - gypos + - gypp + - gypped + - gyppie + - gyppies + - gyppo + - gyppos + - gyppy + - gyppys + - gypsies + - gypsy + - gypsys + - hadji + - hadjis + - hairyback + - hairybacks + - haji + - hajis + - hajji + - hajjis + - "half breed" + - "half caste" + - halfbreed + - halfcaste + - hamas + - handjob + - haole + - haoles + - hapa + - hardon + - headfuck + - headlights + - hebe + - hebephila + - hebephile + - hebephiles + - hebephilia + - hebephilic + - hebes + - heeb + - heebs + - hillbillies + - hillbilly + - hindoo + - hiscock + - hitler + - hitlerism + - hitlerist + - ho + - hobo + - hodgie + - hoes + - holestuffer + - homo + - homobangers + - honger + - honk + - honkers + - honkey + - honkeys + - honkie + - honkies + - honky + - hooker + - hookers + - hooters + - hore + - hori + - horis + - hork + - horney + - horniest + - horseshit + - hosejob + - hoser + - hotdamn + - hotpussy + - hottotrot + - hussy + - hymie + - hymies + - iblowu + - idiot + - ikeymo + - ikeymos + - ikwe + - indons + - injun + - injuns + - insest + - intheass + - inthebuff + - jackass + - jackoff + - jackshit + - jacktheripper + - jap + - japcrap + - japie + - japies + - japs + - jebus + - jeez + - jerkoff + - jewboy + - jewed + - jewess + - jig + - jiga + - jigaboo + - jigaboos + - jigarooni + - jigaroonis + - jigg + - jigga + - jiggabo + - jiggabos + - jiggas + - jigger + - jiggers + - jiggs + - jiggy + - jigs + - jijjiboo + - jijjiboos + - jimfish + - jism + - jiz + - jizim + - jizjuice + - jizm + - jizz + - jizzim + - jizzum + - juggalo + - "jungle bunnies" + - "jungle bunny" + - junglebunny + - kacap + - kacapas + - kacaps + - kaffer + - kaffir + - kaffre + - kafir + - kanake + - katsap + - katsaps + - khokhol + - khokhols + - kigger + - kike + - kikes + - kimchis + - kissass + - kkk + - klansman + - klansmen + - klanswoman + - klanswomen + - kondum + - koon + - krap + - krappy + - krauts + - kuffar + - kum + - kumbubble + - kumbullbe + - kummer + - kumming + - kumquat + - kums + - kunilingus + - kunnilingus + - kunt + - kushi + - kushis + - kwa + - "kwai lo" + - "kwai los" + - ky + - kyke + - kykes + - kyopo + - kyopos + - lebo + - lebos + - lesbain + - lesbayn + - lesbian + - lesbin + - lesbo + - lez + - lezbe + - lezbefriends + - lezbo + - lezz + - lezzo + - lickme + - limey + - limpdick + - limy + - livesex + - loadedgun + - looser + - loser + - lovebone + - lovegoo + - lovegun + - lovejuice + - lovemuscle + - lovepistol + - loverocket + - lowlife + - lsd + - lubejob + - lubra + - luckycammeltoe + - lugan + - lugans + - mabuno + - mabunos + - macaca + - macacas + - magicwand + - mahbuno + - mahbunos + - mams + - manhater + - manpaste + - mastabate + - mastabater + - masterbate + - masterblaster + - mastrabator + - masturbate + - masturbating + - mattressprincess + - "mau mau" + - "mau maus" + - maumau + - maumaus + - meatbeatter + - meatrack + - mgger + - mggor + - mickeyfinn + - milf + - mockey + - mockie + - mocky + - mofo + - moky + - moneyshot + - "moon cricket" + - "moon crickets" + - mooncricket + - mooncrickets + - moron + - moskal + - moskals + - moslem + - mosshead + - mothafuck + - mothafucka + - mothafuckaz + - mothafucked + - mothafucker + - mothafuckin + - mothafucking + - mothafuckings + - motherfuck + - motherfucked + - motherfucker + - motherfuckin + - motherfucking + - motherfuckings + - motherlovebone + - muff + - muffdive + - muffdiver + - muffindiver + - mufflikcer + - mulatto + - muncher + - munt + - mzungu + - mzungus + - nastybitch + - nastyho + - nastyslut + - nastywhore + - negres + - negress + - negro + - negroes + - negroid + - negros + - nig + - nigar + - nigars + - niger + - nigerian + - nigerians + - nigers + - nigette + - nigettes + - nigg + - nigga + - niggah + - niggahs + - niggar + - niggaracci + - niggard + - niggarded + - niggarding + - niggardliness + - niggardlinesss + - niggardly + - niggards + - niggars + - niggas + - niggaz + - nigger + - niggerhead + - niggerhole + - niggers + - niggle + - niggled + - niggles + - niggling + - nigglings + - niggor + - niggress + - niggresses + - nigguh + - nigguhs + - niggur + - niggurs + - niglet + - nignog + - nigor + - nigors + - nigr + - nigra + - nigras + - nigre + - nigres + - nigress + - nigs + - nip + - nittit + - nlgger + - nlggor + - nofuckingway + - nookey + - nookie + - noonan + - nudger + - nutfucker + - ontherag + - orga + - orgasim + - paki + - pakis + - palesimian + - "pancake face" + - "pancake faces" + - pansies + - pansy + - panti + - payo + - peckerwood + - pedo + - peehole + - peepshpw + - peni5 + - perv + - phuk + - phuked + - phuking + - phukked + - phukking + - phungky + - phuq + - pi55 + - picaninny + - piccaninny + - pickaninnies + - pickaninny + - piefke + - piefkes + - piker + - pikey + - piky + - pimp + - pimped + - pimper + - pimpjuic + - pimpjuice + - pimpsimp + - pindick + - piss + - pissed + - pisser + - pisses + - pisshead + - pissin + - pissing + - pissoff + - pocha + - pochas + - pocho + - pochos + - pocketpool + - pohm + - pohms + - polack + - polacks + - pollock + - pollocks + - pom + - pommie + - "pommie grant" + - "pommie grants" + - pommies + - pommy + - poms + - poo + - poon + - poontang + - poop + - pooper + - pooperscooper + - pooping + - poorwhitetrash + - popimp + - "porch monkey" + - "porch monkies" + - porchmonkey + - pornking + - porno + - pornography + - pornprincess + - "prairie nigger" + - "prairie niggers" + - premature + - pric + - prick + - prickhead + - pu55i + - pu55y + - pubiclice + - pud + - pudboy + - pudd + - puddboy + - puke + - puntang + - purinapricness + - puss + - pussie + - pussies + - pussyeater + - pussyfucker + - pussylicker + - pussylips + - pussylover + - pussypounder + - pusy + - quashie + - queef + - quickie + - quim + - ra8s + - raghead + - ragheads + - raper + - rearend + - rearentry + - redleg + - redlegs + - redneck + - rednecks + - redskin + - redskins + - reefer + - reestie + - rere + - retard + - retarded + - ribbed + - rigger + - rimjob + - rimming + - "round eyes" + - roundeye + - russki + - russkie + - sadis + - sadom + - sambo + - sambos + - samckdaddy + - "sand nigger" + - "sand niggers" + - sandm + - sandnigger + - satan + - scag + - scallywag + - schlong + - schvartse + - schvartsen + - schwartze + - schwartzen + - screwyou + - seppo + - seppos + - sexed + - sexfarm + - sexhound + - sexhouse + - sexing + - sexkitten + - sexpot + - sexslave + - sextogo + - sexwhore + - sexymoma + - sexyslim + - shaggin + - shagging + - shat + - shav + - shawtypimp + - sheeney + - shhit + - shiksa + - shinola + - shit + - shitcan + - shitdick + - shite + - shiteater + - shited + - shitface + - shitfaced + - shitfit + - shitforbrains + - shitfuck + - shitfucker + - shitfull + - shithapens + - shithappens + - shithead + - shithouse + - shiting + - shitlist + - shitola + - shitoutofluck + - shits + - shitstain + - shitted + - shitter + - shitting + - shitty + - shortfuck + - shylock + - shylocks + - sissy + - sixsixsix + - sixtynine + - sixtyniner + - skank + - skankbitch + - skankfuck + - skankwhore + - skanky + - skankybitch + - skankywhore + - skinflute + - skum + - skumbag + - skwa + - skwe + - slant + - slanteye + - slanty + - slapper + - slave + - slavedriver + - sleezebag + - sleezeball + - slideitin + - slimeball + - slimebucket + - slopehead + - slopeheads + - sloper + - slopers + - slopes + - slopey + - slopeys + - slopies + - slopy + - slut + - sluts + - slutt + - slutting + - slutty + - slutwear + - slutwhore + - smackthemonkey + - smut + - snatchpatch + - snowback + - snownigger + - sodomise + - sodomize + - sodomy + - sonofabitch + - sonofbitch + - sooties + - sooty + - spaghettibender + - spaghettinigger + - spankthemonkey + - spearchucker + - spearchuckers + - spermacide + - spermbag + - spermhearder + - spermherder + - spic + - spick + - spicks + - spics + - spig + - spigotty + - spik + - spit + - spitter + - splittail + - spooge + - spreadeagle + - spunk + - spunky + - sqeh + - squa + - squarehead + - squareheads + - squaw + - squinty + - stringer + - stripclub + - stuinties + - stupid + - stupidfuck + - stupidfucker + - suckdick + - sucker + - suckme + - suckmyass + - suckmydick + - suckmytit + - suckoff + - swallower + - swalow + - "swamp guinea" + - "swamp guineas" + - tacohead + - tacoheads + - taff + - tang + - "tar babies" + - "tar baby" + - tarbaby + - tard + - teste + - thicklip + - thicklips + - thirdeye + - thirdleg + - threeway + - "timber nigger" + - "timber niggers" + - timbernigger + - tinker + - tinkers + - titbitnipply + - titfuck + - titfucker + - titfuckin + - titjob + - titlicker + - titlover + - tits + - tittie + - titties + - titty + - tongethruster + - tongue + - tonguethrust + - tonguetramp + - tortur + - tosser + - "towel head" + - "towel heads" + - towelhead + - trailertrash + - trannie + - tranny + - transvestite + - triplex + - tuckahoe + - tunneloflove + - turd + - turnon + - twat + - twink + - twinkie + - twobitwhore + - uck + - ukrop + - "uncle tom" + - unfuckable + - upskirt + - uptheass + - upthebutt + - usama + - vibr + - vibrater + - vomit + - wab + - wank + - wanker + - wanking + - waysted + - weenie + - weewee + - welcher + - welfare + - wetb + - wetback + - wetbacks + - wetspot + - whacker + - whash + - whigger + - whiggers + - whiskeydick + - whiskydick + - "white trash" + - whitenigger + - whitetrash + - whitey + - whiteys + - whities + - whiz + - whop + - whore + - whorefucker + - whorehouse + - wigga + - wiggas + - wigger + - wiggers + - willie + - williewanker + - wn + - wog + - wogs + - womens + - wop + - wtf + - wuss + - wuzzie + - xkwe + - yank + - yanks + - yarpie + - yarpies + - yellowman + - yid + - yids + - zigabo + - zigabos + - zipperhead + - zipperheads diff --git a/.github/styles/alex/ProfanityMaybe.yml b/.github/styles/alex/ProfanityMaybe.yml new file mode 100644 index 0000000000..e889b3a3b1 --- /dev/null +++ b/.github/styles/alex/ProfanityMaybe.yml @@ -0,0 +1,282 @@ +extends: existence +message: Reconsider using '%s', it may be profane. +level: warning +ignorecase: true +tokens: + - abbo + - abid + - abo + - abortion + - abuse + - addict + - addicts + - alla + - anal + - analsex + - anus + - areola + - athletesfoot + - attack + - australian + - babe + - banging + - bastard + - beastality + - beastial + - beastiality + - bicurious + - bitch + - bitches + - blackman + - blacks + - bondage + - boob + - boobs + - "bounty bar" + - "bounty bars" + - bountybar + - brothel + - buttplug + - clit + - clitoris + - cocaine + - cock + - coitus + - condom + - copulate + - cra5h + - crack + - cracker + - crackpipe + - crotch + - cunilingus + - cunillingus + - cybersex + - damn + - damnation + - defecate + - demon + - devil + - devilworshipper + - dick + - dike + - dildo + - drug + - drunk + - drunken + - dyke + - ejaculate + - ejaculated + - ejaculating + - ejaculation + - enema + - erection + - excrement + - fag + - fart + - farted + - farting + - feces + - felatio + - fetish + - fingerfood + - flasher + - flatulence + - fondle + - footaction + - foreskin + - foursome + - fourtwenty + - fruitcake + - gable + - genital + - gob + - god + - gonzagas + - goy + - goyim + - groe + - gross + - grostulation + - gub + - guinea + - guineas + - guizi + - hamas + - hebephila + - hebephile + - hebephiles + - hebephilia + - hebephilic + - heroin + - herpes + - hiv + - homicide + - horney + - ike + - ikes + - ikey + - illegals + - incest + - intercourse + - interracial + - italiano + - jerries + - jerry + - jesus + - jesuschrist + - jihad + - kink + - kinky + - knockers + - kock + - kotex + - kraut + - ky + - lactate + - lapdance + - libido + - licker + - liquor + - lolita + - lsd + - lynch + - mafia + - marijuana + - meth + - mick + - molest + - molestation + - molester + - molestor + - murder + - narcotic + - nazi + - necro + - nigerian + - nigerians + - nipple + - nipplering + - nook + - nooner + - nude + - nuke + - nymph + - oral + - orgasm + - orgies + - orgy + - paddy + - paederastic + - paederasts + - paederasty + - pearlnecklace + - peck + - pecker + - pederastic + - pederasts + - pederasty + - pedophile + - pedophiles + - pedophilia + - pedophilic + - pee + - peepshow + - pendy + - penetration + - penile + - penis + - penises + - penthouse + - phonesex + - pistol + - pixie + - pixy + - playboy + - playgirl + - porn + - pornflick + - porno + - pornography + - prostitute + - protestant + - pube + - pubic + - pussy + - pussycat + - queer + - racist + - radical + - radicals + - randy + - rape + - raped + - raper + - rapist + - rectum + - ribbed + - satan + - scag + - scat + - screw + - scrotum + - scum + - semen + - septic + - septics + - sex + - sexhouse + - sextoy + - sextoys + - sexual + - sexually + - sexy + - shag + - shinola + - shit + - slaughter + - smack + - snatch + - sniggers + - sodom + - sodomite + - spade + - spank + - sperm + - stagg + - stiffy + - strapon + - stroking + - suck + - suicide + - swallow + - swastika + - syphilis + - tantra + - teat + - terrorist + - testicle + - testicles + - threesome + - tinkle + - tit + - tits + - tnt + - torture + - tramp + - trap + - trisexual + - trots + - turd + - uterus + - vagina + - vaginal + - vibrator + - vulva + - whit + - whites + - willy + - xtc + - xxx + - yankee + - yankees \ No newline at end of file diff --git a/.github/styles/alex/ProfanityUnlikely.yml b/.github/styles/alex/ProfanityUnlikely.yml new file mode 100644 index 0000000000..8e13052d38 --- /dev/null +++ b/.github/styles/alex/ProfanityUnlikely.yml @@ -0,0 +1,251 @@ +extends: existence +message: Be careful with '%s', it’s profane in some cases. +level: warning +ignorecase: true +tokens: + - adult + - africa + - african + - allah + - amateur + - american + - angie + - angry + - arab + - arabs + - aroused + - asian + - assassin + - assassinate + - assassination + - assault + - attack + - australian + - babies + - backdoor + - backseat + - banana + - bananas + - baptist + - bast + - beast + - beaver + - bi + - bigger + - bisexual + - blackout + - blind + - blow + - bomb + - bombers + - bombing + - bombs + - bomd + - boom + - bosch + - bra + - breast + - brownie + - brownies + - buffy + - burn + - butt + - canadian + - cancer + - catholic + - catholics + - cemetery + - childrens + - chin + - chinese + - christ + - christian + - church + - cigarette + - cigs + - cocktail + - coconut + - coconuts + - color + - colored + - coloured + - communist + - conservative + - conspiracy + - corruption + - crabs + - crash + - creamy + - criminal + - criminals + - dead + - death + - deposit + - desire + - destroy + - deth + - die + - died + - dies + - dirty + - disease + - diseases + - disturbed + - dive + - doom + - ecstacy + - enemy + - erect + - escort + - ethiopian + - ethnic + - european + - execute + - executed + - execution + - executioner + - explosion + - failed + - failure + - fairies + - fairy + - faith + - fat + - fear + - fight + - filipina + - filipino + - fire + - firing + - fore + - fraud + - funeral + - fungus + - gay + - german + - gin + - girls + - gun + - harder + - harem + - headlights + - hell + - henhouse + - heterosexual + - hijack + - hijacker + - hijacking + - hole + - honk + - hook + - horn + - hostage + - hummer + - hun + - huns + - husky + - hustler + - illegal + - israel + - israeli + - israels + - itch + - jade + - japanese + - jerry + - jew + - jewish + - joint + - jugs + - kid + - kill + - killed + - killer + - killing + - kills + - kimchi + - knife + - laid + - latin + - lesbian + - liberal + - lies + - lingerie + - lotion + - lucifer + - mad + - mexican + - mideast + - minority + - moles + - mormon + - muslim + - naked + - nasty + - niger + - niggardly + - oreo + - oreos + - osama + - palestinian + - panties + - penthouse + - period + - pot + - poverty + - premature + - primetime + - propaganda + - pros + - que + - rabbi + - racial + - redlight + - refugee + - reject + - remains + - republican + - roach + - robber + - rump + - servant + - shoot + - shooting + - showtime + - sick + - slant + - slav + - slime + - slope + - slopes + - snigger + - sniggered + - sniggering + - sniggers + - sniper + - snot + - sob + - sos + - soviet + - spa + - stroke + - sweetness + - taboo + - tampon + - terror + - toilet + - tongue + - transexual + - transsexual + - trojan + - uk + - urinary + - urinate + - urine + - vatican + - vietcong + - violence + - virgin + - weapon + - whiskey + - womens \ No newline at end of file diff --git a/.github/styles/alex/README.md b/.github/styles/alex/README.md new file mode 100644 index 0000000000..0185d0e35e --- /dev/null +++ b/.github/styles/alex/README.md @@ -0,0 +1,27 @@ +Based on [alex](https://github.com/get-alex/alex). + +> Catch insensitive, inconsiderate writing + +``` +(The MIT License) + +Copyright (c) 2015 Titus Wormer + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. +``` diff --git a/.github/styles/alex/Race.yml b/.github/styles/alex/Race.yml new file mode 100644 index 0000000000..9979c0b205 --- /dev/null +++ b/.github/styles/alex/Race.yml @@ -0,0 +1,87 @@ +--- +extends: substitution +message: Consider using '%s' instead of '%s'. +ignorecase: true +level: warning +action: + name: replace +swap: + Gipsy: Nomad|Traveler|Roma|Romani + Indian country: enemy territory + animal spirit: favorite|inspiration|personal interest|personality type + black list: blocklist|wronglist|banlist|deny list + blacklist: blocklist|wronglist|banlist|deny list + blacklisted: blocklisted|wronglisted|banlisted|deny-listed + blacklisting: blocklisting|wronglisting|banlisting|deny-listing + bugreport: bug report|snapshot + circle the wagons: defend + dream catcher: favorite|inspiration|personal interest|personality type + eskimo: Inuit + eskimos: Inuits + ghetto: projects|urban + goy: a person who is not Jewish|not Jewish + goyim: a person who is not Jewish|not Jewish + goyum: a person who is not Jewish|not Jewish + grandfather clause: legacy policy|legacy clause|deprecation policy + grandfather policy: legacy policy|legacy clause|deprecation policy + grandfathered: deprecated + grandfathering: deprecate + gyp: Nomad|Traveler|Roma|Romani + gyppo: Nomad|Traveler|Roma|Romani + gypsy: Nomad|Traveler|Roma|Romani + hymie: Jewish person + indian give: "go back on one\u2019s offer" + indian giver: "go back on one\u2019s offer" + japs: Japanese person|Japanese people + jump the reservation: disobey|endure|object to|oppose|resist + latina: Latinx + latino: Latinx + long time no hear: "I haven\u2019t seen you in a long time|it\u2019s been a long\ + \ time" + long time no see: "I haven\u2019t seen you in a long time|it\u2019s been a long\ + \ time" + master: primary|hub|reference + masters: primaries|hubs|references + mexican: Latinx + natives are becoming restless: dissatisfied|frustrated + natives are getting restless: dissatisfied|frustrated + natives are growing restless: dissatisfied|frustrated + natives are restless: dissatisfied|frustrated + non white: person of color|people of color + nonwhite: person of color|people of color + off reserve: disobey|endure|object to|oppose|resist + off the reservation: disobey|endure|object to|oppose|resist + on the warpath: defend + oriental: Asian person + orientals: Asian people + pinays: Filipinos|Filipino people + pinoys: Filipinos|Filipino people + pocahontas: Native American + pow wow: conference|gathering|meeting + powwow: conference|gathering|meeting + primitive: simple|indigenous|hunter-gatherer + red indian: Native American + red indians: Native American People + redskin: Native American + redskins: Native American People + sand niggers: Arabs|Middle Eastern People + savage: simple|indigenous|hunter-gatherer + shlomo: Jewish person + shyster: Jewish person + sophisticated culture: complex culture + sophisticated technology: complex technology + spade: a Black person + spirit animal: favorite|inspiration|personal interest|personality type + stone age: simple|indigenous|hunter-gatherer + too many chiefs: too many chefs in the kitchen|too many cooks spoil the broth + totem: favorite|inspiration|personal interest|personality type + towel heads: Arabs|Middle Eastern People + tribe: society|community + white list: passlist|alrightlist|safelist|allow list + white space: space|blank + white spaces: space|blank + whitelist: passlist|alrightlist|safelist|allow list + whitelisted: passlisted|alrightlisted|safelisted|allow-listed + whitelisting: passlisting|alrightlisting|safelisting|allow-listing + whitespace: space|blank + whitespaces: space|blank diff --git a/.github/styles/alex/Suicide.yml b/.github/styles/alex/Suicide.yml new file mode 100644 index 0000000000..3dfd3e33d2 --- /dev/null +++ b/.github/styles/alex/Suicide.yml @@ -0,0 +1,24 @@ +--- +extends: substitution +message: When referring to a person, consider using '%s' instead of '%s'. +ignorecase: true +level: warning +action: + name: replace +swap: + commit suicide: die by suicide + committed suicide: died by suicide + complete suicide: die by suicide + completed suicide: died by suicide + epidemic of suicides: rise in suicides + failed attempt: suicide attempt|attempted suicide + failed suicide: suicide attempt|attempted suicide + hang: the app froze|the app stopped responding|the app stopped responding to events|the + app became unresponsive + hanged: the app froze|the app stopped responding|the app stopped responding to events|the + app became unresponsive + successful suicide: die by suicide + suicide epidemic: rise in suicides + suicide failure: suicide attempt|attempted suicide + suicide note: a note from the deceased + suicide pact: rise in suicides diff --git a/.github/styles/alex/meta.json b/.github/styles/alex/meta.json new file mode 100644 index 0000000000..3db4c282ed --- /dev/null +++ b/.github/styles/alex/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/errata-ai/alex/releases.atom", + "vale_version": ">=1.0.0" +} \ No newline at end of file diff --git a/.github/workflows/vale_linting.yml b/.github/workflows/vale_linting.yml new file mode 100644 index 0000000000..38d94be2b4 --- /dev/null +++ b/.github/workflows/vale_linting.yml @@ -0,0 +1,20 @@ +name: Vale linting +on: + pull_request: + +jobs: + prose: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Vale + uses: errata-ai/vale-action@reviewdog + with: + version: 2.20.2 + files: docs/en + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/docs/en/modules/admin/assets/attachments/participatory_text.md b/docs/en/modules/admin/assets/attachments/participatory_text.md index 203ae0af39..1b3b5b9f98 100644 --- a/docs/en/modules/admin/assets/attachments/participatory_text.md +++ b/docs/en/modules/admin/assets/attachments/participatory_text.md @@ -3,8 +3,8 @@ Participatory texts relay on the parsing of Markdown texts to produce a structured document. Participatory texts are divided into 3 types of blocks: -- Section: produced by main headers (paragraphs starting with "# ") -- Subsection: produced by secondary headers (paragraphs starting more than one "#") until 6 levels. +- Section: produced by main headers (paragraphs starting with '# ') +- Subsection: produced by secondary headers (paragraphs starting more than one '#') until 6 levels. - Article: produced by paragraphs and lists. ## Subsection title 1.1 diff --git a/docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amendmed.png b/docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amended.png similarity index 100% rename from docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amendmed.png rename to docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amended.png diff --git a/docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amendmed_accepted.png b/docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amended_accepted.png similarity index 100% rename from docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amendmed_accepted.png rename to docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amended_accepted.png diff --git a/docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amendmed_amendment_list.png b/docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amended_amendment_list.png similarity index 100% rename from docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amendmed_amendment_list.png rename to docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amended_amendment_list.png diff --git a/docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amendmed_final.png b/docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amended_final.png similarity index 100% rename from docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amendmed_final.png rename to docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amended_final.png diff --git a/docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amendmed_notification.png b/docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amended_notification.png similarity index 100% rename from docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amendmed_notification.png rename to docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amended_notification.png diff --git a/docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amendmed_review.png b/docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amended_review.png similarity index 100% rename from docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amendmed_review.png rename to docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amended_review.png diff --git a/docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amendmed_to_review.png b/docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amended_to_review.png similarity index 100% rename from docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amendmed_to_review.png rename to docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amended_to_review.png diff --git a/docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amendmed_versions.png b/docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amended_versions.png similarity index 100% rename from docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amendmed_versions.png rename to docs/en/modules/admin/assets/images/components/proposals/amendments/proposal_amended_versions.png diff --git a/docs/en/modules/admin/assets/images/features/comments/nested_levels.png b/docs/en/modules/admin/assets/images/features/comments/nested_levels.png new file mode 100644 index 0000000000..45c3bd75c5 Binary files /dev/null and b/docs/en/modules/admin/assets/images/features/comments/nested_levels.png differ diff --git a/docs/en/modules/admin/pages/components/accountability.adoc b/docs/en/modules/admin/pages/components/accountability.adoc index a213fb8985..16dd317e1c 100644 --- a/docs/en/modules/admin/pages/components/accountability.adoc +++ b/docs/en/modules/admin/pages/components/accountability.adoc @@ -2,9 +2,9 @@ The Accountability component allows people to follow project implementations. It works like a project management system built into the platform. It offers the following features: -* creating results that represent projects to be implemented +* creating results that represent projects in the process of implementation * subdividing results into projects or sub-projects -* defining and applying progress in implementation statuses (0% to 100% implemented) around their implementation -* displaying the extent of the results’ implementation grouped by categories and scopes +* defining and applying progress in implementation statuses - 0% to 100% implemented - around their implementation +* displaying the extent of the results' implementation grouped by categories and scopes -Results, projects and statuses can be updated through a CSV (comma-separated values), or manually by the administration interface. +You can update results, projects, and statuses through a CSV upload (comma-separated values), or manually by the administration interface. \ No newline at end of file diff --git a/docs/en/modules/admin/pages/components/blog.adoc b/docs/en/modules/admin/pages/components/blog.adoc index 3a49f6c37f..f6f291f180 100644 --- a/docs/en/modules/admin/pages/components/blog.adoc +++ b/docs/en/modules/admin/pages/components/blog.adoc @@ -2,22 +2,22 @@ The Blog component allows people to read multiple posts ordered by date. -Some examples of where this component was used: +Some examples of this component in use: -* https://meta.decidim.org/processes/roadmap/f/247/[News in Propose new functionalities for Decidim software] in https://meta.decidim.org[Metadecidim] +* https://meta.decidim.org/processes/news?participatory_process_slug=news[News from the Decidim project] in https://meta.decidim.org[Metadecidim] image:components/blog/example01.png[Example of blog posts list] image:components/blog/example02.png[Example of a blog post] To configure the Blog component: -. Sign in as admin -. Go to admin panel +. Sign in as an administrator +. Go to the administrator panel . In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies" or "Conferences". +For instance, it could be 'Processes', 'Assemblies' or 'Conferences'. . Go to components -. Click on "Add component" button -. Click on "Blog" +. Click on 'Add component' button +. Click on 'Blog' . Fill the xref:_add_component[Add component] form == Add component @@ -30,12 +30,12 @@ image:components/blog/component.png[Add component form] |Name |Required -|What is the title of this component. For instance, "Blogs" +|What is the title of this component. For instance, 'Blogs' |Order position |Optional -|Which order will it have in relation to the other blogs. Having a lower number means a higher priority. -For instance, if you have two blogs, "Blog a" with weight "10" and "Blog b" with weight "0", then "Blog b" will be first when ordering. +|Which order the post has in relation to the other blogs. Having a lower number means a higher priority. +For instance, if you have two blogs, 'Blog A' with weight '10' and 'Blog B' with weight '0', then 'Blog B' is first when ordering. |=== @@ -45,7 +45,7 @@ For instance, if you have two blogs, "Blog a" with weight "10" and "Blog b" with |Announcement |Optional -|A general announcement that'll be visible on the general blogs landing page. +|A general announcement that is visible on the general blogs landing page. |Comments enabled |Optional @@ -53,11 +53,11 @@ For instance, if you have two blogs, "Blog a" with weight "10" and "Blog b" with |Comments max length |Optional -|What is the characters limit that participants will have when making comments. Leave 0 for default value. +|What is the characters limit that participants have when making comments. Leave 0 for default value. |=== -In the cases where the space that this component will be used has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in +In the cases where the space using this component has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in xref:admin:spaces/processes.adoc[Participatory Processes], then you can also define different behaviors per Step. .Add component: Blogs form - Step settings @@ -66,7 +66,7 @@ xref:admin:spaces/processes.adoc[Participatory Processes], then you can also def |Announcement |Optional -|A general announcement that'll be visible on the general blog landing page. +|A general announcement that is visible on the general blog landing page. |Comments blocked |Optional @@ -78,7 +78,7 @@ xref:admin:spaces/processes.adoc[Participatory Processes], then you can also def |Endorsements blocked |Optional -|Whether you want to disable adding new endorsements for this phase. +|Whether you want to turn off adding new endorsements for this phase. |=== @@ -104,7 +104,7 @@ image:components/blog/new_post.png[New post form] |Create post as |Required -|Participant account or user group that will be the author of the post. +|Participant account or user group that is the author of the post. |Title |Required @@ -124,7 +124,7 @@ image:components/blog/new_post.png[New post form] |image:action_edit.png[Edit icon] |Edit -|Edit form for this post. It's the same form as "New post". +|Edit form for this post. It is the same form as 'New post'. |image:action_folder.png[Folder icon] |Folder @@ -132,7 +132,7 @@ image:components/blog/new_post.png[New post form] |image:action_attachments.png[Attachments icon] |Attachments -|Documents that are related to the post. +|Documents related to the post. |image:action_permissions.png[Permissions icon] |Permissions diff --git a/docs/en/modules/admin/pages/components/budgets.adoc b/docs/en/modules/admin/pages/components/budgets.adoc index 69452393eb..b8a95008a0 100644 --- a/docs/en/modules/admin/pages/components/budgets.adoc +++ b/docs/en/modules/admin/pages/components/budgets.adoc @@ -1,42 +1,42 @@ = Budgets :page-toclevels: 4 -The Budgets component allows people to vote by selecting projects of their choosing. Depending on the needs and normative -of the organization, this could be configured so people have assigned a total budget (for instance, 100.000 EUR) and then -every project has assigned a value (for instance, 10.000 EUR). Then when people vote on projects, they have a progress bar +The Budgets component allows people to vote by selecting projects of their choosing. Depending on the needs and regulations +of the organization, you can configure this so people have assigned a total budget - for instance, 100,000 Euros - and then +every project has assigned a value - for instance, 10,000 Euros. Then when people vote on projects, they have a progress bar where they see how much remaining budget they have to allocate in this voting. From this starting point, there could be other configurations, such as: -* A minimum percentage of budget to be allocated -* A minimum number of projects to be allocated -* Multiple budgets, one for each district or neighborhood +* A minimum percentage of budget allocation available +* A minimum number of projects to allocate funds between +* Multiple budgets, for example one for each district or neighborhood -Some examples of where this component was used: +Some examples of this component in use: * https://www.decidim.barcelona/processes/PressupostosParticipatius[2020/2021 Participatory Budgeting Process in Decidim Barcelona]. -The city of Barcelona (Spain) has allocated a budget of 30.000.000 EUR so people can present, define, prioritize, vote -and choose which investment projects the city goverment should execute. -* https://ecrivons.angers.fr/processes/BP2021[2021 Participatory Budgeting Process in Angers]. The city of Angers (France) has allocated -a budget of 1.000.000 EUR so people from 11 years can propose maximum of 3 ideas and then vote for their 5 favorite projects. -* https://omastadi.hel.fi/[2021 Participatory Budgeting Process in Helsinki]. Helsinki has allocated 8.8 million euros to realising -residents’ wishes. The ideas are developed together into proposals that Helsinki residents can vote on. The proposals with the -most votes are realised by the City. +The city of Barcelona, Spain has allocated a budget of 30,000,000 Euros so people can present, define, prioritize, vote +and choose which investment projects the city government should deliver. +* https://ecrivons.angers.fr/processes/BP2021[2021 Participatory Budgeting Process in Angers]. The city of Angers, France has allocated +a budget of 1,000,000 Euros so people from 11 years can propose maximum of 3 ideas and then vote for their 5 favorite projects. +* https://omastadi.hel.fi/[2021 Participatory Budgeting Process in Helsinki]. Helsinki has allocated 8.8 million Euros to realising +residents' wishes. Proposals, developed together from the ideas, are available for Helsinki residents to vote on. The City implements proposals with the +most votes. image:components/budgets/example01.png[Budgets example voting] -image:components/budgets/example02.png[Budgets example error messagge when exceding the amount of budget] +image:components/budgets/example02.png[Budgets example error message when exceeding the amount of budget] image:components/budgets/example03.png[Budgets vote confirmation] image:components/budgets/example04.png[Budgets after voting] -To configure the Budgets component: +To configure the Budgets component: -. Sign in as admin -. Go to admin panel +. Sign in as an administrator +. Go to the administrator panel . In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies" or "Conferences". +For instance, it could be 'Processes', 'Assemblies' or 'Conferences'. . Go to components -. Click on "Add component" button -. Click on "Budgets" +. Click on 'Add component' button +. Click on 'Budgets' . Fill the xref:_add_component[Add component] form == Add component @@ -49,12 +49,12 @@ image:components/budgets/component.png[Add component form] |Name |Required -|What is the title of this component. For instance, "Budgets" +|What is the title of this component. For instance, 'Budgets' |Order position |Optional -|Which order will it have in relation to the other budgets. Having a lower number means a higher priority. -For instance, if you have two budgets, "Budget a" with weight "10" and "Budget b" with weight "0", then "Budget b" will be first when ordering. +|Which order the item has in relation to the other budgets. Having a lower number means a higher priority. +For instance, if you have two budgets, 'Budget a' with weight '10' and 'Budget b' with weight '0', then 'Budget b' displays first when ordering. |=== @@ -64,7 +64,7 @@ For instance, if you have two budgets, "Budget a" with weight "10" and "Budget b |Scopes enabled |Optional -|Check if you want to have Scopes filtering in this component. +|Select if you want to have Scopes filtering in this component. |Scope |Optional @@ -76,24 +76,30 @@ For instance, if you have two budgets, "Budget a" with weight "10" and "Budget b |xref:_workflows[Workflow] |Required -|How the participants can vote if there are multiple budget sets. You can define your own xref:_workflows[Workflow] or use one of the availables. +|How the participants can vote if there are multiple budget sets. You can define your own xref:_workflows[Workflow] or use one of the available workflows. |Projects per page |Required -|How many projects are displayed per page. +|How many projects show per page. + +pass:[] + +// There are some grammatical issues here in the core strings, so we turn off the vale alerts here until they are fixed. |Enable rule: Minimum budget percentage -|Optional, but incompatible with "Minimum number of projects to be voted on" and "Selected projects with minimum and maximum number of projects to be voted on" -|Allows to define a "Vote threshold percent", a percent of the total budget that participants must reach to be able to vote. +|Optional, but incompatible with 'Minimum number of projects to be voted on' and 'Selected projects with minimum and maximum number of projects to be voted on' +|Allows you to define a 'Vote threshold percent', a percent of the total budget that participants must reach to be able to vote. |Enable rule: Minimum number of projects to be voted on -|Optional, but incompatible with "Minimum budget percentage" and "Selected projects with minimum and maximum number of projects to be voted on" -|Allows to define a "Minimum number of projects to vote", a number of projects that participants must reach to be able to vote. +|Optional, but incompatible with 'Minimum budget percentage' and 'Selected projects with minimum and maximum number of projects to be voted on' +|Allows you to define a 'Minimum number of projects to vote', a number of projects that participants must vote on for their votes to count. |Enable rule: Selected projects with minimum and maximum number of projects to be voted on -|Optional, but incompatible with "Minimum budget percentage" and "Minimum number of projects to be voted on" -|Allows to define a "Minimum amount of projects to be selected" and a "Maximum amount of projects to be selected", the number of projects -that participants will need to vote as a minimum and maximum. +|Optional, but incompatible with 'Minimum budget percentage' and 'Minimum number of projects to be voted on' +|Allows you to define a 'Minimum amount of projects to select' and a 'Maximum amount of projects to select', the number of projects +that participants needs to vote as a minimum and maximum. + +pass:[] |Comments enabled |Optional @@ -101,11 +107,17 @@ that participants will need to vote as a minimum and maximum. |Comments max length |Optional -|What is the characters limit that participants will have when making comments. Leave 0 for default value. +|What is the character limit that participants have when making comments. Leave 0 for default value. + +pass:[] + +// There are some grammatical issues here in the core strings, so we turn off the vale alerts here until they are fixed. |Actions permissions can be set for each project |Optional -|Whether you want to be able to set permissions for every one of the projects. Most of the time you will want to leave this option disabled. +|Whether you want to be able to set permissions for every one of the projects. Most of the time you want to leave this option turned off. + +pass:[] |Announcement |Optional @@ -113,15 +125,15 @@ that participants will need to vote as a minimum and maximum. |Budgets landing page |Optional -|What message will be shown in the Budgets landing page when there are multiple budgets. +|What message displays in the Budgets landing page when there are multiple budgets. |More information modal |Optional -|What message will be shown when clicking on the "More information" link. +|What message displays when clicking on the 'More information' link. |=== -In the cases where the space that this component will be used has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in +In the cases where the space that uses this component has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in xref:admin:spaces/processes.adoc[Participatory Processes], then you can also define different behaviors per Step. .Add component: Budgets form - Step settings @@ -132,25 +144,33 @@ xref:admin:spaces/processes.adoc[Participatory Processes], then you can also def |Optional |Whether you want to enable comments for this phase. +pass:[] +pass:[] + +// There are some grammatical issues here in the core strings, so we turn off the vale alerts here until they are fixed. + |Voting |Required |Choose one of the following options depending in the moment of the process: Voting disabled, Voting enabled or Voting finished. +pass:[] +pass:[] + |Show votes |Optional -|Wheter the votes will be shown. We strongly recommend that you only check this option after the voting is finished. +|Whether to show the votes. It is strongly recommend that you only select this option after finishing the voting. |Announcement |Optional -|A general announcement that'll be visible on the general budgets landing page. +|A general announcement visible on the general budgets landing page. |Budgets landing page |Optional -|What message will be shown in the Budgets landing page when there are multiple budgets. +|Message displayed in the Budgets landing page when there are multiple budgets. |More information modal |Optional -|What message will be shown when clicking on the "More information" link. +|Message displayed when clicking on the 'More information' link. |=== @@ -165,32 +185,32 @@ Edit permissions One neat feature of the Budgets component is the ability to define your own workflows. -This means that you can define multiple Budgets, for instance one for every Neighberhood or District that a City has, and -you can also define multiple rullings regarding how people can vote on those Budgets. By default you have these workflows: +This means that you can define multiple Budgets, for instance one for every Neighbourhood or District that a City has, and +you can also define multiple rulings regarding how people can vote on those Budgets. By default you have these workflows: * Vote in one: allows participants to vote in any budget, but only in one. * Vote in all: allows participants to vote in all budgets. * Vote in a random component: allows participants to vote only in one budget, selected randomly. -But this can be extended in your application by a developer, by making your own Workflows. For instance for the +But you can extend this in your app by a developer making your own Workflows. For instance for the https://www.decidim.barcelona/processes/PressupostosParticipatius[2020/2021 Participatory Budgeting Process in Decidim Barcelona], -the people could vote in two districts: the one where they lived and one of their choosing. This was defined in the -https://github.com/AjuntamentdeBarcelona/decidim-barcelona/blob/743be2a210e8745d2dc443166642b285aed2b356/lib/budgets_workflow_pam2021.rb[decidim-barcelona application itself]. +the people could vote in two districts: the one where they lived and one of their choosing. You can review the workflow in the +https://github.com/AjuntamentdeBarcelona/decidim-barcelona/blob/743be2a210e8745d2dc443166642b285aed2b356/lib/budgets_workflow_pam2021.rb[Decidim-barcelona app itself]. -You can read more about Worfklows in https://github.com/decidim/decidim/blob/1ab5cd8fdabef48f5be94ff9c30c6bb3bc9a2f8f/decidim-budgets/README.md#budget-workflows[decidim-budgets README.md]. +You can read more about Workflows in the https://github.com/decidim/decidim/blob/1ab5cd8fdabef48f5be94ff9c30c6bb3bc9a2f8f/decidim-budgets/README.md#budget-workflows[Decidim-budgets README.md]. -NOTE: You only want to have a voting without much complications? Like a city-wide vote? Don't worry: if you define only one -Budget, then people will go there directly when click in the Budgets section. +NOTE: Only want to have a basic voting process without much complication, like a city-wide vote? Do not worry: if you define only one +Budget, then people go there directly when they click in the Budgets section. == Manage budgets image:components/budgets/manage_budgets.png[Manage budgets table] -This window also lets you see the votes that the various projects have received. (Number of votes) and the total number of votes (*Finished votes* and *Pending votes*, that is, that a participant has started voting but has still not cast their vote). +This window also lets you see the votes that the various projects have received - Number of votes - and the total number of votes - *Finished votes* and *Pending votes* - that is, that a participant has started voting but has still not cast their vote. === Export all -Allows to export the projects for this budget in different formats. +Allows you to export the projects for this budget in different formats. * Projects as CSV * Projects as JSON @@ -206,12 +226,12 @@ image:components/budgets/new_budget.png[New budget form] |Title |Required -|What is the title of this budget. For instance, "District A" +|What is the title of this budget. For instance, 'District A' |Order position |Optional -|Which order will it have in relation to the other budgets. Having a lower number means a higher priority. -For instance, if you have two budgets, "Budget a" with weight "10" and "Budget b" with weight "0", then "Budget b" will be first when ordering. +|Which order does this have in relation to the other budgets. Having a lower number means a higher priority. +For instance, if you have two budgets, 'Budget A' with weight '10' and 'Budget B' with weight '0', then 'Budget B' displays first when ordering. |Description |Optional @@ -219,7 +239,7 @@ For instance, if you have two budgets, "Budget a" with weight "10" and "Budget b |Total budget |Required -|What is the total amount of money that people will have for assigning. +|What is the total amount of money that people have for assigning. |=== @@ -231,7 +251,7 @@ For instance, if you have two budgets, "Budget a" with weight "10" and "Budget b |image:action_preview.png[Preview icon] |Preview -|To see how it's shown in the frontend to participants. +|To see how it is shown in the frontend to participants. |image:action_list.png[Manage projects icon] |xref:_manage_projects[Manage projects] @@ -239,11 +259,11 @@ For instance, if you have two budgets, "Budget a" with weight "10" and "Budget b |image:action_edit.png[Edit icon] |Edit -|Edit form for a budget. It's the same form as "New budget". +|Edit form for a budget. It is the same form as 'New budget'. |image:action_delete.png[Delete icon] |Delete -|To delete this budget. Only can be done when there aren't any projects. +|To delete this budget. You can only delete a budget when there are not any Projects. |=== @@ -251,26 +271,26 @@ For instance, if you have two budgets, "Budget a" with weight "10" and "Budget b ===== Import proposals to projects -Depending in the normative, you could want to have a first phase where participants -make proposals, and those proposals are selected (by voting or by technical review), -then you can import those proposals and convert them to projects. +Depending in the regulations, you could want to have a first phase where participants +make proposals, and then a selection process - by voting or by technical review - +following which you can import those proposals and convert them to projects. For this to work: -. The following settings in the proposals component need to be enabled: +. You need to turn on the following settings in the proposals component: .. Proposal answering enabled .. Enable costs on proposal answers . A valuator or administrator need to Answer proposals: .. Review the proposals -.. Accept or reject them according to your normative -.. Add costs to the proposals if were accepted -. An administrator can Import proposals to projects +.. Accept or decline them according to your regulations +.. Add costs to the proposals if accepted +. An administrator can import proposals to projects image:components/budgets/import_proposals.png[Import proposals to projects] ===== Export all -Allows to export the projects for this budget in different formats. +Allows you to export the projects for this budget in different formats. * Projects as CSV * Projects as JSON @@ -294,19 +314,19 @@ image:components/budgets/new_project.png[New project form for a Budget] |Budget amount |Required -|What's the budget amount for this project. How much money will it cost to implement this project? +|What is the budget amount for this project. What is the cost to implement this project? |Category |Optional -|Which Category has the project. Used for filtering in the budgets list. +|Which Category relates to the project. Used for filtering in the budgets list. |Proposals |Optional -|Choose related proposals for this project. Automatic assingned when importing proposals. +|Choose related proposals for this project. Automatically assigned when importing proposals. |Add an image gallery |Optional -|Add multiple images illustrating what this project is about, or where it will be implemented. +|Add multiple images illustrating what this project is about, or other relevant images. |=== @@ -318,11 +338,11 @@ image:components/budgets/new_project.png[New project form for a Budget] |image:action_preview.png[Preview icon] |Preview -|To see how it's shown in the frontend to participants. +|To see how it displays in the frontend to participants. |image:action_edit.png[Edit icon] |Edit -|Edit form for a project. It's the same form as "New project". +|Edit form for a project. It is the same form as 'New project'. |image:action_folder.png[Folders icon] |Folders @@ -330,7 +350,7 @@ image:components/budgets/new_project.png[New project form for a Budget] |image:action_attachments.png[Attachments icon] |Attachments -|Documents that are related to the project. +|Documents related to the project. |image:action_delete.png[Delete icon] |Delete @@ -342,15 +362,15 @@ image:components/budgets/new_project.png[New project form for a Budget] After the voting step has finished, then an administrator need to: -. Change the Voting configuration for the Budget component to "Voting finished" +. Change the Voting configuration for the Budget component to 'Voting finished' . Go to the Budgets and view the results -. On the projects that according to the normative have been selected, she'll need to go to each project, edit it and -then check the "Selected for implementation". +. On the projects that - according to the regulations - are selected, she'll need to go to each project, edit it and +then select 'Selected for implementation'. image:components/budgets/results_unselected.png[Unselected projects after voting] image:components/budgets/results_select_project.png[Select a project for implementation] image:components/budgets/results_selected.png[Selected projects after voting] image:components/budgets/results_selected_frontend.png[Selected projects after voting in the frontend] -We strongly recommend that after you have selected projects then you enable the xref:components/accountability.adoc[Accountability] -component so participants can see the grade of impementation. +It is strongly recommend that after you have selected projects, you then enable the xref:components/accountability.adoc[Accountability] +component so participants can see the status of implementation. diff --git a/docs/en/modules/admin/pages/components/debates.adoc b/docs/en/modules/admin/pages/components/debates.adoc index 30e50db73b..ab969e9203 100644 --- a/docs/en/modules/admin/pages/components/debates.adoc +++ b/docs/en/modules/admin/pages/components/debates.adoc @@ -1,15 +1,15 @@ = Debate -The Debate component allows people to have discussions, without voting nor prioritzation. It also allows to close them, -by adding conclusions or a summary of what the discussion was about. +The Debate component allows people to have discussions, without voting nor prioritization. It also allows to close them +by adding conclusions, or a summary of what the discussion was about. From this starting point, there could be other configurations, such as: * To allow debates creation by participants * To have debates with a fixed started and ending date or open -* To show endorsements (public supports) or not +* To show endorsements - public supports - or not -Some examples of where this component was used: +Some examples of this component in use: * https://meta.decidim.org/processes/roadmap/f/219/[Propose new functionalities for Decidim software in Metadecidim] @@ -18,13 +18,13 @@ image:components/debates/example02.png[Debate example] To configure the Debate component: -. Sign in as admin -. Go to admin panel +. Sign in as an administrator +. Go to the administrator panel . In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies" or "Conferences". +For instance, it could be 'Processes', 'Assemblies' or 'Conferences'. . Go to components -. Click on "Add component" button -. Click on "Debate" +. Click on 'Add component' button +. Click on 'Debate' . Fill the xref:_add_component[Add component] form == Add component @@ -37,12 +37,12 @@ image:components/debates/component.png[Add component form] |Name |Required -|What is the title of this component. For instance, "Debates" +|What is the title of this component. For instance, 'Debates' |Order position |Optional -|Which order will it have in relation to the other debates. Having a lower number means a higher priority. -For instance, if you have two debates, "Debate a" with weight "10" and "Debate b" with weight "0", then "Debate b" will be first when ordering. +|Which order it has in relation to the other debates. Having a lower number means a higher priority. +For instance, if you have two debates, 'Debate A' with weight '10' and 'Debate B' with weight '0', then 'Debate b' displays first when ordering. |=== @@ -52,7 +52,7 @@ For instance, if you have two debates, "Debate a" with weight "10" and "Debate b |Scopes enabled |Optional -|Check if you want to have Scopes filtering in this component. +|Select if you want to have Scopes filtering in this component. |Scope |Optional @@ -68,15 +68,15 @@ For instance, if you have two debates, "Debate a" with weight "10" and "Debate b |Comments max length |Optional -|What is the characters limit that participants will have when making comments. Leave 0 for default value. +|What is the character limit that participants have when making comments. Leave 0 for default value. |Announcement |Optional -|A general announcement that'll be visible on the general debates landing page. +|A general announcement that is visible on the general debates landing page. |=== -In the cases where the space that this component will be used has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in +In the cases where the space using this component has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in xref:admin:spaces/processes.adoc[Participatory Processes], then you can also define different behaviors per Step. .Add component: Debates form - Step settings @@ -85,7 +85,7 @@ xref:admin:spaces/processes.adoc[Participatory Processes], then you can also def |Endorsements enabled |Optional -|Check if you want that participants show public support for these debates. +|Select if you want that participants show public support for these debates. |Endorsements blocked |Optional @@ -93,7 +93,7 @@ xref:admin:spaces/processes.adoc[Participatory Processes], then you can also def |Debate creation by participants enabled |Optional -|Check if you want to allow the creation of new debates by participants. +|Select if you want to allow the creation of new debates by participants. |Comments blocked |Optional @@ -101,13 +101,13 @@ xref:admin:spaces/processes.adoc[Participatory Processes], then you can also def |Announcement |Optional -|A general announcement that'll be visible on the general debate landing page. +|A general announcement that is visible on the general debate landing page. |=== == Permissions -An administrator can choose which kind of xref:customize:authorizations.adoc[Authorizations] a participant need to have to make +An administrator can choose which kind of xref:customize:authorizations.adoc[Authorizations] a participant needs to have to take certain actions in the debates: * Create @@ -135,7 +135,7 @@ image:components/debates/new_debate_backend.png[New debate backend form] |Title |Required -|What is the title of this debate. For instance, "How can we improve this process?" +|What is the title of this debate. For instance, 'How to improve this process?' |Description |Required @@ -152,7 +152,7 @@ image:components/debates/new_debate_backend.png[New debate backend form] |xref:_debate_types[Debate type] |Required |Choose between Finite and Open. Finite means that the debate has a starting and ending date and time, Open means that -there isn't any timeframe. +there is not any time frame. |Starts at |Required if the debate type is Finite @@ -164,18 +164,18 @@ there isn't any timeframe. |Category |Optional -|Which category has the debate. Used for filtering in the debates list. +|Which category relates to the debate. Used for filtering in the debates list. |=== ==== Debate types -It's possible to have two kinds of debates: +It is possible to have two kinds of debates: . Finite: with a start and end date . Open: without a start and end date -This is shown publically in the debate list. +This displays publicly in the debate list. image:components/debates/debates_list.png[Debates list] image:components/debates/debate_finite.png[Finite debate] @@ -188,7 +188,7 @@ image:components/debates/debate_finite.png[Finite debate] |image:action_edit.png[Edit icon] |Edit -|Edit form for a debate. It's the same form as "New debate". +|Edit form for a debate. It is the same form as 'New debate'. |image:action_close.png[Close icon] |Close @@ -200,18 +200,17 @@ image:components/debates/debate_finite.png[Finite debate] |image:action_delete.png[Delete icon] |Delete -|To delete this debate. Only can be done when there aren't any projects. +|To delete this debate. You can only delete a debate if there are not yet any projects. |=== === Close debate form -A debate can be closed. This is useful for adding conclusions. After a debate was closed it can't be edited nor commented any more +You can close a debate. This is useful for adding conclusions. After closing a debate, you cannot edit or comment any more. image:components/debates/close_debate_backend.png[Close debate backend form] -Take in account that if the debate was created by a participant then only that -participant can close it. +Take in account that only the participant creating the debate can close it. image:components/debates/close_debate_frontend.png[Close debate frontend form] @@ -225,6 +224,6 @@ image:components/debates/close_debate_frontend.png[Close debate frontend form] |=== -The conclusions are shown publicly with the close date and time. +The conclusions display publicly with the close date and time. image:components/debates/debate_closed.png[Closed debate] diff --git a/docs/en/modules/admin/pages/components/meetings.adoc b/docs/en/modules/admin/pages/components/meetings.adoc index 478753092b..c08237d25b 100644 --- a/docs/en/modules/admin/pages/components/meetings.adoc +++ b/docs/en/modules/admin/pages/components/meetings.adoc @@ -1,14 +1,20 @@ = Meetings Meetings are where people come together to discuss or inform about a given topic. All the meetings have a given location -(where the meeting will happen) and start and end date and time (when the meeting will happen). +- where the meeting happens - and start and end date and time - when the meeting happens. -Some examples of where this component was used are: +Some examples of this component in use include: + +pass:[] + +// The non-English text here throws a spelling error, so turning off Vale for this section. * https://www.decidim.barcelona/processes/PAM2020/f/3734/[Procés participatiu del Programa d'Actuació Municipal (PAM) 2020-2023] in https://www.decidim.barcelona/[Decidim Barcelona] * https://lejourdapres.parlement-ouvert.fr/processes/ateliers/f/14/[Les ateliers] in https://lejourdapres.parlement-ouvert.fr/[Le jour d'après] +pass:[] + image:components/meetings/example01.png[Meetings list in Decidim Barcelona] image:components/meetings/example02.png[Example meeting detail 01 in Decidim Barcelona] image:components/meetings/example03.png[Example meeting detail 02 in Decidim Barcelona] @@ -19,27 +25,27 @@ image:components/meetings/example04.png[Meetings list in Le jour d'après] Regarding the *location*, depending on the configuration of the component, you can have: * In-person meetings: where you get together in a given location -* Online meetings: where you get together using an external service (for instance Jitsi Meet) +* Online meetings: where you get together using an external service -for instance Jitsi Meet -Depending in the *author* (who's the person that's making the call): +Depending on the *author* - the person that is creating the call: -* Official meetings: meetings created by the organization (created by an administrator through the panel) -* Citizens meetings: meetings created by a User participant (a User or an UserGroup). +* Official meetings: meetings created by the organization - created by an administrator through the administrator panel, +* Citizens meetings: meetings created by a User participant - a User or an UserGroup. == Add the component image:components/meetings/component.png[Add a meetings component] -For adding the component, you need to: +To add the component, you need to: -. Sign in as admin -. Go to admin panel +. Sign in as an administrator +. Go to the administrator panel . In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" +For instance, it could be 'Processes', 'Assemblies', or 'Conferences' . Go to components -. Click on "Add component" button -. Click on "Meetings" -. Fill the xref:_add_component[Add component] form +. Click on 'Add component' button +. Click on 'Meetings' +. Fill in the xref:_add_component[Add component] form == Add component @@ -55,8 +61,8 @@ For configuring the meeting component you have these settings: |Order position |Optional -|Which order will it have in relation with the other components. Having a lower number means a higher priority. For instance, -if you have two components, "Proposals" with weight "10" and "Meetiings" with weight "0", then "Meetings" will be first when ordering. +|Which order it has in relation with the other components. Having a lower number means a higher priority. For instance, +if you have two components, 'Proposals' with weight '10' and 'Meetings' with weight '0', then 'Meetings' displays first when ordering. |=== @@ -66,19 +72,19 @@ if you have two components, "Proposals" with weight "10" and "Meetiings" with we |Scopes enabled |Optional -|Check if you want to have Scopes filtering in this process. +|Select if you want to have Scopes filtering in this process. |Scope |Optional -|Which scope will be used for this component. +|The relevant scope for this component. |Announcement |Optional -|A general announcement that'll be visible in the general meetings list. +|A general announcement that is visible in the general meetings list. |Default registration terms |Optional -|What'll be the registration terms of service that the participant would need to accept when registering. +|What are the registration terms of service that the participant would need to accept when registering. |Comments enabled |Optional @@ -86,19 +92,25 @@ if you have two components, "Proposals" with weight "10" and "Meetiings" with we |Comments max length |Optional -|What is the characters limit that participants will have when making comments. Leave 0 for default value. +|What is the character limit that participants have when making comments. Leave 0 for default value. |Registration code enabled |Optional -|Check if you want to give registration codes to participants. Learn more in xref:components/meetings/registrations.adoc[Registrations]. +|Select if you want to give registration codes to participants. Learn more in xref:components/meetings/registrations.adoc[Registrations]. + +pass:[] + +// There are some grammatical issues here in the core strings, so we turn off the vale alerts here until they are fixed. |Actions permissions can be set for each meeting |Optional |If you want more granular permissions inside of every one of the Meetings. +pass:[] + |Enable pads creation |Optional -|If you want an Etherpad embedded in your meetings. Must have the xref:services:etherpad.adoc[Etherpad] integration configurated. +|If you want an Etherpad embedded in your meetings. Must have the xref:services:etherpad.adoc[Etherpad] integration configured. |Participants can create meetings |Optional @@ -106,7 +118,7 @@ if you have two components, "Proposals" with weight "10" and "Meetiings" with we |Maps enabled |Optional -|Wheter you want to show a map in the meetings in the meeting detail. +|Whether you want to show a map in the meeting detail. |=== @@ -116,7 +128,7 @@ if you have two components, "Proposals" with weight "10" and "Meetiings" with we |Announcement |Optional -|A general announcement that'll be visible in the general meetings list. +|A general announcement that is visible in the general meetings list. |Comments enabled |Optional @@ -128,12 +140,12 @@ if you have two components, "Proposals" with weight "10" and "Meetiings" with we === Citizens meetings -Meetings can be created by participants if the setting is "Participants can create meetings" is checked. +Participants can create meetings if you have turned on the setting is 'Participants can create meetings'. If a participant belongs to a xref:admin:participants/groups.adoc[user group], then she'll be able to create meetings as that group also. -image:components/meetings/new_meeting_form_frontend01.png[Create a new meeting form (frontend)] -image:components/meetings/new_meeting_form_frontend02.png[Create a new meeting form (frontend)] +image:components/meetings/new_meeting_form_frontend01.png[Create a new meeting form - frontend] +image:components/meetings/new_meeting_form_frontend02.png[Create a new meeting form - frontend] .Create meeting - Frontend form |=== @@ -145,63 +157,71 @@ image:components/meetings/new_meeting_form_frontend02.png[Create a new meeting f |Description |Required -|A description of what will be discussed in this meeting, like the topics. +|A description of the discussions topics for this meeting. |Type |Required -|Choose one option between "In person", "Online" or "Booth" +|Choose one option between 'In person', 'Online' or 'Hybrid'. |Address -|Required if meeting type is "In person" or "Booth" -|Address: used by Geocoder to find the location +|Required if meeting type is 'In person' or 'Hybrid' +|Address: used by Geo-coder to find the location. |Location |Required -|Location: message directed to the users implying the spot to meet at +|Location: message directed to the users implying the spot to meet at. |Location hints |Optional -|Location hints: additional info. Example: the floor of the building +|Location hints: additional info. Example: the floor of the building. |Online meeting URL |Optional -|Which URL will the meeting be held. +|The URL to access the meeting. |Show embedded iframe for this URL |Optional -|Whether or not embed the iframe for this videoconference URL. Only a few services allow embedding (i.e. YouTube, Twitch...) +|Whether or not embed the iframe for this video conference URL. Only a few services allow embedding, including YouTube, Twitch. |Start Time |Required -|Which day and time will the meeting start. Expected format: dd/mm/yyyy hh:ii +|Which day and time the meeting starts. Expected format: dd/mm/yyyy hh:ii. |End Time |Required -|Which day and time will the meeting start. Expected format: dd/mm/yyyy hh:ii +|Which day and time the meeting ends. Expected format: dd/mm/yyyy hh:ii. |Category |Optional -|Which Category has the meeting. Used for filtering in the meetings list. +|The relevant category for the meeting. Used for filtering in the meetings list. + +pass:[] +pass:[] + +// There are some grammatical issues here in the core strings, so we turn off the vale alerts here until they are fixed. |Registration type |Required -|Choose one option between "Registration disabled", "On this platform", or "On a different platform" +|Choose one option between 'Registration disabled', 'On this platform', or 'On a different platform'. + +pass:[] +pass:[] |Available slots for this meeting -|Required if "Registration type" is "On this platform" -|How many slots are available for this meeting? Leave it to 0 if you have unlimited slots available +|Required if 'Registration type' is 'On this platform' +|How many slots are available for this meeting? Leave it to 0 if you have unlimited slots available. |Registration terms -|Required if "Registration type" is "On this platform" -|What terms of services participants need to accept to register or join the meeting. Specific to "Citizens meetings" +|Required if 'Registration type' is 'On this platform' +|What terms of services participants need to accept to register or join the meeting. Specific to 'Citizens meetings'. |Registration URL -|Required if "Registration type" is "On a different platform" +|Required if 'Registration type' is 'On a different platform' |Must be an URL. Link to go on the external service that you are using for registrations. |Create meeting as |Required if the participant belongs to a group -|With which identity she wants to create this meeting: as her user or as a group that she's reprensenting? +|With which identity she wants to create this meeting: as her user or as a group that she's representing? |=== @@ -209,7 +229,7 @@ After creating the meeting, participants can also edit and xref:components/meeti === Official meetings -image:components/meetings/new_meeting_form_backend.png[Create a new meeting form (backend)] +image:components/meetings/new_meeting_form_backend.png[Create a new meeting form - back end] .Create meeting - Backend form |=== @@ -221,15 +241,15 @@ image:components/meetings/new_meeting_form_backend.png[Create a new meeting form |Description |Required -|A description of what will be discussed in this meeting, like the topics. +|A description of the discussion topics for this meeting. |Type |Required -|Choose one option between "In person", "Online" or "Booth" +|Choose one option between 'In person', 'Online' or 'Hybrid' |Address -|Required if meeting type is "In person" or "Booth" -|Address: used by Geocoder to find the location +|Required if meeting type is 'In person' or 'Hybrid' +|Address: used by Geo-coder to find the location |Location |Required @@ -241,57 +261,65 @@ image:components/meetings/new_meeting_form_backend.png[Create a new meeting form |Online meeting URL |Optional -|Which URL will the meeting be held. +|The URL for the meeting. |Show embedded iframe for this URL |Optional -|Whether or not embed the iframe for this videoconference URL. Only a few services allow embedding (i.e. YouTube, Twitch...) +|Whether or not embed the iframe for this video conference URL. Only a few services allow embedding including YouTube, Twitch. |Start Time |Required -|Which day and time will the meeting start. Expected format: dd/mm/yyyy hh:ii +|Which day and time the meeting starts. Expected format: dd/mm/yyyy hh:ii |End Time |Required -|Which day and time will the meeting start. Expected format: dd/mm/yyyy hh:ii +|Which day and time the meeting ends. Expected format: dd/mm/yyyy hh:ii |Category |Optional -|Which Category has the meeting. Used for filtering in the meetings list. +|The relevant category for the meeting. Used for filtering in the meetings list. + +pass:[] +pass:[] + +// There are some grammatical issues here in the core strings, so we turn off the vale alerts here until they are fixed. |Registration type |Required -|Choose one option between "Registration disabled", "On this platform", or "On a different platform" +|Choose one option between 'Registration disabled', 'On this platform', or 'On a different platform' + +pass:[] +pass:[] |Available slots for this meeting -|Required if "Registration type" is "On this platform" +|Required if 'Registration type' is 'On this platform' |How many slots are available for this meeting? Leave it to 0 if you have unlimited slots available |Registration URL -|Required if "Registration type" is "On a different platform" +|Required if 'Registration type' is 'On a different platform' |Must be an URL. Link to go on the external service that you are using for registrations. |Private meeting |Optional -|Check if the meeting shouldn't be visible for all the visitors. Specific to "Official meetings". +|Select if the meeting should not be visible for all the visitors. Specific to 'Official meetings'. |Transparent |Optional -|Related to "Private meeting", check if the meeting should be visible for all the visitors but they shouldn't be able to -participate in. Specific to "Official meetings". Specific to "Official meetings". +|Related to 'Private meeting', select if the meeting should be visible for all the visitors but they should not be able to +participate in the meeting. Specific to 'Official meetings'. |Customize registration email |Optional -|Wheter you want to add a message in the registration email. Specific to "Official meetings". +|Whether you want to add a message in the registration email. Specific to 'Official meetings'. |Registration email custom content -|Required if "Customize registration email" is checked -|The content of the customized email. This text will appear in the middle of the registration confirmation email. Just -after the registration code. Specific to "Official meetings". +|Required if you selected 'Customize registration email'. +|The content of the customized email. This text appears in the middle of the registration confirmation email, just +after the registration code. Specific to 'Official meetings'. |=== -You can also define *Services* inside of a Meeting. These are metadata that allows to comunicate, for instance, if there's +You can also define *Services* inside of a Meeting. These are metadata that allows to communicate, for instance, if there's a place for children, deaf assistance, translations, etc. You can have multiple services inside of a meeting. .Create meeting - Services @@ -318,11 +346,11 @@ a place for children, deaf assistance, translations, etc. You can have multiple |image:action_preview.png[Preview icon] |Preview -|To see how it's shown in the frontend to participants. +|To preview the display in the front end for participants. |image:action_permissions.png[Permissions icon] |Permissions -|To handle the permissions of this meeting, depending on the verification a participant has. Allows an admin to configure +|To handle the permissions of this meeting, depending on the verification a participant has. Allows an administrator to configure who can *Join* a meeting. |=== @@ -335,31 +363,31 @@ who can *Join* a meeting. |image:action_publish.png[Publish icon] |Publish -|To show publicly the meeting. +|To show the meeting publicly. -|image:action_publish.png[Unpublish icon] -|Unpublish -|To not show publicly the meeting. +|image:action_publish.png[Un-publish icon] +|Un-publish +|To not show the meeting publicly. |image:action_preview.png[Preview icon] |Preview -|To see how it's shown in the frontend to participants. +|To see the display in the front end to participants. |image:action_duplicate.png[Duplicate icon] |Duplicate -|Allows an admin to duplicate a meeting. +|Allows an administrator to duplicate a meeting. |image:action_registrations.png[Registrations icon] |xref:admin:components/meetings/registrations.adoc[Registrations] -|Allows to define who can register for attending to the meeting. +|Allows you to define who can register for attending to the meeting. |image:action_edit.png[Edit icon] |Edit -|Edit form for a Meeting. It's the same form as "Create a new meeting". +|Edit form for a Meeting. It is the same form as 'Create a new meeting'. |image:action_agenda.png[Agenda icon] |xref:admin:components/meetings/agenda.adoc[Agenda] -|To add the topics that will be discussed in the meeting. +|To add the discussion topics for the meeting. |image:action_list.png[Poll icon] |xref:admin:components/meetings/polls.adoc[Polls] @@ -367,15 +395,15 @@ who can *Join* a meeting. |image:action_close.png[Close icon] |xref:admin:components/meetings/close.adoc[Close] -|Allows and admin to Close the meeting and add extra information. +|Allows an administrator to Close the meeting and add extra information. |image:action_folder.png[Folders icon] |Folders -|For classifying Attachments. +|For organizing Attachments. |image:action_attachments.png[Attachments icon] |Attachments -|Documents that are related to the meeting. +|Documents related to the meeting. |image:action_permissions.png[Permissions icon] |Permissions @@ -390,22 +418,26 @@ who can *Join* a meeting. == Meetings features -There are different kinds of features that can be enabled in meetings, such as: +There are different kinds of features that you can turn on in meetings, such as: -* xref:admin:components/meetings/registrations.adoc[Registrations]: for managing how particpant can register to attend the meeting. -* xref:admin:components/meetings/agenda.adoc[Agenda]: for seeing the topics that will be discussed in the meeting by minutes. +* xref:admin:components/meetings/registrations.adoc[Registrations]: for managing how participants can register to attend the meeting. +* xref:admin:components/meetings/agenda.adoc[Agenda]: for seeing the discussion topics from the meeting by duration in minutes. * xref:admin:components/meetings/polls.adoc[Polls]: for quick voting during an online meeting. -* xref:admin:components/meetings/close.adoc[Close]: for adding the final report on what was discussed in the meeting. +* xref:admin:components/meetings/close.adoc[Close]: for adding the final report on the discussion topics from the meeting. == Online meetings -Depending in the moment and configuration of the meeting, there could be different messages that will be shown to the participants. +Depending on the current date and time, and the configuration of the meeting, there could be different messages displayed to the participants. -. If the "Online meeting URL" ins't set, there'll be a message that says "Link available soon" +. If the 'Online meeting URL' is not set, a message displays that says 'Link available soon' image:components/meetings/online_meeting_available_soon.png[Online meeting available soon] -. If the "Online meeting URL" is set, and a few minutes before the meeting start, the mesage will say "The link to join +pass:[] +// There are some grammatical issues here in the core strings, so we turn off the vale alerts here until they are fixed. +. If you have set the 'Online meeting URL', and the date/time is within a few minutes of the meeting start time, the message displays "The link to join the meeting will be available a few minutes before it starts" + +pass:[] image:components/meetings/online_meeting_available_before.png[Online meeting available before it starts] -. If the "Online meeting URL" is set, and the start time of the meeting has arrived, then there'll be a message that says -that "the meeting is happening right now", with a link to join the meeting. +. If you have set the 'Online meeting URL', and the start time of the meeting has arrived, then a message displays that says +that 'the meeting is happening right now', with a link to join the meeting. image:components/meetings/online_meeting_happening.png[Online meeting available before it starts] diff --git a/docs/en/modules/admin/pages/components/meetings/agenda.adoc b/docs/en/modules/admin/pages/components/meetings/agenda.adoc index 42d44c47fc..0c2dd10943 100644 --- a/docs/en/modules/admin/pages/components/meetings/agenda.adoc +++ b/docs/en/modules/admin/pages/components/meetings/agenda.adoc @@ -1,7 +1,7 @@ = Agenda -The agenda feature allows an administrator to define the schedule for a meeting. It's possible to define agenda items and -sub-items, with every one of the topics that will be discussed in the meeting, along with a description and the duration +The agenda feature allows an administrator to define the schedule for a meeting. It is possible to define agenda items and +sub-items, listing each discussion topic for the meeting, along with a description and the duration of every item and sub-item. image:components/meetings/agenda/agenda_frontend.png[Agenda in the frontend] @@ -10,13 +10,13 @@ image:components/meetings/agenda/agenda_frontend.png[Agenda in the frontend] To define an agenda for a meeting: -. Sign in as admin -. Go to admin panel +. Sign in as an administrator +. Go to the administrator panel . In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" -. Click on "Meetings" +For instance, it could be 'Processes', 'Assemblies', or 'Conferences' +. Click on 'Meetings' . Search the meeting that you want to add the agenda to -. Click on the "Agenda" button image:action_agenda.png[Agenda button] +. Click on the 'Agenda' button image:action_agenda.png[Agenda button] . Fill the form image:components/meetings/agenda/new_agenda_form.png[New agenda form in the backend] @@ -27,7 +27,7 @@ image:components/meetings/agenda/new_agenda_form.png[New agenda form in the back |Title |Required -|Title for the agenda. For instance, "Schedule" +|Title for the agenda. For instance, 'Schedule' |Visible |Optional @@ -39,8 +39,8 @@ image:components/meetings/agenda/new_agenda_form.png[New agenda form in the back |=== -It's possible to create any number of Agenda items and sub-items. You can up or down the hierarchy of the agenda items. -It's also possible to remove and edit the agenda items. +It is possible to create any number of Agenda items and sub-items. You can move up or down the position in the hierarchy of the agenda items. +It is also possible to remove and edit the agenda items. .Agenda item form |=== @@ -52,7 +52,7 @@ It's also possible to remove and edit the agenda items. |Duration |Required -|How many minutes will the agenda item last. For instance, "15". +|How many minutes the agenda item covers. For instance, '15'. |Description |Optional @@ -65,7 +65,7 @@ It's also possible to remove and edit the agenda items. |=== The only limitation that agenda items and sub-items have is that they have to respect the duration of the parent. For instance, -if there's an Item that lasts 60 minutes, you can't create a sub-item that lasts 90 minutes. +if there's an item that lasts 60 minutes, you cannot create a sub-item that lasts 90 minutes. As an example, this agenda: @@ -73,7 +73,7 @@ image:components/meetings/agenda/agenda_frontend.png[Agenda in the frontend] Has the following configuration: -* Title: "Schedule" +* Title: 'Schedule' * Visible: true * Agenda item #1: ** Title: Diagnosis @@ -84,7 +84,7 @@ Has the following configuration: ** Agenda sub-item #2.1: *** Title: Future thinking *** Duration: 60 -*** Description: Imagining how we can solve the problem +*** Description: Imagining how to solve the problem ** Agenda sub-item #2.2: *** Title: Creating proposals *** Duration: 60 diff --git a/docs/en/modules/admin/pages/components/meetings/close.adoc b/docs/en/modules/admin/pages/components/meetings/close.adoc index b9c058ae8d..3241a07e6f 100644 --- a/docs/en/modules/admin/pages/components/meetings/close.adoc +++ b/docs/en/modules/admin/pages/components/meetings/close.adoc @@ -1,12 +1,12 @@ = Close -After a meeting has passed it's possible and recommened to close the meeting. This allows to adds the minutes, the notes -that gives a summary on what was discussed during the meeting, the agreements reached, decisions made, etc. +After a meeting has passed it is possible and recommended to close the meeting. This allows you to adds the minutes, the notes +that gives a summary on discussion topics during the meeting, the agreements reached, decisions made, etc. -This allows to bring transparency to the meeting and also serves as a record of the different meetings. +This allows you to bring transparency to the meeting and also serves as a record of the different meetings. -It's also possible to add other kind of metadata to the meeting, such as what organizations has attended, how many attendees -and contributions were, and what proposals were discussed. +It is also possible to add other kind of metadata to the meeting, such as what organizations has attended, how many attendees +and contributions were, and the discussed proposals. image:components/meetings/close/frontend.png[Close report in the frontend] @@ -16,18 +16,18 @@ image:components/meetings/close/frontend.png[Close report in the frontend] To close a meeting: -. Sign in as admin -. Go to admin panel +. Sign in as an administrator +. Go to the administrator panel . In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" -. Click on "Meetings" +For instance, it could be 'Processes', 'Assemblies', or 'Conferences' +. Click on 'Meetings' . Search the meeting that you want to close -. Click on the "Close" button image:action_close.png[Close button] +. Click on the 'Close' button image:action_close.png[Close button] . Fill the form image:components/meetings/close/form_backend.png[Close meeting form in the backend] -.Close meeting form (backend) +.Close meeting form - backend |=== |Field |Type |Description @@ -49,15 +49,15 @@ image:components/meetings/close/form_backend.png[Close meeting form in the backe |Proposals |Optional -|Choose proposals from this space that were discussed in this meeting +|Choose proposals discussed in this meeting from this space. |Video URL |Optional -|It's not used for anything. It will be removed in the future. +|It is not used for anything. Decidim plans to remove it in the future. |Audio URL |Optional -|It's not used for anything. It will be removed in the future. +|It is not used for anything. Decidim plans to remove it in the future. |Is visible |Optional @@ -69,16 +69,16 @@ image:components/meetings/close/form_backend.png[Close meeting form in the backe Just like participants can create meetings, they can also close a meeting. They have fewer fields to fill. -To close a a meeting: +To close a meeting: . Sign in as the participant that created the meeting . Go to the meeting page -. Click on "Close". This will only be visible after the meeting has passed +. Click on 'Close'. This is only visible after the meeting end time has passed . Fill the form image:components/meetings/close/form_frontend.png[Close meeting form in the frontend] -.Close meeting form (frontend) +.Close meeting form - frontend |=== |Field |Type |Description @@ -92,12 +92,12 @@ image:components/meetings/close/form_frontend.png[Close meeting form in the fron |Proposals |Optional -|Choose proposals from this space that were discussed in this meeting +|Choose proposals discussed in this meeting from this space. |=== == Proposals -If you relate a proposal to a meeting, the meeting also will be shown in the proposal. +If you relate a proposal to a meeting, the proposal displays a link to this meeting. image:components/meetings/close/related_proposal.png[Related meeting in a proposal] diff --git a/docs/en/modules/admin/pages/components/meetings/polls.adoc b/docs/en/modules/admin/pages/components/meetings/polls.adoc index dcd7b48134..58ce21687c 100644 --- a/docs/en/modules/admin/pages/components/meetings/polls.adoc +++ b/docs/en/modules/admin/pages/components/meetings/polls.adoc @@ -1,29 +1,28 @@ = Polls -CAUTION: this feature is still in active development and can't be used in production yet. +CAUTION: this feature is still in active development and you should not use it in production yet. -Through the manage polls feature is possible to define a poll that will be displayed when an online meeting is ocurring. +Through the manage polls feature is possible to define a poll to display when an online meeting is occurring. This is useful to see quick feedback and make a decision inside the meeting without having to leave the meeting and use -other kind of tools (like surveys or proposals). +other kind of tools like surveys or proposals. -With this feature an administrator can define questions and also manage when these questions and its results will be shown -to participants. +With this feature, an administrator can define questions and also manage when these questions, with the results, display to participants. == Enable polls for a meeting To enable polls for a meeting: -. Sign in as admin -. Go to admin panel +. Sign in as an administrator +. Go to administrator panel . In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" -. Click on "Meetings" +For instance, it could be 'Processes', 'Assemblies', or 'Conferences' +. Click on 'Meetings' . Search the meeting that you want to define polls for -. Click on the "Manage polls" button image:action_list.png[Manage polls button] +. Click on the 'Manage polls' button image:action_list.png[Manage polls button] . Fill the form The form is pretty much the Decidim form builder, with one caveat: you can only define Single and Multiple option questions. image:components/meetings/polls/backend.png[Backend for meeting polls] -image:components/meetings/polls/backend_question.png[Definining a question in meeting polls] +image:components/meetings/polls/backend_question.png[Defining a question in meeting polls] diff --git a/docs/en/modules/admin/pages/components/meetings/registrations.adoc b/docs/en/modules/admin/pages/components/meetings/registrations.adoc index 98068256cf..d05e648e2d 100644 --- a/docs/en/modules/admin/pages/components/meetings/registrations.adoc +++ b/docs/en/modules/admin/pages/components/meetings/registrations.adoc @@ -1,20 +1,20 @@ = Registrations -Through registrations you can have capacity control of the attendance for a meeting. With this feature for instance you can -limit how many people could attend to the meeting, or you can know before the start of a meeting if you need to find a bigger +Through registrations you can have the ability to control the capacity of the attendance for a meeting. With this feature, for instance, you can +limit how many people could attend to the meeting, or you can know before the start of a meeting if you need to find a larger room to have the meeting. -Enabling this feature will add a button so that participants can express their wish to go to the meeting. Depending in how -this feature is configured, then: +Enabling this feature adds a button so that participants can express their wish to go to the meeting. Depending on how +you configure this feature, then: -. it's possible to define how many slots are available for controling the maximum capacity for this meeting -. a xref:_registration_form[custom registration form] for asking information to participants can be configured -. administrators can make xref:_invitations[invitations] to other participants or people that isn't registered in the platform -. it's possible to control attendance to the meeting through xref:_registration_code[registration codes] +. it is possible to define how many slots are available for controlling the maximum capacity for this meeting +. you can configure a xref:_registration_form[custom registration form] to ask for information from participants +. administrators can make xref:_invitations[invitations] to other participants or people that are not registered on the platform +. it is possible to control attendance at the meeting through xref:_registration_code[registration codes] image:components/meetings/registrations/frontend_join_meeting.png[Join a meeting sidebar button] -Once participants confirm joining a meeting they get asked if they're reprensenting a group and if they want to show publicly that they're attending. +Once participants confirm joining a meeting, they get asked if they are representing a group, and if they want to show publicly that they are attending. image:components/meetings/registrations/frontend_confirm.png[Join a meeting confirm modal] @@ -22,18 +22,18 @@ image:components/meetings/registrations/frontend_confirm.png[Join a meeting conf To enable registrations for a meeting: -. Sign in as admin -. Go to admin panel +. Sign in as an administrator +. Go to administrator panel . In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" -. Click on "Meetings" +For instance, it could be 'Processes', 'Assemblies', or 'Conferences' +. Click on 'Meetings' . Search the meeting that you want to enable registrations for -. Click on the "Edit" button image:action_edit.png[Edit button] -. Change the "Registration type" field to "On this platform" -. Define how many slots are available in "Available slots for this meeting" -. Click on the "Update" button -. Click on the "Registrations" button image:action_registrations.png[Registrations button] -. Check the "Registrations enabled" checkbox +. Click on the 'Edit' button image:action_edit.png[Edit button] +. Change the 'Registration type' field to 'On this platform' +. Define how many slots are available in 'Available slots for this meeting' +. Click on the 'Update' button +. Click on the 'Registrations' button image:action_registrations.png[Registrations button] +. Check the 'Registrations enabled' checkbox . Fill the form == Registrations settings form @@ -58,7 +58,7 @@ image:components/meetings/registrations/backend.png[Registrations settings in a |Reserved slots |Required -|How many slots are already reserved. Leave it to 0 if you don't have reserved slots +|How many slots are already reserved. Leave it to 0 if you do not have reserved slots |Registration terms |Required @@ -73,27 +73,26 @@ for registration information. == Export all -It's possible to export registrations in multiple formats: CSV, JSON and XLSX (Excel). +It is possible to export registrations in multiple formats including CSV, JSON, and XLSX (Excel). -The exported data will have these fields: +The exported data has the following fields: * id: The registration id -* code: the xref:_registration_code[registration code] (if this feature is enabled) +* code: the xref:_registration_code[registration code] - if you've enabled this feature * user/name: the name of the user * user/email: the email of the user -* user/user_group: the group of the user if she has selected that's representing a group when registering +* user/user_group: the group of the user if she has selected that is representing a group when registering == Invitations -This feature allows you to invite attendes to a meeting. These could be already registered or non-existing participants -in the platform. +This feature allows you to invite attendees to a meeting. These could be already registered or non-existing participants +on the platform. image:components/meetings/registrations/invite_attendee.png[Invite attendee for registration in a meeting] == Registration code -This feature allows you to check if the attendee is registered in the meeting. She needs to provide her code, that gets -entered in this form and it's checked against the database. +This feature allows you to verify an attendee's registration for the meeting. She needs to provide her code, which an administrator enters in this form. Decidim verifies the code against the database - useful for example when checking in attendees at an in-person event. image:components/meetings/registrations/backend_w_registration_code.png[Registration code form in a meeting] @@ -102,4 +101,4 @@ image:components/meetings/registrations/frontend_confirmed_w_code.png[Registrati It can receive two kind of responses: * Registration code successfully validated. -* This registration code is invalid. +* This registration code is not valid. diff --git a/docs/en/modules/admin/pages/components/pages.adoc b/docs/en/modules/admin/pages/components/pages.adoc index b22abcc555..8af992fc5f 100644 --- a/docs/en/modules/admin/pages/components/pages.adoc +++ b/docs/en/modules/admin/pages/components/pages.adoc @@ -1,12 +1,12 @@ = Page -The Page component allows people to get information about a space. It's similar to the general xref:admin:pages.adoc[Pages] admin section, with -the main difference is that this component allows to define pages in a space, and the general Pages admin section allows to -define pages for all the platform (for instance, help pages, terms of services, or FAQs), that aren't associated to a space. +The Page component allows people to get information about a space. It is similar to the general xref:admin:pages.adoc[Pages] administrative section, with +the main difference is that this component allows to define pages in a space, and the general Pages administrative section allows you to +define pages for all the platform - for instance, help pages, terms of services, or FAQs which are not associated with a space. From this starting point, there could be other configurations, such as: -Some examples of where this component was used: +Some examples of this component in use include: * https://www.decidim.barcelona/processes/PressupostosParticipatius/f/4691/[More information page in 2020 Participatory Budgeting process in Decidim Barcelona] @@ -15,13 +15,13 @@ image:components/page/example02.png[More information page in 2020 Participatory To configure the Page component: -. Sign in as admin -. Go to admin panel +. Sign in as an administrator +. Go to the administrator panel . In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" +For instance, it could be 'Processes', 'Assemblies', or 'Conferences' . Go to components -. Click on "Add component" button -. Click on "Page" +. Click on 'Add component' button +. Click on 'Page' . Fill the xref:_add_component[Add component] form == Add component @@ -34,12 +34,12 @@ image:components/page/component.png[Add component form] |Name |Required -|What is the title of this component. For instance, "More information". +|What is the title of this component. For instance, 'More information'. |Order position |Optional -|Which order will it have in relation to the other pages. Having a lower number means a higher priority. -For instance, if you have two pages, "Page a" with weight "10" and "Page b" with weight "0", then "Page b" will be first when ordering. +|Which order it has in relation to the other pages. Having a lower number means a higher priority. +For instance, if you have two pages, 'Page A' with weight '10' and 'Page B' with weight '0', then 'Page B' displays first when ordering. |=== @@ -49,11 +49,11 @@ For instance, if you have two pages, "Page a" with weight "10" and "Page b" with |Announcement |Optional -|A general announcement that'll be visible on the general pages landing page. +|A general announcement, visible on the general pages landing page. |=== -In the cases where the space that this component will be used has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in +In the cases where the space used by this component has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in xref:admin:spaces/processes.adoc[Participatory Processes], then you can also define different behaviors per Step. .Add component: Pages form - Step settings @@ -62,13 +62,13 @@ xref:admin:spaces/processes.adoc[Participatory Processes], then you can also def |Announcement |Optional -|A general announcement that'll be visible on the general page landing page. +|A general announcement visible on the general pages landing page. |=== == Permissions -As this component doesn't allow to do anything, there are no permissions to set up. +As this component does not allow users to do anything, there are no permissions to set up. === New page form diff --git a/docs/en/modules/admin/pages/components/proposals.adoc b/docs/en/modules/admin/pages/components/proposals.adoc index bc42a9ebf9..83d5230deb 100644 --- a/docs/en/modules/admin/pages/components/proposals.adoc +++ b/docs/en/modules/admin/pages/components/proposals.adoc @@ -8,9 +8,9 @@ From this starting point, there could be other configurations, such as: * how many supports as a maximum a participant can give to proposals * how many supports as a minimum a participant must give to proposals so their supports are valid * whether you want to enable that participants comment on proposals -* whether you want that proposals have images, attachments, WYSIWYG editor, geolocated address, scopes, etc. +* whether you want that proposals have images, attachments, WYSIWYG editor, geo-located address, scopes, etc. -Some examples of where this component was used: +Some examples of this component in use include: * https://futureu.europa.eu/[Conference of the Future of Europe] * https://meta.decidim.org/processes/roadmap/f/122/[Propose new functionalities for Decidim software] in https://meta.decidim.org/[Metadecidim] @@ -21,13 +21,13 @@ image:components/proposals/example03.png[Proposal detail example in Metadecidim] To configure the Proposals component: -. Sign in as admin -. Go to admin panel +. Sign in as an administrator +. Go to the administrator panel . In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" +For instance, it could be 'Processes', 'Assemblies', or 'Conferences' . Go to components -. Click on "Add component" button -. Click on "Proposals" +. Click on 'Add component' button +. Click on 'Proposals' . Fill the xref:_add_component[Add component] form == Add component @@ -40,12 +40,12 @@ image:components/proposals/component.png[Add component form] |Name |Required -|What is the title of this component. For instance, "Proposals" +|What is the title of this component. For instance, 'Proposals' |Order position |Optional -|Which order will it have in relation to the other components. Having a lower number means a higher priority. -For instance, if you have two components, "Proposals" with weight "10" and "Meetings" with weight "0", then "Meetings" will be first when ordering. +|Which order it has in relation to the other components. Having a lower number means a higher priority. +For instance, if you have two components, 'Proposals' with weight '10' and 'Meetings' with weight '0', then 'Meetings' displays first when ordering. |=== @@ -55,7 +55,7 @@ For instance, if you have two components, "Proposals" with weight "10" and "Meet |Scopes enabled |Optional -|Check if you want to have Scopes filtering in this component. +|Select if you want to have Scopes filtering in this component. |Scope |Optional @@ -63,12 +63,12 @@ For instance, if you have two components, "Proposals" with weight "10" and "Meet |Support limit per participant |Optional -|Must be a number. How much supports a participant can give to proposals. +|Must be a number. How many supports a participant can give to proposals. |Minimum supports per user |Optional -|Must be a number. How many supports does a participant needs to give to proposals so their supports are counted. If she doesn't -reach this number, her supports will not be taken in account. +|Must be a number. How many supports does a participant need to give to proposals for their votes to count. If she does not +reach this number, her supports are not taken in account. |Proposal limit per participant |Optional @@ -78,23 +78,30 @@ reach this number, her supports will not be taken in account. |Optional |Must be a number. How many characters a proposal body can have as maximum. + +pass:[] + +// There are some grammatical issues here in the core strings, so we turn off the vale alerts here until they are fixed. + |Proposal editing |Required -|Choose one of these two options: "Allow editing of proposals within a specific timeframe" or "Allow editing proposals -for an infinite amount of time". In case it's within a specific timeframe, you must specify the time in "Proposals can be -edited by authors before this many minutes passes". Note that if you xref:components/proposals/answers.adoc[answer a proposal] -then it can't be edited anymore. +|Choose one of these two options: 'Allow editing of proposals within a specific time frame' or 'Allow editing proposals +for an infinite amount of time'. In case it is within a specific time frame, you must specify the time in 'Proposals can be +edited by authors before this many minutes passes'. Note that if you xref:components/proposals/answers.adoc[answer a proposal] +then you cannot edit it anymore. |Proposals can be edited by authors before this many minutes passes -|Required if "Proposal editing" is "Allow editing of proposals within a specific timeframe" -|Must be a number. How many minutes after the creation of a proposal it can be edited by its author. +|Required if 'Proposal editing' is 'Allow editing of proposals within a specific time frame' +|Must be a number. How many minutes the author has after the creation of a proposal to make edits. + +pass:[] |Threshold per proposal |Optional -|Must be a number. How many supports a proposal needs to have to be considered as "validated". See <>. +|Must be a number. How many supports a proposal needs to be 'validated'. See <>. |Can accumulate supports beyond threshold -|Optional. Only applies if "Threshold per proposal" is configured. +|Optional. Only applies if you have configured 'Threshold per proposal'. |Whether the proposal can accumulate more supports than the threshold. |Proposal answering enabled @@ -103,7 +110,7 @@ then it can't be edited anymore. |Official proposals enabled |Optional -|Wheter administrators can create official proposals. +|Whether administrators can create official proposals. |Comments enabled |Optional @@ -111,68 +118,74 @@ then it can't be edited anymore. |Comments max length |Optional -|What are the characters limit that participants will have when making comments. Leave 0 for the default value. +|What is the character limit that participants have when making comments. Use 0 for the default value. -|Geocoding enabled +|Geo-coding enabled |Optional -|Wheter participants can define a geocoding address for their proposals. Need to have xref:configure:geocoding[Geocoding] enabled. See <>. +|Whether participants can define a geo-coding address for their proposals. Need to have xref:configure:geocoding[Geo-coding] enabled. See <>. |Allow attachments |Optional -|Check to allow participants to attach files to their proposals. +|Select to allow participants to attach files to their proposals. |Allow card image |Optional -|Check to show a card image when participants attach images to their proposals. See <>. +|Select to show a card image when participants attach images to their proposals. See <>. + +pass:[] + +// There are some grammatical issues here in the core strings, so we turn off the vale alerts here until they are fixed. |Actions permissions can be set for each proposal |Optional -|Whether you want to be able to set permissions for every one of the proposals. Most of the time you will want to leave this option disabled. +|Whether you want to be able to set permissions for every one of the proposals. Most of the time you should leave this option turned off. + +pass:[] |Collaborative drafts enabled |Optional -|Check to enable xref:components/proposals/collaborative_drafts.adoc[collaborative drafts] in proposals. +|Select to enable xref:components/proposals/collaborative_drafts.adoc[collaborative drafts] in proposals. |Participatory texts enabled |Optional -|Check to enable xref:components/proposals/participatory_texts.adoc[participatory texts] in proposals. +|Select to enable xref:components/proposals/participatory_texts.adoc[participatory texts] in proposals. |Amendments enabled |Optional -|Check to enable xref:components/proposals/amendments.adoc[amendments] in proposals. If active, configure Amendment features for each step. +|Select to enable xref:components/proposals/amendments.adoc[amendments] in proposals. If active, configure Amendment features for each step. |Amendments Wizard help text -|Optional. Visible if the "Amendments enabled" option is checked. -|What's the help text visible when creating new amendments. +|Optional. Visible if the 'Amendments enabled' option is selected. +|What is the help text visible when creating new amendments. |Announcement |Optional -|A general announcement that'll be visible on the general proposals landing page. +|A general announcement visible on the general proposals landing page. |New proposal body template |Optional -|A pre-defined text that will be used when creating new proposals. Useful if you want to define a format that participants need to +|Pre-defined text that displays when creating new proposals. Useful if you want to define a format that participants need to follow when creating new proposals. |New proposal help text |Optional -|What's the help text visible when creating new proposals. +|What is the help text visible when creating new proposals. -|Proposal wizard "Create" step help text +|Proposal wizard 'Create' step help text |Optional -|What's the help text visible when creating new proposals in the "Create" step. +|What is the help text visible when creating new proposals in the 'Create' step. -|Proposal wizard "Compare" step help text +|Proposal wizard 'Compare' step help text |Optional -|What's the help text visible when creating new proposals in the "Compare" step. +|What is the help text visible when creating new proposals in the 'Compare' step. -|Proposal wizard "Complete" step help text +|Proposal wizard 'Complete' step help text |Optional -|What's the help text visible when creating new proposals in the "Complete" step. +|What is the help text visible when creating new proposals in the 'Complete' step. -|Proposal wizard "Publish" step help text +|Proposal wizard 'Publish' step help text |Optional -|What's the help text visible when creating new proposals in the "Publish" step. +|What is the help text visible when creating new proposals in the 'Publish' step. |=== @@ -188,13 +201,13 @@ image::components/proposals/setting_threshold02.png[Example of threshold setting image::components/proposals/setting_card_image.png[Example of card image setting] [#setting-geocoding] -*Example of geocoding setting* +*Example of geo-coding setting* -image::components/proposals/setting_geocoding.png[Example of geocoding setting] +image::components/proposals/setting_geocoding.png[Example of geo-coding setting] --- -In the cases where the space that this component will be used has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in +In the cases where the space using this component has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in xref:admin:spaces/processes.adoc[Participatory Processes], then you can also define different behaviors per Step. .Add component: Proposals form - Step settings @@ -203,67 +216,67 @@ xref:admin:spaces/processes.adoc[Participatory Processes], then you can also def |Announcement |Optional -|A general announcement that'll be visible on the general proposal landing page. +|A general announcement visible on the general proposal landing page. |Endorsements enabled |Optional -|Check if you want that participants show public support for these proposals. +|Select if you want participants to show public support for these proposals. |Endorsements blocked |Optional -|Whether participants will be able to see the endorsments but don't make any. +|Whether participants can see the endorsements but cannot make any. |Supports enabled |Optional -|Whether participants will be able to support proposals in this step. +|Allows participants to support proposals in this step. |Supports blocked |Optional -|Whether participants will be able to support proposals in this step. +|Prevents participants supporting proposals in this step. |Supports hidden |Optional -|If supports are enabled, checking this will hide the number of supports. +|If you have enabled supports, checking this hides the number of supports in the front end. |Comments blocked |Optional -|Whether you want to enable comments for this phase. +|Whether you want to allow comments for this phase. |Proposal creation enabled |Optional -|Whether you want to enable proposal creation by participants for this phase. See xref:_new_proposal_form[New proposal form] +|Whether you want to allow proposal creation by participants for this phase. See xref:_new_proposal_form[New proposal form] |Proposal answering enabled |Optional -|Whether you want to enable xref:components/proposals/answers.adoc[proposal answering]. +|Whether you want to allow xref:components/proposals/answers.adoc[proposal answering]. |Publish proposal answers immediately |Optional -|Wheter you want that the answers of proposals are published at the same time that you're xref:components/proposals/answers.adoc[answering] them or you want to control when to publish the answers. +|Whether you want answers of proposals published at the same time that you're xref:components/proposals/answers.adoc[answering] them or you want to control when to publish the answers. |Enable costs on proposal answers |Optional -|Wheter you want to add economical costs to proposal answers. Useful for importing to xref:components/budgets.adoc[budgets]. +|Whether you want to add economical costs to proposal answers. Useful for importing to xref:components/budgets.adoc[budgets]. |Amendment creation enabled -|Optional. Visible if "Amendments enabled" option is checked. +|Optional. Visible if you have checked 'Amendments enabled'. |Participant can amend proposals. See xref:components/proposals/amendments.adoc[Amendments]. |Amendment reaction enabled -|Optional. Visible if "Amendments enabled" option is checked. -|Proposal's authors will be able to accept or reject Participant's emendations. +|Optional. Visible if you have checked 'Amendments enabled'. +|Proposal's authors are able to accept or decline Participant's amendments. |Amendment promotion enabled -|Optional. Visible if "Amendments enabled" option is checked. -|Emandation authors will be able to promote to Proposal the rejected emendation. +|Optional. Visible if you have checked the 'Amendments enabled' option. +|Amendment authors can promote to Proposal the rejected amendment. |Amendments visibility -|Required. Visible if "Amendments enabled" option is checked. -|Choose one of "Amendments are visible to all" or "Amendments are visible only to their authors" +|Required. Visible if you have checked the 'Amendments enabled' option. +|Choose one of 'Amendments are visible to all' or 'Amendments are visible only to their authors' |Announcement |Optional -|A general announcement that'll be visible on the general proposals landing page. +|A general announcement visible on the general proposals landing page. |Hashtags added to all proposals |Optional @@ -282,8 +295,8 @@ image::components/proposals/setting_hashtag.png[Example of hashtag setting] == Permissions -An administrator can choose which kind of xref:customize:authorizations.adoc[Authorizations] a participant need to have to make -certain actions in the proposals: +An administrator can choose which kind of xref:customize:authorizations.adoc[Authorizations] a participant needs to have to carry out +certain actions on the proposals: * Endorse * Support @@ -319,12 +332,11 @@ Allows exporting the proposals in different formats. image:components/proposals/new_proposal_frontend.png[New proposal form] -Proposals can be created by participants if the setting is "Proposal creation enabled" is checked for the active phase. +Participants can create proposals if you have selected the setting 'Proposal creation enabled' for the active phase. If a participant belongs to a xref:admin:participants/groups.adoc[user group], then she'll be able to create proposals as that group also. -This form depends a lot in which settings you've enabled in this component. It can be really short (with only a Title and -Body by default) or very long (Title, Body, Hashtags, Address, Scope, Category, Image and Attachment). +This form depends a lot in which settings you've enabled in this component. It can be really short - with only a Title and Body by default - or very long - Title, Body, Hashtags, Address, Scope, Category, Image, and Attachment. .New proposal form - default (by a participant) |=== @@ -332,69 +344,69 @@ Body by default) or very long (Title, Body, Hashtags, Address, Scope, Category, |Title |Required -|What is the title of this proposal. For instance, "Bike lane in Main Street". Must have at least 15 characters as minimum +|What is the title of this proposal. For instance, 'Bike lane in Main Street'. Must have at least 15 characters as minimum and 150 characters as maximum. Must start with a capital letter. |Body |Optional |What is the full description for this proposal. Must have at least 15 characters as minimum and 450 characters as maximum -by default but can be changed with the setting "Maximum proposal body length". +by default but you can change this with the setting 'Maximum proposal body length'. |=== To detect duplicated proposals before publishing them, the proposal creation has a wizard form with multiple steps. This also -allows participants to save proposals drafts (unpublished) in case they need to fill too many fields. +allows participants to save proposals drafts - unpublished - in case they need to fill out a lot of fields. -image:components/proposals/new_proposal_frontend_compare.png[New proposal form (by a participant) - Compare] +image:components/proposals/new_proposal_frontend_compare.png[New proposal form by a participant - Compare] As an example of what the form could look depending in the settings enabled, here's a screenshot of the form for a proposal -with the following settings: "Hashtags added to all proposals", "Hashtags suggested to participants for new proposals", -"Geocoding enabled", "Allow attachments", "Allow card image" and "Scopes enabled". +with the following settings: 'Hashtags added to all proposals', 'Hashtags suggested to participants for new proposals', +'Geo-coding enabled', 'Allow attachments', 'Allow card image' and 'Scopes enabled'. -image:components/proposals/new_proposal_frontend_complete.png[New proposal form (by a participant) - Complete] +image:components/proposals/new_proposal_frontend_complete.png[New proposal form by a participant - Complete] After completing these fields the participant can see a preview of their proposal before publishing. They can also modify the proposal before publishing it. -image:components/proposals/new_proposal_frontend_publish.png[New proposal form (by a participant) - Publish] +image:components/proposals/new_proposal_frontend_publish.png[New proposal form by a participant - Publish] image:components/proposals/new_proposal_frontend_published.png[Published proposal made by a participant] ==== Official proposals -Administrators can create official proposals. There will be a filter to show only official proposals in the proposals navigation page. +Administrators can create official proposals. There is a filter to show only official proposals in the proposals navigation page. -image:components/proposals/new_proposal_backend01.png[New proposal form - default (official proposals)] +image:components/proposals/new_proposal_backend01.png[New proposal form - default - official proposals] -.New proposal form - default (official proposals) +.New proposal form - default - official proposals |=== |Field |Type |Description |Title |Required -|What is the title of this proposal. For instance, "Bike lane in Main Street". Must have at least 15 characters as minimum +|What is the title of this proposal. For instance, 'Bike lane in Main Street'. Must have at least 15 characters as minimum and 150 characters as maximum. Must start with a capital letter. |Body |Optional |What is the full description of this proposal. Must have at least 15 characters as minimum and 450 characters as maximum -by default but can be changed with the setting "Maximum proposal body length". +by default but you can change this with the setting 'Maximum proposal body length'. |This proposal comes from a meeting |Optional -|Check if this proposal comes from a meeting. +|Select if this proposal comes from a meeting. |Select a meeting -|Required if the "This proposal comes from a meeting" checkbox is checked -|Dropdown selector with all the meetings of this space. The author of the proposal will be the meeting. +|Required if you have selected the 'This proposal comes from a meeting' checkbox. +|Dropdown selector with all the meetings of this space. |=== As an example of what the form could look like depending on the settings enabled, here's a screenshot of the form for a proposal -with the following settings: "Hashtags added to all proposals", "Hashtags suggested to participants for new proposals", -"Geocoding enabled", "Allow attachments", "Allow card image" and "Scopes enabled". +with the following settings: 'Hashtags added to all proposals', 'Hashtags suggested to participants for new proposals', +'Geo-coding enabled', 'Allow attachments', 'Allow card image' and 'Scopes enabled'. -image:components/proposals/new_proposal_backend02.png[New proposal form - with multiple settings (official proposals)] +image:components/proposals/new_proposal_backend02.png[New proposal form - with multiple settings - official proposals] ==== Actions @@ -404,7 +416,7 @@ image:components/proposals/new_proposal_backend02.png[New proposal form - with m |image:action_edit.png[Edit icon] |Edit -|Edit form for a proposal. It's the same form as "New proposal". Only visible when the proposal is an xref:_official_proposals["Official proposal"]. +|Edit form for a proposal. It is the same form as 'New proposal'. Only visible when the proposal is an xref:_official_proposals['Official proposal']. |image:action_answer.png[Answer proposal icon] |xref:components/proposals/answers.adoc[Answer proposal] @@ -416,7 +428,7 @@ image:components/proposals/new_proposal_backend02.png[New proposal form - with m |image:action_preview.png[Preview icon] |Preview -|To see how it's shown in the frontend to participants. +|To preview the display in the front end to participants. |=== @@ -431,12 +443,12 @@ There are five origin options: * All: select all the origins * xref:_official_proposals[Official]: proposals created by administrators * xref:_citizens_proposals[Citizens]: proposals created by participants -* Groups: proposals created by participants that belong to a user group and choose that option when creating the proposal -* Meetings: proposals created by administrators that have checked this option when creating the proposal +* Groups: proposals created by participants that belong to a user group and choose a group as the author when creating the proposal +* Meetings: proposals created by administrators that have selected to associate the proposal with a meeting when creating the proposal == Proposal types and mechanisms -There are different kind of proposals mechanisms that can be enabled in proposals, such as: +There are different kind of proposals mechanisms that you can enable in proposals, such as: * xref:admin:components/proposals/amendments.adoc[Amendments] * xref:admin:components/proposals/answers.adoc[Answers] diff --git a/docs/en/modules/admin/pages/components/proposals/amendments.adoc b/docs/en/modules/admin/pages/components/proposals/amendments.adoc index ca215d0a98..f723f6ddd3 100644 --- a/docs/en/modules/admin/pages/components/proposals/amendments.adoc +++ b/docs/en/modules/admin/pages/components/proposals/amendments.adoc @@ -2,59 +2,58 @@ With the amendment feature, participants can propose changes to an already published proposal. -It's useful to propose improvements or corrections, specially useful when redacting laws or normatives with xref:components/proposals/participatory_texts.adoc[Participatory Texts]. +It is useful to propose improvements or corrections, and especially useful when redacting laws or regulations with xref:components/proposals/participatory_texts.adoc[Participatory Texts]. It has similarities with xref:components/proposals/collaborative_drafts.adoc[Collaborative Drafts], but the main difference -is that with amendments there is no need to trust the other authors intentions, as every change is reviewed and must be -approved by the author of the original proposal. +is that with amendments there is no need to trust the other authors intentions, as the original author reviews and approves every change. image:components/proposals/amendments/amendment.png[Amendment of a proposal] -To configure "Amendments" in proposals component: +To configure 'Amendments' in proposals component: -. Sign in as admin -. Go to admin panel +. Sign in as an administrator +. Go to the administrator panel . In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" +For instance, it could be 'Processes', 'Assemblies', or 'Conferences' . Go to components -. Click on "Add component" button -. Click on "Proposals" -. Check the "Amendments enabled" setting -. Review and configure the following related settings: "Amendments Wizard help text" in global component settings and "Amendment creation enabled", "Amendment reaction enabled", "Amendment promotion enabled", and "Amendments visibility" in the step component settings. +. Click on 'Add component' button +. Click on 'Proposals' +. Check the 'Amendments enabled' setting +. Review and configure the following related settings: 'Amendments Wizard help text' in global component settings and 'Amendment creation enabled', 'Amendment reaction enabled', 'Amendment promotion enabled', and 'Amendments visibility' in the step component settings. . Save the component == How it works -. A participant (Alice) has created a proposal -. Another participant (Bob) has seen the proposal and wants to make some changes +. A participant - Lucian - has created a proposal +. Another participant - Rosario - has seen the proposal and wants to make some changes image:components/proposals/amendments/proposal_to_amend.png[] -. Bob click on the "Amend proposal" button -. Bob makes the changes in the "Create amendment draft" form +. Rosario clicks on the 'Amend proposal' button +. Rosario makes the changes in the 'Create amendment draft' form image:components/proposals/amendments/create_amendment_draft.png[] -. Bob checks if there is any similar amendment -. Bob edits the amendment draft +. Rosario checks if there is any similar amendment +. Rosario edits the amendment draft image:components/proposals/amendments/edit_amendment_draft.png[] -. Bob publishes the amendment draft +. Rosario publishes the amendment draft image:components/proposals/amendments/publish_amendment_draft.png[] . Anyone can see the amendment draft image:components/proposals/amendments/proposal_amendmed.png[] image:components/proposals/amendments/amendment_list.png[] image:components/proposals/amendments/amendment_view_side_by_side.png[] -. It's also possible to filter the amended proposals +. It is also possible to filter the amended proposals image:components/proposals/amendments/amendment_list_filter.png[] -. Alice receives a notification that Bob has proposed an amendment to her original proposal -image:components/proposals/amendments/proposal_amendmed_notification.png[] -. Alice can see the amendment proposal -image:components/proposals/amendments/proposal_amendmed_to_review.png[] -. Alice can review the amendment proposal -image:components/proposals/amendments/proposal_amendmed_review.png[] -. Alice can approve the amendment proposal -image:components/proposals/amendments/proposal_amendmed_accepted.png[] +. Lucian receives a notification that Rosario has proposed an amendment to her original proposal +image:components/proposals/amendments/proposal_amended_notification.png[] +. Lucian can see the amendment proposal +image:components/proposals/amendments/proposal_amended_to_review.png[] +. Lucian can review the amendment proposal +image:components/proposals/amendments/proposal_amended_review.png[] +. Lucian can approve the amendment proposal +image:components/proposals/amendments/proposal_amended_accepted.png[] . Anyone can see the final proposal -image:components/proposals/amendments/proposal_amendmed_final.png[] -image:components/proposals/amendments/proposal_amendmed_amendment_list.png[] +image:components/proposals/amendments/proposal_amended_final.png[] +image:components/proposals/amendments/proposal_amended_amendment_list.png[] . Anyone can see the versions history of the proposal -image:components/proposals/amendments/proposal_amendmed_versions.png[] +image:components/proposals/amendments/proposal_amended_versions.png[] == Relevant component settings @@ -68,7 +67,7 @@ image:components/proposals/amendments/proposal_amendmed_versions.png[] |Amendments Wizard help text |Global -|What's the help text visible when creating new amendments. +|What is the help text visible when creating new amendments. |Amendment creation enabled |Step @@ -76,19 +75,19 @@ image:components/proposals/amendments/proposal_amendmed_versions.png[] |Amendment reaction enabled |Step -|Proposal's authors will be able to accept or reject Participant's emendations. +|Proposal's authors can accept or decline Participant's amendments. |Amendment promotion enabled |Step -|Emandation authors will be able to promote to Proposal the rejected emendation. +|Amendment authors can promote to Proposal the rejected amendment. |Amendments visibility |Step -|Choose one of "Amendments are visible to all" or "Amendments are visible only to their authors" +|Choose one of 'Amendments are visible to all' or 'Amendments are visible only to their authors' |=== == Promotion -If a proposal is rejected and the "Amendment promotion enabled" is enabled, then the author that have made the rejected -amendment will be able to promote to a new proposal the rejected emendation. +On proposal rejection, with the 'Amendment promotion enabled' enabled, then the author that had made the rejected +amendment has the option to promote to a new proposal the rejected amendment. diff --git a/docs/en/modules/admin/pages/components/proposals/answers.adoc b/docs/en/modules/admin/pages/components/proposals/answers.adoc index 51b79374b9..30622d9748 100644 --- a/docs/en/modules/admin/pages/components/proposals/answers.adoc +++ b/docs/en/modules/admin/pages/components/proposals/answers.adoc @@ -1,26 +1,26 @@ = Answers -Proposals answers allow an administrator or valuator to review a proposal and give it an official response. +Proposal answers allow an administrator or valuator to review a proposal and give it an official response. image:components/proposals/proposal_answer_state_accepted.png[Proposal answer state: Accepted] For answering a proposal: -. Sign in as admin or valuator -. Go to admin panel -. In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" -. Click in the "Proposals" component +. Sign in as administrator or valuator +. Go to the administrator panel +. In the main sidebar, click in the button for the space where the proposal you wish to answer resides. +For instance, it could be 'Processes', 'Assemblies', or 'Conferences' +. Click in the 'Proposals' component . Search the proposal you want to answer -. Click in the "Proposal answer" button image:action_answer.png[Answer proposal icon] -. Fill the form +. Click in the 'Proposal answer' button image:action_answer.png[Answer proposal icon] +. Fill in the form Alternatively, you could also: -. Sign in as admin or valuator +. Sign in as administrator or valuator . Navigate to the proposal you want to answer . Click in the proposal answer button in the header image:components/proposals/answer_button_header.png[Answer proposal button] -. Fill the form +. Fill in the form == Answer page @@ -28,11 +28,11 @@ The answer page has three sections: === Metadata -It has general information about the proposal, like the link, who is the author, the proposal body, how many supports, endorsements, comments, and so on. +This has general information about the proposal like the link, who is the author, the proposal body, how many supports, endorsements, comments, and so on. === Private notes -Allows an administrator or valuator to leave notes that will not be visible to the public. +Allows an administrator or valuator to leave notes that are not visible to the public. === Answer for proposal @@ -46,29 +46,29 @@ image:components/proposals/proposal_answer.png[Proposal answer form] |Internal state |Required -|Choose one of the following: Accepted, Rejected, or Evaluating +|Choose one of the following: Accepted, Rejected, or Evaluating. |Answer |Optional -|An explanation on why the proposal was accepted, rejected, or evaluated +|An explanation on why you have accepted, rejected, or evaluated the proposal. |Cost -|Required if "Enable costs on proposal answers" is enabled in the proposals component settings and if it's accepted -|A number that indicates the cost of the proposal +|Required if you have enabled 'Enable costs on proposal answers' in the proposals component settings to accept the proposal. +|A number that indicates the cost of the proposal. |Cost report -|Required if "Enable costs on proposal answers" is enabled in the proposals component settings and if it's accepted +|Required if you have enabled 'Enable costs on proposal answers' in the proposals component settings to accept the proposal. |An explanation of the cost of the proposal |Execution period -|Required if "Enable costs on proposal answers" is enabled in the proposals component settings and if it's accepted -|How much time the proposal will take to be executed +|Required if you have enabled 'Enable costs on proposal answers' in the proposals component settings to accept the proposal. +|The time required to execute the proposal. |=== == States -If the proposals component setting "Publish proposal answers immediately" is checked, then the response of the proposal will be visible to the public immediately. +If you have checked the proposals component setting 'Publish proposal answers immediately', then the response of the proposal is visible to the public immediately. The state is visible on the proposal page and card. @@ -80,7 +80,7 @@ image:components/proposals/proposal_answer_state_evaluating.png[Proposal answer === Accepted -After proposals have been accepted, they can be imported to the xref:components/budgets.adoc[budgets] component. +After accepting proposals, it is possible to import them into the xref:components/budgets.adoc[budgets] component. image:components/proposals/proposal_answer_state_accepted.png[Proposal answer state: Accepted] @@ -90,24 +90,24 @@ image:components/proposals/proposal_answer_state_rejected.png[Proposal answer st == Publication -You can control when the answers will be published by using the "Publish proposal answers immediately" checkbox. +You can control the publish date of answers by using the 'Publish proposal answers immediately' checkbox. -For enabling automatic publication, you'll need to check it. +For enabling automatic publication, you'll need to select it. -On the other hand, if you want to control when to publish the answer a proposal or multiple proposals, you'll need to follow these steps: +On the other hand, if you want to control when to publish the answer for a proposal or multiple proposals, you'll need to follow these steps: -. Sign in as admin or valuator -. Go to admin panel -. In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" -. Click in the "Proposals" component +. Sign in as administrator or valuator +. Go to the administrator panel +. In the main sidebar, click in the button for the space where the proposal you wish to publish answers for resides. +For instance, it could be 'Processes', 'Assemblies', or 'Conferences' +. Click in the 'Proposals' component . Search the proposal you want to answer . Click in the left checkbox of the proposal that you want to publish -. Click on the "Actions" button -. Click on the "Publish answers" option +. Click on the 'Actions' button +. Click on the 'Publish answers' option image:components/proposals/proposal_answer_publish.png[Proposal answer publication: action] -. Click on "Publish" button +. Click on 'Publish' button image:components/proposals/proposal_answer_publish_button.png[Proposal answer publication: publish button] -NOTE: If you have unchecked the "Publish proposal answers immediately", answered the proposals and then checked the option again, the answers will not be -published automatically. You'll still need to publish the answers manually with the "Actions" button. +NOTE: If you have unchecked the 'Publish proposal answers immediately', answered the proposals and then checked the option again, the answers are not +published automatically. You still need to publish the answers manually with the 'Actions' button. diff --git a/docs/en/modules/admin/pages/components/proposals/collaborative_drafts.adoc b/docs/en/modules/admin/pages/components/proposals/collaborative_drafts.adoc index 3a752fbd75..7a3b552c0a 100644 --- a/docs/en/modules/admin/pages/components/proposals/collaborative_drafts.adoc +++ b/docs/en/modules/admin/pages/components/proposals/collaborative_drafts.adoc @@ -2,7 +2,7 @@ With the collaborative draft feature participants can make a proposal with multiple authors. -It's useful to propose improvements or corrections. +It is useful to propose improvements or corrections. It has similarities with xref:components/proposals/amendments.adoc[Amendments] but the main difference is that with collaborative drafts there is a need to trust other authors, as they can make any change to the original proposal without approval by the @@ -10,61 +10,61 @@ original author, although the original author can decide if she promotes the col image:components/proposals/collaborative_drafts/collaborative_draft_request_access.png[Collaborative draft with request access button] -To configure "Collaborative Drafts" in Proposals component: +To configure 'Collaborative Drafts' in Proposals component: -. Sign in as admin -. Go to admin panel +. Sign in as an administrator +. Go to the administrator panel . In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" +For instance, it could be 'Processes', 'Assemblies', or 'Conferences' . Go to components -. Click on "Add component" button -. Click on "Proposals" -. Check the "Collaborative drafts enabled" setting +. Click on 'Add component' button +. Click on 'Proposals' +. Check the 'Collaborative drafts enabled' setting . Save the component == How it works -. A participant (Alice) wants to create a collaborative draft. For that, she goes to the proposals list page. -. Alice clicks in the "Access collaborative drafts" button +. A participant - Lucian - wants to create a collaborative draft. For that, she goes to the proposals list page. +. Lucian clicks in the 'Access collaborative drafts' button image:components/proposals/collaborative_drafts/proposals_list01.png[] -. Alice clicks in "New collaborative draft" button +. Lucian clicks in 'New collaborative draft' button image:components/proposals/collaborative_drafts/list_empty.png[] -. Alice fills the form and submits it +. Lucian fills the form and submits it image:components/proposals/collaborative_drafts/create_form.png[] -. Once the collaborative draft is created, Alice can: edit, withdraw or publish the collaborative draft and approve or -reject collaboration requests +. Once created, Lucian can: edit, withdraw or publish the collaborative draft and approve or +decline collaboration requests image:components/proposals/collaborative_drafts/collaborative_draft.png[] -. Another participant (Bob) has seen the collaborative draft and wants to make some changes +. Another participant - Rosario - has seen the collaborative draft and wants to make some changes image:components/proposals/collaborative_drafts/collaborative_draft_request_access.png[] -. Bob clicks in the "Request access" button +. Rosario clicks in the 'Request access' button image:components/proposals/collaborative_drafts/access_requested.png[] -. Alice receives the notification +. Lucian receives the notification image:components/proposals/collaborative_drafts/notification.png[] -. Alice goes to the collaborative draft. There she can accept or reject the collaboration request +. Lucian goes to the collaborative draft. There she can accept or reject the collaboration request image:components/proposals/collaborative_drafts/author_sidebar.png[] -. Alice approves the collaboration request. Once a request is approved it can't be rejected +. Lucian approves the collaboration request. Once approved, you cannot decline the request . Now the collaborative draft has multiple authors image:components/proposals/collaborative_drafts/multiple_authors.png[] -. Bob can edit the collaborative draft by clicking in the "Edit collaborative draft" button +. Rosario can edit the collaborative draft by clicking in the 'Edit collaborative draft' button image:components/proposals/collaborative_drafts/edit_collaborative_draft.png[] image:components/proposals/collaborative_drafts/edit_form.png[] -. Once the collabrative draft is edited, then it's possible to see the old versions and its changes +. Once edited, then it is possible to see the old versions of the collaborative draft and its changes image:components/proposals/collaborative_drafts/collaborative_draft_edited.png[] image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions.png[] image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions_show_v2_01.png[] image:components/proposals/collaborative_drafts/collaborative_draft_edited_versions_show_v2_02.png[] -. Once Alice is satisfied with the collaborative draft, she can publish it by click in the "Publish" button +. Once satisfied with the collaborative draft, Lucian can publish it by clicking the 'Publish' button image:components/proposals/collaborative_drafts/publish_modal.png[] -. When it's published it becomes a proposal +. When published, it becomes a proposal, image:components/proposals/collaborative_drafts/proposal.png[] image:components/proposals/collaborative_drafts/proposals_list02.png[] -. And the collaborative draft is still visible although it can't be edited anymore +. And the collaborative draft is still visible although editing is no longer possible. image:components/proposals/collaborative_drafts/collaborative_draft_published.png[] == Important aspects - A collaborative draft can has any number of authors. -- Only the original author can approve or reject the collaboration requests. +- Only the original author can approve or decline the collaboration requests. - Only the original author can publish the collaborative draft. - Only the original author can withdraw the collaborative draft. -- Once a collaboration request is approved, it can't be rejected. +- Once approved, you cannot subsequently decline a collaboration request. diff --git a/docs/en/modules/admin/pages/components/proposals/participatory_texts.adoc b/docs/en/modules/admin/pages/components/proposals/participatory_texts.adoc index ec9faa1aaa..947539160b 100644 --- a/docs/en/modules/admin/pages/components/proposals/participatory_texts.adoc +++ b/docs/en/modules/admin/pages/components/proposals/participatory_texts.adoc @@ -1,32 +1,37 @@ = Participatory texts -This feature allows you to navigate the proposals as text. It's useful for discussing normatives, plans, or other kinds of texts. +This feature allows you to navigate the proposals as text. It is useful for discussing regulations, plans, or other kinds of texts. -Every paragraph is split into a proposal, so it's possible to discuss it in a more granular way. +Decidim splits each paragraph into a proposal, so it is possible to discuss it in a more granular way. -Some examples of where this feature was used are: +An example of this feature in use includes: + +pass:[] + +// The non-english text here throws an error, so we temporarily turn off Vale for this part. -* https://concertation.greenpeace.fr/processes/vision-greenpeace/f/8/[Vision Greenpeace] in https://concertation.greenpeace.fr/[Greenpeace France Concertation] * https://www.decidim.barcelona/processes/PAM2020/f/3771/[Procés participatiu del Programa d'Actuació Municipal (PAM) 2020-2023] in https://www.decidim.barcelona/[Decidim Barcelona] +pass:[] + image:components/proposals/participatory_texts/example01.png[Vision Greenpeace] image:components/proposals/participatory_texts/example02.png[PAM 2020-2023 in Decidim Barcelona] -To configure the "Participatory texts" in proposals component: +To configure the 'Participatory texts' in proposals component: -. Sign in as admin -. Go to admin panel +. Sign in as an administrator +. Go to the administrator panel . In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" +For instance, it could be 'Processes', 'Assemblies', or 'Conferences' . Go to components -. Click on "Add component" button -. Click on "Proposals" -. Check the "Participatory texts enabled" setting +. Click on 'Add component' button +. Click on 'Proposals' +. Check the 'Participatory texts enabled' setting . Save the component -. Click in the "Participatory texts" button in the empty proposals component +. Click in the 'Participatory texts' button in the empty proposals component image:components/proposals/participatory_texts/manage_proposals.png[Manage proposals] -. Click in the "Import document" button in the empty Preview participatory text panel +. Click in the 'Import document' button in the empty Preview participatory text panel image:components/proposals/participatory_texts/preview_participatory_text_empty.png[Preview empty participatory text] . Fill the xref:_add_document_form[Add document form] image:components/proposals/participatory_texts/add_document_form.png[Add document form] @@ -36,8 +41,8 @@ image:components/proposals/participatory_texts/preview_participatory_text.png[Pr image:components/proposals/participatory_texts/imported_document_proposals.png[Imported document proposals] . Publish the proposal component -Notice that this feature could break existing proposals, so if there is any proposal it will not work. You'll see the -following message in the components settings: +Notice that this feature could break existing proposals, so you cannot use it if there is any proposal in existence already. If this is the case, the +following message displays in the components settings: ==== Cannot interact with this setting if there are existing proposals. Please, create a new `Proposals component` if you want @@ -46,7 +51,7 @@ to enable this feature or discard all imported proposals in the `Participatory T == Add document form -Although it's possible to work with both Markdown (.MD) and ODT (.ODT) files, we recommend working with Markdown as it's +Although it is possible to work with both Markdown (.MD) and ODT (.ODT) files, Decidim recommends working with Markdown as it is easier to see the formatting. link:{attachmentsdir}/participatory_text.md[Download the example participatory text]. @@ -59,15 +64,15 @@ image:components/proposals/participatory_texts/add_document_form.png[Add documen |Title |Required -|What's the title of the document? +|What is the title of the document? |Description |Optional -|Description for the document +|Description for the document. |Document |Required -|File. Add a document lesser than 2MB, each section until 3 levels deep will be parsed into proposals. Supported formats are: Markdown, ODT +|File. Add a document lesser than 2 Mb, each section on import, until 3 levels deep becomes a separate proposal. Supported formats are: Markdown, ODT. |=== @@ -81,7 +86,7 @@ After the document is initially imported you have three options: == Frontend -Once the document is imported and the proposals component published, you'll be able to navigate the document: +Once imported, assuming you have published both the document and the proposals component, you can navigate the document: image:components/proposals/participatory_texts/frontend.png[Frontend] image:components/proposals/participatory_texts/frontend_hover.png[Frontend hover in proposal] diff --git a/docs/en/modules/admin/pages/components/skeleton.adoc b/docs/en/modules/admin/pages/components/skeleton.adoc index 3df58fde7b..74334f3ce2 100644 --- a/docs/en/modules/admin/pages/components/skeleton.adoc +++ b/docs/en/modules/admin/pages/components/skeleton.adoc @@ -6,7 +6,7 @@ From this starting point, there could be other configurations, such as: * -Some examples of where this component was used: +Some examples of this component in use include: * @@ -17,13 +17,13 @@ image:components/skeleton/example04.png[] To configure the Skeleton component: -. Sign in as admin -. Go to admin panel +. Sign in as an administrator +. Go to the administrator panel . In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies" or "Conferences". +For instance, it could be 'Processes', 'Assemblies' or 'Conferences'. . Go to components -. Click on "Add component" button -. Click on "Skeleton" +. Click on 'Add component' button +. Click on 'Skeleton' . Fill the xref:_add_component[Add component] form == Add component @@ -36,12 +36,12 @@ image:components/skeleton/component.png[Add component form] |Name |Required -|What is the title of this component. For instance, "Skeletons" +|What is the title of this component. For instance, 'Skeletons' |Order position |Optional |Which order will it have in relation to the other skeletons. Having a lower number means a higher priority. -For instance, if you have two skeletons, "Skeleton a" with weight "10" and "Skeleton b" with weight "0", then "Skeleton b" will be first when ordering. +For instance, if you have two skeletons, 'Skeleton A' with weight '10' and 'Skeleton B' with weight '0', then 'Skeleton B' displays first when ordering. |=== @@ -51,7 +51,7 @@ For instance, if you have two skeletons, "Skeleton a" with weight "10" and "Skel |Scopes enabled |Optional -|Check if you want to have Scopes filtering in this component. +|Select if you want to have Scopes filtering in this component. |Scope |Optional @@ -67,19 +67,25 @@ For instance, if you have two skeletons, "Skeleton a" with weight "10" and "Skel |Comments max length |Optional -|What is the characters limit that participants will have when making comments. Leave 0 for default value. +|What is the character limit that participants have when making comments. Leave 0 for default value. + +pass:[] + +// There are some grammatical issues here in the core strings, so we turn off the vale alerts here until they are fixed. |Actions permissions can be set for each skeleton |Optional -|Whether you want to be able to set permissions for every one of the skeletons. Most of the time you will want to leave this option disabled. +|Whether you want to be able to set permissions for every one of the skeletons. Most of the time you should leave this option turned off. + +pass:[] |Announcement |Optional -|A general announcement that'll be visible on the general skeletons landing page. +|A general announcement visible on the general skeletons landing page. |=== -In the cases where the space that this component will be used has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in +In the cases where the space using this component has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in xref:admin:spaces/processes.adoc[Participatory Processes], then you can also define different behaviors per Step. .Add component: Skeletons form - Step settings @@ -88,11 +94,11 @@ xref:admin:spaces/processes.adoc[Participatory Processes], then you can also def |Comments blocked |Optional -|Whether you want to enable comments for this phase. +|Whether you want to turn on comments for this phase. |Announcement |Optional -|A general announcement that'll be visible on the general skeleton landing page. +|A general announcement visible on the general skeleton landing page. |=== @@ -129,12 +135,12 @@ image:components/skeleton/new_skeleton.png[New skeleton form] |Title |Required -|What is the title of this skeleton. For instance, "District A" +|What is the title of this skeleton. For instance, 'District A' |Order position |Optional |Which order will it have in relation to the other skeletons. Having a lower number means a higher priority. -For instance, if you have two skeletons, "Skeleton a" with weight "10" and "Skeleton b" with weight "0", then "Skeleton b" will be first when ordering. +For instance, if you have two skeletons, 'Skeleton A' with weight '10' and 'Skeleton B' with weight '0', then 'Skeleton B' displays first when ordering. |Description |Optional @@ -150,7 +156,7 @@ For instance, if you have two skeletons, "Skeleton a" with weight "10" and "Skel |image:action_preview.png[Preview icon] |Preview -|To see how it's shown in the frontend to participants. +|To preview the display in the front end to participants. |image:action_list.png[Manage projects icon] |xref:_manage_projects[Manage projects] @@ -158,10 +164,10 @@ For instance, if you have two skeletons, "Skeleton a" with weight "10" and "Skel |image:action_edit.png[Edit icon] |Edit -|Edit form for a skeleton. It's the same form as "New skeleton". +|Edit form for a skeleton. It is the same form as 'New skeleton'. |image:action_delete.png[Delete icon] |Delete -|To delete this skeleton. Only can be done when there aren't any projects. +|To delete this skeleton. You can only do this when no projects exist. |=== diff --git a/docs/en/modules/admin/pages/components/sortitions.adoc b/docs/en/modules/admin/pages/components/sortitions.adoc index 8be4473e8d..721a8a8fb9 100644 --- a/docs/en/modules/admin/pages/components/sortitions.adoc +++ b/docs/en/modules/admin/pages/components/sortitions.adoc @@ -1,3 +1,3 @@ = Sortitions -The Sortitions component allows to select a number of proposals (e.g. candidates for a jury) with random, yet reproducible, procedures that guarantees non-biased and uniform distributions. +The Sortitions component allows to select a number of proposals - for example candidates for a jury - with random, yet reproducible, procedures that guarantees non-biased and uniform distributions. diff --git a/docs/en/modules/admin/pages/components/surveys.adoc b/docs/en/modules/admin/pages/components/surveys.adoc index 5a0cb85ede..8edb59e2fe 100644 --- a/docs/en/modules/admin/pages/components/surveys.adoc +++ b/docs/en/modules/admin/pages/components/surveys.adoc @@ -1,36 +1,42 @@ = Survey The Survey component allows people to answer questionnaires. This is useful when an organization wants to receive private -feedback, although it's possible to publish the answers manually as well. It allows defining a set of questions with multiple kinds of answers. +feedback, although it is possible to publish the answers manually as well. It allows defining a set of questions with multiple kinds of answers. From this starting point, there could be other configurations, such as: -* if the answering is limited to a time period -* what answer types should have the questions, like short (one line), long (multiple lines), single or multiple options, +* if you want to limit the answering to a fixed duration +* the answer types expected for the questions, like short - one line, long - multiple lines, single or multiple options, sorting through a list, etc. -* if there's an answer validation like how many characters as maximum should have an answer +* if there's an answer validation, like the maximum number of characters in an answer * if there's a maximum number of options to select in multiple options questions -Some examples of where this component was used: +Some examples of this component in use include: -* https://consultation.quebec.ca/processes/donneesquebec/f/82/[Data Quebec: participate in its improvement! (Données Québec : participez à son amélioration!) in Québec consultations] +pass:[] + +// The non-English text here throws a spelling error, so turning off Vale for this section. + +* https://consultation.quebec.ca/processes/donneesquebec/f/82/[Data Quebec: participate in its improvement(Données Québec : participez à son amélioration!) in Québec consultations] * https://meta.decidim.org/conferences/decidimfest2020/f/1403/?locale=en[DecidimFest2020 Assessment Survey] +pass:[] + image:components/surveys/example01.png[Example of a survey] To configure the Survey component: -. Sign in as admin -. Go to admin panel +. Sign in as an administrator +. Go to the administrator panel . In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies" or "Conferences". +For instance, it could be 'Processes', 'Assemblies' or 'Conferences'. . Go to components -. Click on "Add component" button -. Click on "Survey" +. Click on 'Add component' button +. Click on 'Survey' . Fill the xref:_add_component[Add component] form -Once a survey is already answered by some users it's not possible to modify its questions, as that would affect the integrity -of the answers. If it's needed to modify the questions, then it's needed to create a new survey and unpublish the original one. +Once a survey is already answered by some users it is not possible to modify its questions, as that would affect the integrity +of the answers. If you need to modify the questions, then you should create a new survey and un-publish the original one. == Add component @@ -42,12 +48,12 @@ image:components/surveys/component.png[Add component form] |Name |Required -|What is the title of this component. For instance, "Surveys" +|What is the title of this component. For instance, 'Surveys' |Order position |Optional -|Which order will it have in relation to the other surveys. Having a lower number means a higher priority. -For instance, if you have two surveys, "Survey a" with weight "10" and "Survey b" with weight "0", then "Survey b" will be first when ordering. +|Which order it has in relation to the other surveys. Having a lower number means a higher priority. +For instance, if you have two surveys, 'Survey A' with weight '10' and 'Survey B' with weight '0', then 'Survey B' displays first when ordering. |=== @@ -57,7 +63,7 @@ For instance, if you have two surveys, "Survey a" with weight "10" and "Survey b |Scopes enabled |Optional -|Check if you want to have Scopes filtering in this component. +|Select if you want to have Scopes filtering in this component. |Scope |Optional @@ -72,15 +78,15 @@ For instance, if you have two surveys, "Survey a" with weight "10" and "Survey b |Announcement |Optional -|A general announcement that'll be visible on the general surveys landing page. +|A general announcement visible on the general surveys landing page. |Delete answers when publishing the survey |Optional -|Check if you want to delete answers in the moment that the survey is published. Useful for when you want to test the survey before publishing it. +|Select if you want to delete answers when the survey is published. Useful for when you want to test the survey before publishing it. |=== -In the cases where the space that this component will be used has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in +In the cases where the space using the component has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in xref:admin:spaces/processes.adoc[Participatory Processes], then you can also define different behaviors per Step. .Add component: Surveys form - Step settings @@ -89,35 +95,34 @@ xref:admin:spaces/processes.adoc[Participatory Processes], then you can also def |Allow answers |Optional -|Check if you want to receive answers in this survey. +|Select if you want to receive answers in this survey. |Allow unregistered users to answer the survey |Optional -|If active, no login will be required in order to answer the survey. This may lead to poor or unreliable data and it will -be more vulnerable to automated attacks. Use with caution! Mind that this option only allows an answer by browser session, -but participants can use the Private navigation option and make multiple answers with the same device. +|If selected, login is not required to answer the survey. This may lead to poor or unreliable data and is more vulnerable to automated attacks. Use with caution. Be aware that this option only allows one answer per browser session, +but participants could use incognito mode and make multiple answers with the same device. |Announcement |Optional -|A general announcement that'll be visible on the general survey landing page. +|A general announcement visible on the general survey landing page. |=== == Permissions -An administrator can choose which kind of xref:customize:authorizations.adoc[Authorizations] a participant need to have to make +An administrator can choose which kind of xref:customize:authorizations.adoc[Authorizations] a participant need to have to take certain actions in the surveys: * Answer == New survey form -When you create a new survey you'll need to fill the form with the following fields: +When you create a new survey, fill in the form with these fields: image:components/surveys/edit_form.png[Edit survey form] NOTE: Do you have repetitive surveys? For instance the same feedback form for every process? You can have a survey that -gets copied and is used as a blueprint for so you don't have to manually configure the same survey everytime. Learn more +gets copied and becomes a blueprint, so you do not have to manually configure the same survey every time. Learn more about xref:_templates[Templates]. .New survey form @@ -126,7 +131,7 @@ about xref:_templates[Templates]. |Title |Required -|What is the title of this survey. For instance, "Feedback" +|What is the title of this survey. For instance, 'Feedback' |Description |Optional @@ -134,17 +139,17 @@ about xref:_templates[Templates]. |Terms of service |Required -|Legal conditions that the participants must agree to in order to answer the survey. +|Legal conditions that the participants must abide by to answer the survey. |=== -In the bottom of this form there's a button that allows you to "Add question". +In the bottom of this form there's a button that allows you to 'Add question'. image:components/surveys/add_question_button.png[] -You can add multiple questions per survey, and reorder or delete them. It's possible to also add separators between questions. +You can add multiple questions per survey, and reorder or delete them. It is possible to also add separators between questions. -Every question has to have a statement and a type as a minimum. +Every question must have a statement and a type as a minimum. image:components/surveys/question_form.png[] @@ -154,19 +159,19 @@ image:components/surveys/question_form.png[] |Statement |Required -|The question itself. For instance, "What is your age category?" +|The question itself. For instance, 'What is your age category?' |Description |Optional -|Explanation of the question being made. +|Explanation of the question. |Mandatory |Optional -|Check if this question is required to respond to submit the answer. +|Select if this is a mandatory question. |Character limit |Optional -|How many characters has as a maxim the answer to this question. Leave to 0 if no limit. Compatible with Short and Long answer question types. +|The maximum number of characters available in an answer to this question. Leave at 0 if no limit. Compatible with Short and Long answer question types. |Type |Required @@ -175,8 +180,8 @@ or Matrix (Multiple option). See xref:_question_types[Question types] for more i |=== -Depending in the question type, it's possible to add validations to the answers, like if the question is mandatory (participants -would need to provide an answer in order to submit the form) or if the answer is limited to a certain number of characters as maximum in +Depending in the question type, it is possible to add validations to the answers, like if the question is mandatory - participants +would need to provide an answer to submit the form - or if the answer should have a certain number of characters as a maximum in short and long answers. image:components/surveys/question_form_limits_backend.png[] @@ -196,64 +201,63 @@ A survey can have multiple questions with different types, such as: - Matrix (Single option) - Matrix (Multiple option) -.Question types (click to view image in detail) +.Question types - click to view image in detail |=== |Type|Frontend |Backend |Description |Short answer |image:components/surveys/type_short_answer_frontend.png[Short answer type - frontend,link=../_images/components/surveys/type_short_answer_frontend.png] |image:components/surveys/type_short_answer_backend.png[Short answer type - backend,link=../_images/components/surveys/type_short_answer_backend.png] -|Compatible with "Character limit" validation +|Compatible with 'Character limit' validation |Long answer |image:components/surveys/type_long_answer_frontend.png[Long answer type - frontend,link=../_images/components/surveys/type_long_answer_frontend.png] |image:components/surveys/type_long_answer_backend.png[Long answer type - backend,link=../_images/components/surveys/type_long_answer_backend.png] -|Compatible with "Character limit" validation +|Compatible with 'Character limit' validation |Single option |image:components/surveys/type_single_option_frontend.png[Single option type - frontend,link=../_images/components/surveys/type_single_option_frontend.png] |image:components/surveys/type_single_option_backend.png[Single option type - backend,link=../_images/components/surveys/type_single_option_backend.png] -|Participants will have to choose a single option, with radio buttons. At least 2 options always. It's possible to define a "Free text" option, so participants can submit their own answer. +|Participants have to choose a single option, with radio buttons. Must always have at least 2 options. It is possible to define a 'Free text' option, so participants can submit their own answer. |Multiple option |image:components/surveys/type_multiple_option_frontend.png[Multiple option type - frontend,link=../_images/components/surveys/type_multiple_option_frontend.png] |image:components/surveys/type_multiple_option_backend.png[Multiple option type - backend,link=../_images/components/surveys/type_multiple_option_backend.png] -|Participants will have to choose multiple options, with checkboxes. At least 2 options always. It's possible to add a validation, with the maximum number of choices. It's possible to define a "Free text" option, so participants can submit their own answer. +|Participants have to choose multiple options, with checkboxes. Must always have at least 2 options. It is possible to add a validation, with the maximum number of choices. It is possible to define a 'Free text' option, so participants can submit their own answer. |Sorting |image:components/surveys/type_sorting_frontend.png[Sorting type - frontend,link=../_images/components/surveys/type_sorting_frontend.png] |image:components/surveys/type_sorting_backend.png[Sorting type - backend,link=../_images/components/surveys/type_sorting_backend.png] -|At least 2 options always. Participants will click in order of preference to sort. +|Must always have at least 2 options. Participants click in order of preference to sort. |Files |image:components/surveys/type_files_frontend.png[Files type - frontend,link=../_images/components/surveys/type_files_frontend.png] |image:components/surveys/type_files_backend.png[Files type - backend,link=../_images/components/surveys/type_files_backend.png] -|Participants will be able to upload files. +|Participants can upload files. |Matrix (Single option) |image:components/surveys/type_matrix_single_option_frontend.png[Matrix (Single option) type - frontend,link=../_images/components/surveys/type_matrix_single_option_frontend.png] |image:components/surveys/type_matrix_single_option_backend.png[Matrix (Single option) type - backend,link=../_images/components/surveys/type_matrix_single_option_backend.png] -|Participants will have to choose between rows and columns of single options, with radio buttons. +|Participants have to choose between rows and columns of single options, with radio buttons. |Matrix (Multiple option) |image:components/surveys/type_matrix_multiple_option_frontend.png[Matrix (Multiple option) type - frontend,link=../_images/components/surveys/type_matrix_multiple_option_frontend.png] |image:components/surveys/type_matrix_multiple_option_backend.png[Matrix (Multiple option) type - backend,link=../_images/components/surveys/type_matrix_multiple_option_backend.png] -|Participants will have to choose between rows and columns of multiple options, with checkboxes. +|Participants have to choose between rows and columns of multiple options, with checkboxes. |=== == Templates -For the cases where administrators need to define multiple surveys that are mostly the same but used in different contexts, -it's possible to define a template. When there's one defined for a survey, then it'll ask to select the Template and create -the survey based on this one or in the other hand if there's no need to use a template, then it's possible to Skip the template +For cases where administrators need to define multiple surveys that are mostly the same but used in different contexts, +it is possible to define a template. When there is one defined for a survey, then it asks you to select the Template and create +the survey based on this one, or if there is no need to use a template, then it is possible to skip the template selection. image:components/surveys/edit_questionnaire.png[Choose template form] == Export answers -It's possible to export the survey participant answers to different formats: CSV, JSON, XLSX (Excel) or PDF. +It is possible to export the survey participant answers to different formats - CSV, JSON, XLSX (Excel) or PDF. -Note that the platform doesn't handle the answers processing nor presenting results or summary to the users, that need to be -done externally. +Note that the platform does not handle the answer processing nor presenting results or summaries to the users, you need to do that externally. diff --git a/docs/en/modules/admin/pages/features/badges.adoc b/docs/en/modules/admin/pages/features/badges.adoc index 9d4b6ac620..1564a7c489 100644 --- a/docs/en/modules/admin/pages/features/badges.adoc +++ b/docs/en/modules/admin/pages/features/badges.adoc @@ -1,9 +1,9 @@ = Badges -Badges are recognitions to participant actions and progress in the platform. As participants start discovering, participating -and interacting in the platform, they will earn different badges. Here is the list of badges and some ways participants can earn them. +Badges are recognitions to participant actions and progress in the platform. As participants start discovering, participating, +and interacting in the platform, they earn different badges. Here is the list of badges and some ways participants can earn them. -It's a https://en.wikipedia.org/wiki/Gamification[gamification] mechanism to improve the engagement of the participants in a ludic way. +It is a https://en.wikipedia.org/wiki/Gamification[gamification] mechanism to improve the engagement of the participants in a playful way. The badges a participant has are visible in her account. There's also a general explanation page with a short description of every badge. @@ -19,13 +19,13 @@ the fourth level at 60 and the fifth level at 100. .Badges |=== -|Image | Title | Description | How it's earned | Levels +|Image | Title | Description | How to earn | Levels |image:features/badges/accepted_proposals_badge.png[Accepted proposals badge] |Accepted proposals -|Granted when particiapnts actively participate with new proposals and these are accepted. +|Granted when participants actively participate with new proposals which become accepted. |The participant needs to choose the participation space of her interest with submission for proposals enabled and try to -make proposals that can be carried out. This way they are more likely to be accepted. +make proposals that meet the required criteria for acceptance. This way, acceptance is more likely. |1, 5, 15, 30, 50 |image:features/badges/attended_meetings_badge.png[Attended meetings badge] @@ -43,22 +43,21 @@ make proposals that can be carried out. This way they are more likely to be acce |image:features/badges/followers_badge.png[Followers badge] |Followers |Granted when participant reach a certain number of followers. The platform is a social and political network, so -participants ned to weave their web to communicate with other people in the platform. -|The participant needs to be be active and follow other people. That will surely make other people follow her. +participants need to engage and communicate with other people in the platform. +|The participant needs to be active and follow other people. That surely encourages others to follow her. |1, 15, 30, 60, 100 |image:features/badges/published_initiatives_badge.png[Published initiatives badge] |Published initiatives |Granted when a participant launch new initiatives, partnering with others to carry them out. -|The participant needs to go to the participation space of Intiatives and follow the steps to create a new initiative. +|The participant needs to go to the participation space of initiatives and follow the steps to create a new initiative. |1, 5, 15, 30, 50 |image:features/badges/invitations_badge.png[invitations badge] |Invitations |Granted when participants invite some people and they have become participants. |The participant needs to use the “invite friends” link on her user page to invite her friends. She can customize the -message she's sending. She’ll level up by sending invitations and getting them registered. Note that this feature is disabled -and this badge is not available, so it'll be removed in the future. +message she's sending. She'll level up by sending invitations and getting them registered. Note that Decidim now does not allow sending invitations and this badge is not available, with removal planned in the future. |1, 5, 10, 30, 50 |image:features/badges/proposal_supports_badge.png[Proposal supports badge] @@ -70,7 +69,7 @@ and this badge is not available, so it'll be removed in the future. |image:features/badges/proposals_badge.png[Proposals badge] |Proposals |Granted when participants actively participate with new proposals. -|The participant needs to choose the participation space of her interest with submission for proposals enabled and create a new proposal. +|The participant needs to choose the participation space of her interest with submission for proposals enabled, and create a new proposal. |1, 5, 10, 30, 60 |=== diff --git a/docs/en/modules/admin/pages/features/comments.adoc b/docs/en/modules/admin/pages/features/comments.adoc index 83a8fe2091..c5d3ff9c8d 100644 --- a/docs/en/modules/admin/pages/features/comments.adoc +++ b/docs/en/modules/admin/pages/features/comments.adoc @@ -8,57 +8,57 @@ image:features/comments/example01.png[Comments example] == Create a comment . Sign in as a participant -. Go to the content that you want to leave a comment +. Go to the content where you want to leave a comment . Go to the bottom of the page -. Fill the "Add comment" form +. Fill in the 'Add comment' form -Depending on the component settings, this feature can be disabled. +Depending on the component settings, you can turn off this feature. image:features/comments/form.png[Comments form] === Form -It's possible to: +It is possible to: -. mention a participant or user group (like @admin). They'll receive a notification -. add a hashtag (like #Example). This will link to the general search -. make a quote of a comment (like > this is a quote) -. if an URL is entered, then it'll be linked automatically -image:features/comments/rich_text_write.png[Comments with rich text (write)] -image:features/comments/rich_text_read.png[Comments with rich text (read)] +. mention a participant or user group - like @admin. They receive a notification +. add a hashtag - like #Example. This links to the general search for that hashtag +. make a quote of a comment - like > this is a quote +. if you enter a URL, it hyperlinks automatically +image:features/comments/rich_text_write.png[Comments with rich text - write] +image:features/comments/rich_text_read.png[Comments with rich text - read] image:features/comments/hashtag_search.png[Hashtags in comments] -. if HTML is added, it'll be escaped and not shown -image:features/comments/xss_write.png[XSS in comments (write)] -image:features/comments/xss_read.png[XSS in comments (read)] +. if you add HTML, the editor escapes it and it is not shown +image:features/comments/xss_write.png[XSS in comments - write] +image:features/comments/xss_read.png[XSS in comments - read] . add emojis to comments image:features/comments/emoji_selector.png[Emoji selector in comments] == Sort -Comments can be sorted by "Best rated", "Recent", "Older" or "More discussed". +You can sort comments by 'Best rated', 'Recent', 'Older' or 'More discussed'. image:features/comments/order_by.png[Order comments] == Actions -After a comment is created, the author can "Reply", "Report", "Get link", "Edit" and "Delete". Other participants can "Reply", "Report" and "Get link". Some of these actions are visible in the three dots menu: +After you create a comment, the author can 'Reply', 'Report', 'Get link', 'Edit' and 'Delete'. Other participants can 'Reply', 'Report' and 'Get link'. Some of these actions are visible in the three dots menu: image:features/comments/actions.png[Comments actions] === Reply -It's possible to reply to comments until the 4th anidation level. +It is possible to reply to comments until the fourth nested level. -image:features/comments/anidation_levels.png[Anidation levels for comments] +image:features/comments/nested_levels.png[Nested levels for comments] === Delete -Once a comment is deleted is not longer visible. +Once you delete a comment, it is not longer visible. image:features/comments/deleted_comment.png[Deleted comment] === Edit -Once a comment is edited then it's shown that was edited. It doesn't have a version history of the changes made. +Once you edit a comment then the user interface displays 'edited'. It does not have a version history of the changes made. image:features/comments/edited_comment.png[Edited comment] diff --git a/docs/en/modules/admin/pages/features/conversations.adoc b/docs/en/modules/admin/pages/features/conversations.adoc index 2e2f286e6b..ec7d40e130 100644 --- a/docs/en/modules/admin/pages/features/conversations.adoc +++ b/docs/en/modules/admin/pages/features/conversations.adoc @@ -3,7 +3,7 @@ With conversations, participants can have private messaging with each other. Only the participants who are in the conversation can see each others messages. -A conversation can be started with any participant or group registered on the platform. +You can start a conversation with any participant or group registered on the platform. image:features/conversations/conversation.png[Example of a conversation] @@ -13,38 +13,38 @@ To start a conversations: . Go to the participant profile that you want to start a conversation with image:features/conversations/profile.png[Participant profile] . Click on the contact icon image:icon_envelope.png[Envelope icon] -. Fill the form +. Fill in the form image:features/conversations/start_a_conversation_form.png[Start a conversation form] Alternatively, you could also: . Sign in as participant . Click on the conversation icon in the header image:icon_envelope_off.png[Conversations icon] -. Click on the "Start conversation" button +. Click on the 'Start conversation' button . Search the participant or group that you want to start a conversation with -. Fill the form +. Fill in the form -If there are new messages in a conversation, then the participant will see the icon with a color image:icon_envelope_on.png[Conversation icon with color] +If there are new messages in a conversation, then the participant sees the icon with a highlight image:icon_envelope_on.png[Conversation icon with highlight] image:features/conversations/conversations.png[Conversations list] == Multiple participants in a conversation -It's possible to have multiple participants in a conversation. +It is possible to have multiple participants in a conversation. For this, you need to: . Sign in as participant . Click on the conversation icon in the header image:icon_envelope_off.png[Conversations icon] -. Click on the "Start conversation" button +. Click on the 'Start conversation' button . Search the participants or groups that you want to start a conversation with -. Fill the form +. Fill in the form image:features/conversations/new_conversation_modal.png[New conversation modal] -== Group converations +== Group conversations -Just like with participants, is possible to have converstaions with groups. +Just like with participants, is possible to have conversations with groups. image:features/conversations/group_conversations.png[Group conversations list] image:features/conversations/conversations_group_counter.png[Conversations group counter] @@ -53,5 +53,5 @@ image:features/conversations/conversations_group_counter.png[Conversations group Some things to consider about conversations: -* It's not possible to delete a conversation. -* It's not possible to edit a message in a conversation. +* It is not possible to delete a conversation. +* It is not possible to edit a message in a conversation. diff --git a/docs/en/modules/admin/pages/features/embed.adoc b/docs/en/modules/admin/pages/features/embed.adoc index f83d8171b6..84c5e8aeba 100644 --- a/docs/en/modules/admin/pages/features/embed.adoc +++ b/docs/en/modules/admin/pages/features/embed.adoc @@ -2,7 +2,7 @@ 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] +image:features/embed/example.png[A proposal card embedded in another page] == How to embed @@ -11,7 +11,7 @@ image:features/embed/example.png[A proposal card embeded in another page] 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 +. Paste that code in the external page where you want to embed it. The CMS or platform that you're using needs to support changing HTML code. An example of this code is: diff --git a/docs/en/modules/admin/pages/features/endorsements.adoc b/docs/en/modules/admin/pages/features/endorsements.adoc index 4522cd073d..7faba2a2e1 100644 --- a/docs/en/modules/admin/pages/features/endorsements.adoc +++ b/docs/en/modules/admin/pages/features/endorsements.adoc @@ -4,7 +4,7 @@ Through endorsements, participants can publicly show that they want to support a image:features/endorsements/list.png[List of endorsements] -This is done through the button in the sidebar. Administrators can enable or disable them by step in a given participatory process, and they can also define permissions with authorizations. +You accomplish this through the button in the sidebar. Administrators can enable or turn off endorsements by step in a given participatory process, and they can also define permissions with authorizations. image:features/endorsements/sidebar.png[Endorsement button in sidebar] @@ -12,6 +12,6 @@ When a participant belongs to a verified group she can also endorse like that gr image:features/endorsements/modal.png[Select identity modal] -By default the endorsements list is collapsed. To see it fully visitors need too click in the "(see more)" link. +The endorsements list displays collapsed by default. To see it fully visitors need to click the 'see more' link. image:features/endorsements/full_list.png[Full list of endorsements] diff --git a/docs/en/modules/admin/pages/features/fingerprint.adoc b/docs/en/modules/admin/pages/features/fingerprint.adoc index ec15142998..c08227cf86 100644 --- a/docs/en/modules/admin/pages/features/fingerprint.adoc +++ b/docs/en/modules/admin/pages/features/fingerprint.adoc @@ -1,27 +1,27 @@ = Fingerprint -Although the platform should show the xref:admin:features/versions.adoc[Versions] for almost all of the contents, it'd be +Although the platform should show the xref:admin:features/versions.adoc[Versions] for almost all of the content, it would be still possible to manipulate the content by directly editing the database. As mitigation for this risk, the platform shows a fingerprint for some important fields, for instance, a proposal body and title. image:features/fingerprint/modal.png[Check fingerprint modal] -Its goal is to provide a way to give an informal "receipt" to a participant to they can detect tampering. A fingerprint is -a hashed representation of the content. It's useful to ensure the content hasn't been tampered with, as a single modification -would result in a totally different value. It's calculated using a SHA256 hashing algorithm. In order to replicate it +Its goal is to provide a way to give an informal 'receipt' to a participant to they can detect tampering. A fingerprint is +a hashed representation of the content. It is useful to ensure there has been no tampering with content, as a single modification +would result in a totally different value. A SHA256 hashing algorithm calculates the fingerprint. In order to replicate it yourself, you can use a http://www.md5calc.com/sha256[MD5 calculator online] and copy-paste the source data. == Check fingerprint -. Go to the content that you want to check the fingerprint -. Click in the "Check fingerprint" link in the sidebar +. Go to the content that you want to verify the fingerprint for +. Click on the 'Check fingerprint' link in the sidebar image:features/fingerprint/sidebar.png[Check fingerprint link in sidebar] . Follow the modal instructions image:features/fingerprint/md5calc.png[MD5calc.com screenshot] -It's possible to check the fingerprint with other tools, such as the sha256sum command line tool. +It is possible to verify the fingerprint with other tools, such as the sha256sum command line tool. [source,bash] ---- diff --git a/docs/en/modules/admin/pages/features/follows.adoc b/docs/en/modules/admin/pages/features/follows.adoc index 1a5ad94eda..3e0cbbd819 100644 --- a/docs/en/modules/admin/pages/features/follows.adoc +++ b/docs/en/modules/admin/pages/features/follows.adoc @@ -1,7 +1,7 @@ = Follows -Most of the contents in Decidim allows to be followed. This means that you'll receive xref:features/notifications.adoc[notifications] -of the activity being made by the thing you're following. +Most of the content in Decidim allows users to follow updates. This means that you receive xref:features/notifications.adoc[notifications] +of the activity from the thing you're following. You can control these notifications in the xref:features/my_account/notifications_settings.adoc[settings of your account]. @@ -10,18 +10,18 @@ The activity of the things that you're following is visible in your xref:feature For following a thing: . Navigate to whatever you want to follow. -. Click in the "Follow" button. +. Click on the 'Follow' button. image:button_follow.png[Follow button] -. You'll see the "Follow" button disappear and the "Stop following" button appear. +. You will see the 'Follow' button disappear and the 'Stop following' button appear. -To unfollow a thing: +To un-follow a thing: -. Navigate to whatever you want to unfollow. -. Click in the "Stop following" button. +. Navigate to whatever you want to un-follow. +. Click on the 'Stop following' button. image:button_stop_following.png[Stop following button] -. You'll see the "Stop following" button disappear and the "Follow" button appear. +. You will see the 'Stop following' button disappear and the 'Follow' button appear. -Administrators by default follow all the new spaces that are created in the Decidim platform. +Administrators by default follow all the new spaces created in the Decidim platform. -A participant can also follow another participants. This is public and it's visible in the profile sections +A participant can also follow another participants. This is public and it is visible in the profile sections xref:features/my_public_profile/follows.adoc[follows] and xref:features/my_public_profile/followers.adoc[followers]. diff --git a/docs/en/modules/admin/pages/features/hashtags.adoc b/docs/en/modules/admin/pages/features/hashtags.adoc index 2ecbf6ea61..87ef97b8f7 100644 --- a/docs/en/modules/admin/pages/features/hashtags.adoc +++ b/docs/en/modules/admin/pages/features/hashtags.adoc @@ -1,5 +1,5 @@ = Hashtags -Hashtags are a way to categorize content globally on the platform and make it more easily searchable through these categorizations. It allows different related contents to be easily discoverable under the same topic. Similar functionality is often used in other social media platforms. +Hashtags are a way to categorize content globally on the platform and make it more searchable through these categorizations. It allows different, but related, content to be discoverable under the same topic. Similar features are often used in other social media platforms. -Hashtags can be set for different records within the platform, such as participatory spaces. They can also be generated for content created by the participants to allow easier discovery of the content. Some components may also allow setting suggested hashtags or specific hashtags for all records submitted by the participants. +You can set hashtags can for different records within the platform, such as participatory spaces. You can also generate them for content created by the participants to allow easier discovery of the content. Some components may also allow setting suggested hashtags or specific hashtags for all records submitted by the participants. diff --git a/docs/en/modules/admin/pages/features/metrics.adoc b/docs/en/modules/admin/pages/features/metrics.adoc index a9b2f4fa86..dabc3ef6dd 100644 --- a/docs/en/modules/admin/pages/features/metrics.adoc +++ b/docs/en/modules/admin/pages/features/metrics.adoc @@ -2,14 +2,14 @@ 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]. +With Metrics, participants can see the evolution in time of some resources, such as proposals, supports, endorsements, followers, participants, accepted proposals, 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). +For this to work, it needs to be first xref:develop:metrics.adoc[configured technically], and also turned on by the setting in the participatory space - 'Show metrics' checkbox. -Then this section will be visible in the space landing page. +Then this section is 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. +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/features/my_account.adoc b/docs/en/modules/admin/pages/features/my_account.adoc index 0d30d38de3..29c9bb2fc8 100644 --- a/docs/en/modules/admin/pages/features/my_account.adoc +++ b/docs/en/modules/admin/pages/features/my_account.adoc @@ -1,12 +1,14 @@ = My account -My account is all the pages where a participant can change her personal data that is displayed in her xref:admin:features/my_public_profile.adoc[My public profile] page, change her notifications settings, see which groups she belongs, etc. +pass:[] + +My account is all the pages where a participant can change the display of her personal data that in her xref:admin:features/my_public_profile.adoc[My public profile] page, change her notifications settings, see which groups she belongs, etc. To go to this section: . Sign in as a participant -. Click in the name of the participant in the header -. Click in "My account" +. Click on the name of the participant in the header +. Click on 'My account' The actions that she can do are: @@ -17,3 +19,5 @@ The actions that she can do are: * xref:admin:features/my_account/my_interests.adoc[My interests] * xref:admin:features/my_account/my_data.adoc[My data] * xref:admin:features/my_account/delete_my_account.adoc[Delete my account] + +pass:[] diff --git a/docs/en/modules/admin/pages/features/my_account/account.adoc b/docs/en/modules/admin/pages/features/my_account/account.adoc index 095e4e3c4a..1e6bd94902 100644 --- a/docs/en/modules/admin/pages/features/my_account/account.adoc +++ b/docs/en/modules/admin/pages/features/my_account/account.adoc @@ -1,21 +1,26 @@ = Account -In this section is possible to make modifications that will be visible in the participants xref:features/my_public_profile.adoc[public profile] and also modify the email address or the language that the platform will use with the user. +In this section is possible to make modifications visible in the participants xref:features/my_public_profile.adoc[public profile], and also modify the account email address or the language of the platform. + +pass:[] . Sign in as a participant -. Click in the name of the participant in the header -. Click in "My account" +. Click on the name of the participant in the header +. Click on 'My account' image:features/my_account/account.png[My account form] .Participant settings - My account form + +pass:[] + |=== |Field |Type |Description |Avatar |Optional -|Avatar or picture for the participant. Guidance for image: Preferrably a landscape image that does not have any text. -The service crops the image. Maximum file size: 5MB +|Avatar or picture for the participant. Guidance for image: Preferably a landscape image that does not have any text. +The service crops the image. Maximum file size: 5 Mb |Your name |Required @@ -27,16 +32,15 @@ The service crops the image. Maximum file size: 5MB |Your email |Required -|The email of the participant, where she'll receive notifications, password recovery, etc. If it's changed it needs to be -confirmed. +|The email of the participant, where she'll receive notifications, password recovery, etc. If changed, the email address must be re-confirmed. |Personal URL |Optional -|Metadata that is displayed in the participant's profile. +|Metadata displayed in the participant's profile. |About |Optional -|Metadata that is displayed in the participant's profile. +|Metadata displayed in the participant's profile. |Locale |Required diff --git a/docs/en/modules/admin/pages/features/my_account/authorizations.adoc b/docs/en/modules/admin/pages/features/my_account/authorizations.adoc index a34efaf2ad..7c147aa975 100644 --- a/docs/en/modules/admin/pages/features/my_account/authorizations.adoc +++ b/docs/en/modules/admin/pages/features/my_account/authorizations.adoc @@ -1,23 +1,30 @@ = Authorizations -In this section participants will be able to review their Authorizations and see some metadata, like when it was granted -or the status of the authorization. +In this section participants can review their Authorizations and see some metadata, including the granted date for authorizations or the status of the authorization. -It depends on how it's configured for the organization, as depending in the context (like normative or laws) it could work +pass:[] + +It depends on how the organization has configured Authorizations, as depending in the context - like regulations or laws - it could work in different ways. For more information about Authorizations see xref:admin:participants/authorizations.adoc[authorizations in admin manual] and xref:customize:authorizations.adoc[authorizations in customize guide]. +pass:[] + image:features/my_account/authorizations.png[Authorizations] To go to this section: +pass:[] + . Sign in as a participant -. Click in the name of the participant in the header -. Click in "My account" -. Click in "Authorizations" in the sidebar +. Click on the name of the participant in the header +. Click on 'My account' +. Click on 'Authorizations' in the sidebar + +pass:[] For any given authorization, you can see the following information: -* If it's not finished, when the authorization process started -* If it has finished and has been granted, the date when it was granted +* If it is not finished, when the authorization process started +* If it has finished and Authorization granted, the date granted * If the authorization provides it, some metadata, such as the scope of the authorization diff --git a/docs/en/modules/admin/pages/features/my_account/delete_my_account.adoc b/docs/en/modules/admin/pages/features/my_account/delete_my_account.adoc index fe2a6c0d94..1d389a1306 100644 --- a/docs/en/modules/admin/pages/features/my_account/delete_my_account.adoc +++ b/docs/en/modules/admin/pages/features/my_account/delete_my_account.adoc @@ -1,21 +1,25 @@ = Delete my account -In this section participants will be able to delete their own accounts. This means that they will be unable to access the system anymore. This action is irreversible. All the contributions will be anonymized. +In this section participants can delete their own accounts. When deleting an account, the user cannot access the system. This action is irreversible. All the contributions from the deleted user become anonymous. image:features/my_account/delete_my_account.png[Delete my account form] To delete the account: +pass:[] + . Sign in as a participant -. Click in the name of the participant in the header -. Click in "My account" -. Click in "Delete my account" in the sidebar +. Click on the name of the participant in the header +. Click on 'My account' +. Click on 'Delete my account' in the sidebar . Optionally, she can provide a reason for the deletion -. Click in "Delete my account" -. Click in "Yes, I want to delete my account" +. Click on 'Delete my account' +. Click on 'Yes, I want to delete my account' + +pass:[] image:features/my_account/delete_my_account_confirm.png[Confirm account deletion] -After the account has been deleted, the contributions (such as comments, proposals, etc), will be still visible but all the authorship information will be anonymized, belonging to an special kind of author called "Participant deleted": +After deleting the account, the contributions - such as comments, proposals, etc - are still visible but deletion of the account results in the removal of all the authorship information, with the contribution belonging to an author called 'Participant deleted', reserved for this purpose: image:features/my_account/delete_my_account_deleted.png[Deleted participant contribution] diff --git a/docs/en/modules/admin/pages/features/my_account/groups.adoc b/docs/en/modules/admin/pages/features/my_account/groups.adoc index c91b9ae83a..e0d2fb3a24 100644 --- a/docs/en/modules/admin/pages/features/my_account/groups.adoc +++ b/docs/en/modules/admin/pages/features/my_account/groups.adoc @@ -2,6 +2,8 @@ In this section participants can see which Groups they belong to. +pass:[] + NOTE: Want to create a new group? Go to the xref:admin:features/my_public_profile.adoc[My public profile] page. image:features/my_account/groups.png[Groups] @@ -9,10 +11,16 @@ image:features/my_account/groups.png[Groups] To go to this section: . Sign in as a participant -. Click in the name of the participant in the header -. Click in "My account" -. Click in "Groups" in the sidebar +. Click on the name of the participant in the header +. Click on 'My account' +. Click on 'Groups' in the sidebar + +pass:[] -Here you can see in which date the group was created and which status does it have (`pending` or `verified`). +Here you can see in which date the group was created and which status does it have - 'pending' or 'verified'. + +pass:[] Read more about xref:admin:participants/groups.adoc[Groups in admin manual]. + +pass:[] \ No newline at end of file diff --git a/docs/en/modules/admin/pages/features/my_account/my_data.adoc b/docs/en/modules/admin/pages/features/my_account/my_data.adoc index b2dfb09c69..f479e1cf90 100644 --- a/docs/en/modules/admin/pages/features/my_account/my_data.adoc +++ b/docs/en/modules/admin/pages/features/my_account/my_data.adoc @@ -2,22 +2,26 @@ In this section participants can request a file with all the data that they've provided to the platform. +pass:[] + image:features/my_account/my_data.png[My data] To request the data: . Sign in as a participant -. Click in the name of the participant in the header -. Click in "My account" -. Click in "My data" in the sidebar -. Click in "Request data" -. Wait a couple of minutes so the files are generated. It could depend in how many proposals, comments, etc you've made +. Click on the name of the participant in the header +. Click on 'My account' +. Click on 'My data' in the sidebar +. Click on 'Request data' +. Wait a couple of minutes for file generation. It could depend in how many proposals, comments, etc you've made . Go to your email account and find the received email -. Click in "Download" -. Open it with a support zip software +. Click on 'Download' +. Open it with a supported zip extraction software . Enter the password that you've received in the email . Unzip or extract the contents +pass:[] + image:features/my_account/my_data_email.png[My data] == Zip applications @@ -26,4 +30,4 @@ For opening the zip file, the software that you use need to support encryption w * Windows: https://www.7-zip.org/[7-Zip] * Mac: https://www.keka.io[Keka] -* GNU/Linux: File Roller (available through your package manager) or https://peazip.github.io/[PeaZip] +* GNU/Linux: File Roller - available through your package manager - or https://peazip.github.io/[PeaZip] diff --git a/docs/en/modules/admin/pages/features/my_account/my_interests.adoc b/docs/en/modules/admin/pages/features/my_account/my_interests.adoc index 44de673df7..f2d0b59310 100644 --- a/docs/en/modules/admin/pages/features/my_account/my_interests.adoc +++ b/docs/en/modules/admin/pages/features/my_account/my_interests.adoc @@ -1,15 +1,18 @@ = My interests -In this section participants can choose which interests they have to receive more information about. +In this section participants can choose which interests they want to receive more information about. -By default what they see here is a list of all the xref:admin:scopes.adoc[Scopes] of the organization. Those selections -can be used by administrators when segmenting for the xref:admin:newsletters.adoc[Newsletters]. +By default, what they see here is a list of all the xref:admin:scopes.adoc[Scopes] of the organization. Administrators can use those selections when segmenting for the xref:admin:newsletters.adoc[Newsletters]. + +pass:[] image:features/my_account/my_interests.png[My interests] To go to this section: . Sign in as a participant -. Click in the name of the participant in the header -. Click in "My account" -. Click in "My interests" in the sidebar +. Click on the name of the participant in the header +. Click on 'My account' +. Click on 'My interests' in the sidebar + +pass:[] diff --git a/docs/en/modules/admin/pages/features/my_account/notifications_settings.adoc b/docs/en/modules/admin/pages/features/my_account/notifications_settings.adoc index 2729a48cde..7dec5e4ec3 100644 --- a/docs/en/modules/admin/pages/features/my_account/notifications_settings.adoc +++ b/docs/en/modules/admin/pages/features/my_account/notifications_settings.adoc @@ -1,15 +1,17 @@ = Notifications -In this section participants can choose which kind of notifications they'll receive. For instance, depending in the activity of the installation and spaces, most people would want to disable the "Everything I follow" +pass:[] + +In this section participants can choose which kind of notifications they receive. For instance, depending on the activity of the installation and spaces, most people would want to turn off the 'Everything I follow' setting. image:features/my_account/notifications_settings.png[Notifications settings] To go to this section: . Sign in as a participant -. Click in the name of the participant in the header -. Click in "My account" -. Click in "Notifications settings" in the sidebar +. Click on the name of the participant in the header +. Click on 'My account' +. Click on 'Notifications settings' in the sidebar The options available are: @@ -21,6 +23,12 @@ The options available are: * Newsletters ** I want to receive newsletters * Receive direct messages from anyone -** Allow anyone to send me a direct message, even if I don't follow them +** Allow anyone to send me a direct message, even if I do not follow them * Administrators + +pass:[] + ** I want to receive an email every time something is reported for moderation + +pass:[] +pass:[] \ No newline at end of file diff --git a/docs/en/modules/admin/pages/features/my_public_profile.adoc b/docs/en/modules/admin/pages/features/my_public_profile.adoc index e9220e0b43..3a7f168262 100644 --- a/docs/en/modules/admin/pages/features/my_public_profile.adoc +++ b/docs/en/modules/admin/pages/features/my_public_profile.adoc @@ -4,9 +4,11 @@ Every participant has a public profile that shows details about them and their a To go to this section: +pass:[] + . Sign in as a participant -. Click in the name of the participant in the header -. Click in "My public profile" +. Click on the name of the participant in the header +. Click on 'My public profile' The sections available under the public profile are: @@ -16,3 +18,5 @@ The sections available under the public profile are: * xref:admin:features/my_public_profile/follows.adoc[Follows] * xref:admin:features/my_public_profile/followers.adoc[Followers] * xref:admin:features/my_public_profile/groups.adoc[Groups] + +pass:[] \ No newline at end of file diff --git a/docs/en/modules/admin/pages/features/my_public_profile/badges.adoc b/docs/en/modules/admin/pages/features/my_public_profile/badges.adoc index 03a4d5d292..33003c9916 100644 --- a/docs/en/modules/admin/pages/features/my_public_profile/badges.adoc +++ b/docs/en/modules/admin/pages/features/my_public_profile/badges.adoc @@ -1,5 +1,5 @@ = Badges -The public profile's badges shows which badges the participant has accumulated and what their current level is for each badge. +The public profile's badges shows the badges accumulated by the participant and what their current level is for each badge. More information about badges is available on the xref:admin:features/badges.adoc[Badges feature page]. diff --git a/docs/en/modules/admin/pages/features/my_public_profile/followers.adoc b/docs/en/modules/admin/pages/features/my_public_profile/followers.adoc index fc8c5e2e13..f3fc51cf31 100644 --- a/docs/en/modules/admin/pages/features/my_public_profile/followers.adoc +++ b/docs/en/modules/admin/pages/features/my_public_profile/followers.adoc @@ -1,3 +1,3 @@ = Followers -The followers section contains a list of participants and groups that are following the participant that the profile belongs to. +The followers section contains a list of participants and groups following the participant that the profile belongs to. diff --git a/docs/en/modules/admin/pages/features/my_public_profile/follows.adoc b/docs/en/modules/admin/pages/features/my_public_profile/follows.adoc index a34bea7794..6b66f7654a 100644 --- a/docs/en/modules/admin/pages/features/my_public_profile/follows.adoc +++ b/docs/en/modules/admin/pages/features/my_public_profile/follows.adoc @@ -1,3 +1,3 @@ = Follows -The follows section contains a list of participants and groups the participant is currently following. By following another participant or a group on the platform, the participant will receive notifications about the activity done by those other participants or groups on the platform. Some participants may also require that they need to be following the other participant before they can exchange private messages with each other. +The follows section contains a list of participants and groups the participant is currently following. By following another participant or a group on the platform, the participant receives notifications about the activity done by those other participants or groups on the platform. Some participants may also require mutual following before private messages may be exchanged with each other. diff --git a/docs/en/modules/admin/pages/features/my_public_profile/timeline.adoc b/docs/en/modules/admin/pages/features/my_public_profile/timeline.adoc index bcf0202273..391b5f5106 100644 --- a/docs/en/modules/admin/pages/features/my_public_profile/timeline.adoc +++ b/docs/en/modules/admin/pages/features/my_public_profile/timeline.adoc @@ -1,3 +1,3 @@ = Timeline -The timeline view displays the participants activity on the website, including the activity items that should be only visible to the participant currently logged in. This section is not visible to any other user than the participant themselves because it can also contain items that should be visible only to that participant. +The timeline view displays the participant's activity on the website, including the activity items that should be only visible to the participant currently logged in. This section is not visible to any other user than the participant themselves, because it can also contain items that should be visible only to that participant. diff --git a/docs/en/modules/admin/pages/features/my_public_profile/tmp_notifications.adoc b/docs/en/modules/admin/pages/features/my_public_profile/tmp_notifications.adoc index a46500bc3f..d4cd4b62fc 100644 --- a/docs/en/modules/admin/pages/features/my_public_profile/tmp_notifications.adoc +++ b/docs/en/modules/admin/pages/features/my_public_profile/tmp_notifications.adoc @@ -1,5 +1,5 @@ = Notifications -In this section participants can see the notifications that the system has sent to them. For instance, if the participant is followign a participatory space or a proposal, they get related notifications about the actions that happen in these sections of the platform. +In this section, participants can see notifications that the system has sent to them. For instance, if the participant is following a participatory space or a proposal, they get related notifications about the actions that happen in these sections of the platform. -This section can be accessed through the bell icon in the header bar of the platform. The bell icon shows highlighted as active when there are notifications and dimmer when there are no new notifications for the user right now. +The participant accesses this section through the bell icon in the header bar of the platform. The bell icon shows highlighted as active when there are notifications, and dimmer when there are no new notifications for the user at that time. diff --git a/docs/en/modules/admin/pages/features/notifications.adoc b/docs/en/modules/admin/pages/features/notifications.adoc index 24667ae054..23bf62ecc7 100644 --- a/docs/en/modules/admin/pages/features/notifications.adoc +++ b/docs/en/modules/admin/pages/features/notifications.adoc @@ -1,17 +1,17 @@ = Notifications -Most of the actions in the platform generate notifications so particpants can know when there are new things to watch. +Most of the actions in the platform generate notifications, so participants can know when there are new things to review. -This is accessible from the `Notifications` menu item (image:icon_bell.png[Notification icon]) in the header, after a participant has logged in. +This is accessible from the 'Notifications' menu item - image:icon_bell.png[Notification icon] - in the header, after a participant has logged in. To see the notifications: . Sign in as participant -. Click in the notifications icon in the header +. Click on the notifications icon in the header -If there are notifications, then the participant will see the icon with a color image:icon_bell_on.png[Notification icon with color] +If there are notifications, then the participant sees the icon highlighted image:icon_bell_on.png[Notification icon with highlight] image:features/notifications/notifications.png[Example of notifications page when there are notifications] -image:features/notifications/no_notifications_yet.png[Example of notifications page when there aren't notifications] +image:features/notifications/no_notifications_yet.png[Example of notifications page when there are no notifications] diff --git a/docs/en/modules/admin/pages/features/search.adoc b/docs/en/modules/admin/pages/features/search.adoc index 28558b6ff3..a2a24794f0 100644 --- a/docs/en/modules/admin/pages/features/search.adoc +++ b/docs/en/modules/admin/pages/features/search.adoc @@ -1,3 +1,3 @@ = Search engine -*The search engine* allows participants to perform searches across all of the platform’s indexable content, both generally and specifically, by searching within a specific participatory process or inside its components (proposals, results, etc.), through advanced searches. +*The search engine* allows participants to perform searches across all of the platform's index-able content, both generally and specifically, by searching within a specific participatory process or inside its components such as proposals, results, etc., through advanced searches. diff --git a/docs/en/modules/admin/pages/features/share.adoc b/docs/en/modules/admin/pages/features/share.adoc index 2a49818ee2..86757bd0ba 100644 --- a/docs/en/modules/admin/pages/features/share.adoc +++ b/docs/en/modules/admin/pages/features/share.adoc @@ -1,3 +1,3 @@ = Share -Different content on the platform can be easily shared through the share links available on the site. The share links allow easier sharing to different social media services that can be configured for Decidim through the configuration files. +You can share different content on the platform through the share links available on the site. The share links allow easier sharing to different social media services that you can configure for Decidim through the configuration files. diff --git a/docs/en/modules/admin/pages/features/statistics.adoc b/docs/en/modules/admin/pages/features/statistics.adoc index 1d8e48a2eb..61bbce58ef 100644 --- a/docs/en/modules/admin/pages/features/statistics.adoc +++ b/docs/en/modules/admin/pages/features/statistics.adoc @@ -1,3 +1,3 @@ = Statistics -Decidim provides general statistics about the whole platform and different participatory spaces can also provide statistics related to that participatory space only. These are generic numbers that indicate the website activity and may also encourage other people to join the platform as they see it being popular. +Decidim provides general statistics about the whole platform, and different participatory spaces can also provide statistics related to that participatory space only. These are generic numbers that indicate the website activity and may also encourage other people to join the platform as they see it being popular. diff --git a/docs/en/modules/admin/pages/features/versions.adoc b/docs/en/modules/admin/pages/features/versions.adoc index 053a6d25ff..2ed7b12f91 100644 --- a/docs/en/modules/admin/pages/features/versions.adoc +++ b/docs/en/modules/admin/pages/features/versions.adoc @@ -1,25 +1,25 @@ = Versions -The versions feature allows a visitor to see the evolution of the different versions of resources that can be edited, +The versions feature allows a visitor to see the evolution of the different versions of resources which are editable, like proposals or results. -With versions it's possible to see who made the change, when the change has been made and exactly what has changed. +With versions it is possible to see who made the change, when, and exactly what has changed. image:features/versions/side_by_side_escaped.png[Versions in resources] == See the versions . Go to the content that you want to see the version of. -. Click in the "see other versions" link in the sidebar +. Click on the 'see other versions' link in the sidebar. image:features/versions/sidebar.png[See other versions link in sidebar] -. Click in the past version that you want to see +. Click on the past version that you want to see. image:features/versions/list.png[List of versions] -. From there you can change the visualiation of the version differences -image:features/versions/unified_unescaped.png[Unified unescaped view] +. From there you can change the visualisation of the version differences. +image:features/versions/unified_unescaped.png[Unified un-escaped view] -It's possible to view the diffs of the versions in in two formats: side by side or unified. In case that the contents are -in HTML then it's also possible to see the diff unescaped and escaped, and see the full HTML code. +It is possible to view the diffs of the versions in two formats: side by side or unified. If the contents are +in HTML, then it is also possible to see the diff un-escaped and escaped, and see the full HTML code. -image:features/versions/side_by_side_unescaped.png[Side by side unescaped view] +image:features/versions/side_by_side_unescaped.png[Side by side un-escaped view] image:features/versions/unified_escaped.png[Unified escaped view] diff --git a/docs/en/modules/admin/pages/participants/authorizations/census.adoc b/docs/en/modules/admin/pages/participants/authorizations/census.adoc index b7e2cfbb9d..34281655da 100644 --- a/docs/en/modules/admin/pages/participants/authorizations/census.adoc +++ b/docs/en/modules/admin/pages/participants/authorizations/census.adoc @@ -2,33 +2,33 @@ The process is as follows: -. Admins upload a CSV with the emails of the accepted participants -. Participants go to its accounts and requests to be verified -. Only participants with an email in that CSV file can get verified +. Administrators upload a CSV with the emails of the accepted participants +. Participants go to their accounts and request verification +. Verification is only successful for participants with an email address matching the CSV file -NOTE: is this too simple and you need more features related to CSV census imports? -Check all the CSV or file based authorizations in our https://decidim.org/modules/[Modules page]. +NOTE: do you need more features related to CSV census imports? +Check all the CSV or file based authorizations in the https://decidim.org/modules/[Modules page]. == 1. An administrator uploads the CSV of the participants -In the admin panel, the administrator can review the request by going to the "Organization's census" in the "Participants" section. +In the administrator panel, the administrator can review the request by going to the 'Organization's census' in the 'Participants' section. image:authorizations_organization_census.png[Organization's census in admin panel] -After the CSV is imported then the administrator can see how many participants where imported. She can also delete this +After importing the CSV, the administrator can see how many participants where imported. She can also delete this imported census. image:authorizations_organization_census_imported.png[Imported CSV] -== 2. A participant requests to be verified +== 2. A participant requests verification -By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, -a participant can request to be verified. +By going to the authorization section in their profile, or by clicking on the action button if requesting this permission, +a participant can request verification. image:authorizations_organization_census_account.png[Organization's census in participant's accounts] -== 3. The participant is verified (or not) +== 3. A participant verification succeeds - or not -After is verified, as with other verifications, she can see it in her account settings. +After verification, as with other verifications, she can see it in her account settings. image:authorizations_organization_census_verified.png[Verified by organization's census] \ No newline at end of file diff --git a/docs/en/modules/admin/pages/participants/authorizations/code_postal_letter.adoc b/docs/en/modules/admin/pages/participants/authorizations/code_postal_letter.adoc index 20ff86d715..5f17469a34 100644 --- a/docs/en/modules/admin/pages/participants/authorizations/code_postal_letter.adoc +++ b/docs/en/modules/admin/pages/participants/authorizations/code_postal_letter.adoc @@ -1,19 +1,19 @@ = Code by postal letter authorization -This authorization allows a participant to request for a verification code to be sent to its address, to confirm that she +This authorization allows a participant to request the sending of a verification code to their address, to confirm that she lives or works in this place. She'll need to then fill the code in the platform. The process is: -. Participants request a verification code to be sent to their address. +. Participants request the sending of a verification code to their address. . An administrator sends the letter to their address with the verification code. . An administrator marks the letter as sent. -. Once you mark the letter as sent, the participant will be able to introduce the code. -. If this code matchs, then she gets verified. +. Once you mark the letter as sent, the participant can enter the code. +. If this code matches, then verification succeeds. -== 1. A participant request the verification code +== 1. A participant requests the verification code -By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, +By going to the authorization section in their profile, or by clicking on the action button if requesting this permission, a participant can see the form for filling in her full address to request the verification code. image:authorizations_code_postal_letter_request.png[Code by postal letter request by participant] @@ -22,22 +22,22 @@ If she tries to edit it, she'll see this message: image:authorizations_code_postal_letter_edit.png[Edit the postal letter request] -This is because the letter could be in the process of being sent. If this needs to be corrected, then the participant needs -to contact to the organization. +This is because the letter sending could be in progress. If the information requires correction, then the participant needs +to contact the organization directly. -== 2. An administrator review this request and sent the letter +== 2. An administrator reviews this request and sends the letter -In the admin panel, the administrator can review the request by going to the "Code by postal letter" in the "Participants" section. +In the administrator panel, the administrator can review the request by going to the 'Code by postal letter' in the 'Participants' section. -image:authorizations_code_postal_letter_ongoing.png[Code by postal letter ongoing panel in admin] +image:authorizations_code_postal_letter_ongoing.png[Code by postal letter ongoing panel in administrator panel] -Here she can see the verification code and can send it to the participant by mail. After the code is sent she can mark it -as sent with the icon image:action_mark_as_sent.png[Mark as sent]. It'll also show when the letter was sent. +Here she can see the verification code and can send it to the participant by mail. After sending the code she can mark it +as sent with the icon image:action_mark_as_sent.png[Mark as sent]. It also shows the sending date of the letter. == 3. A participant fills in the verification code -After the participant has received the code, she can go to it's account settings and click in the "Code by postal letter" -verfication method. +After the participant has received the code, she can go to account settings and Click on the 'Code by postal letter' +verification method. image:authorizations_code_postal_letter_verify.png[Code by postal letter ongoing in the participant account] @@ -45,13 +45,20 @@ Then she'll see the form for confirming the code. image:authorizations_code_postal_letter_confirm.png[Code by postal letter confirmation form] -== 4. The verification code matches or not +== 4. The verification code matches, or not -If the verification code matches, then the participant will see the message "Congratulations. You've been successfully verified". +If the verification code matches, then the participant sees the message 'Congratulations. You've been successfully verified'. -On the other hand, if the verification code doesn't match, then the participant will see the message "Your verification -code doesn't match ours. Please double-check the letter we sent to you." +pass:[] +pass:[] -After is verified, as with other verifications, she can see it in her account settings. + +On the other hand, if the verification code does not match, then the participant sees the message "Your verification +code does not match ours. Please double-check the letter we sent to you." + +pass:[] +pass:[] + +Once verified, as with other verifications, she can see it in her account settings. image:authorizations_code_postal_letter_verified.png[Verified by code by postal letter] diff --git a/docs/en/modules/admin/pages/participants/authorizations/identity_documents.adoc b/docs/en/modules/admin/pages/participants/authorizations/identity_documents.adoc index 34b1e2585c..fe6144dc88 100644 --- a/docs/en/modules/admin/pages/participants/authorizations/identity_documents.adoc +++ b/docs/en/modules/admin/pages/participants/authorizations/identity_documents.adoc @@ -3,10 +3,10 @@ This authorization allows a participant to upload its identity documents. These documents depend on the organization, they could be a driver's license, a passport, a national identity card, a club membership card, etc. -These documents will be reviewed by an administrator to accept or reject them. It's possible to do this process in two ways: Online or Offline. +An administrator reviews these documents to accept or decline them. It is possible to do this process in two ways: online or offline. -* Online: the participant will be asked to upload the documents, and the administrator will review these documents. -* Offline: the participant will be asked to fill in some data, and then she'll need to go to a presential place to show her documents face to face. +* Online: the participant uploads the documents, and the administrator reviews these documents. +* Offline: the participant fills in some data, and then she'll need to go to a official place to show her documents face to face. == Configuration @@ -14,10 +14,10 @@ By clicking on the btn:[Config] button in this section, an administrator can con image:authorizations_id_document_configuration.png[ID document authorization configuration] -NOTE: As you can see, this authorization is based in the original implementers reality, in this case in the Spanish identities document types. -For instance, we're giving as options for document types "DNI, NIE or Passport" or we're asking for "Document number (with letter)" -You can change this by xref:customize:code.adoc[code customizing or overriding] these things. We also accept xref:contribute:governance.adoc[Pull Request contributions] -so it's possible to configure this. +NOTE: As you can see, the basis for this authorization method is the original implementers reality, in this case in the Spanish identities document types. + +For instance, the options for document types include 'DNI, NIE, or Passport' or asking for 'Document number - with letter' +You can change this by xref:customize:code.adoc[code customizing or overriding] these things. xref:contribute:governance.adoc[Pull Request contributions] are also welcome, so it is possible to configure this. .ID Documents authorization configuration |=== @@ -25,11 +25,11 @@ so it's possible to configure this. |Available methods |Required -|At least one method must be selected. Options: Online and/or Offline. +|You must select at least one method. Options: Online and/or Offline. |Instructions for offline verification -|Required (if offline is selected) -|Directions that participants need to follow to verify their documents when offline verification is selected. For instance, +|Required - if you have selected offline +|Directions that participants need to follow to verify their documents when you have selected offline verification. For instance, do they need to go to a specific place to show their documents? Is this place open some days of the week? Is it open for certain hours? @@ -42,19 +42,19 @@ The process is: . Participants fill in their document type and number and upload a copy of their document. . An administrator fills in the information present in the uploaded image. . The information should match whatever the user filled in. -. If the administrator can't clearly see the information or she can't get it verified, she can reject the request and -the user will be able to fix it. +. If the administrator cannot see the information or she cannot verify it, she can decline the request and +the user can fix the problem. -=== 1. A participant fill in the document information and upload a copy of her document +=== 1. A participant fills in the document information and uploads a copy of her document -By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, +By going to the authorization section in its profile, or by clicking on the action button if requesting this permission, a participant can see the form for uploading a copy of her document. She also needs to fill in her document type and number. image:authorizations_id_document_online.png[ID document authorization online form] -=== 2. An administrator review this document +=== 2. An administrator reviews this document -After this document is uploaded, an administrator can review it by going to the Identity documents section in the admin +After uploading the document, an administrator can review it by going to the Identity documents section in the administrator panel. image:authorizations_id_document_online_pending.png[ID document authorization pending online verification] @@ -64,14 +64,14 @@ with the one provided by the participant. image:authorizations_id_document_online_confirm.png[ID document authorization online confirmation form] -=== 3. The request is accepted or rejected +=== 3. Accepting or declining the request -There are two actions an admin can do: +There are two actions an administrator can do: -* Accept: the participant will be fully authorized. -* Reject: the participant will be prompted to amend her documents +* Accept: the participant is fully authorized. +* Decline: system informs the participant who amends her documents -If the request is rejected then the participant can provide other pictures or document. +If declining the request, the participant can provide other pictures or document. image:authorizations_id_document_online_rejected.png[ID document authorization rejected online verification] @@ -82,32 +82,32 @@ The process is: . Participants fill in their document type and number. . Participants follow the instructions provided to them. For instance, if they need to go to a specific place in a specific time to show their documents. -. An administrator go to the "Offline verification" panel and fills in the information present in the physical documents. +. An administrator go to the 'Offline verification' panel and fills in the information present in the physical documents. . The information should match whatever the user filled in. -. If the administrator can't clearly see the information or she can't get it verified, she can reject the request and -the user will be able to fix it. +. If the administrator cannot see the information or she cannot verify it, she can decline the request and +the user is able to fix it. -For this authorization to work, an administrator need to first configure it in the admin panel with the instructions explaining +For this authorization to work, an administrator need to first configure it in the administrator panel with the instructions explaining what the participant need to do to finish the verification process. image:authorizations_id_document_configuration_offline.png[ID document authorization configuration: offline instructions] -=== 1. A participant fill in the document information and follow the instructions +=== 1. A participant fills in the document information and follows the instructions -By going to the authorization section in its profile, or by clicking on the action button if this permission is requested, +By going to the authorization section in their profile, or by clicking on the action button if requesting this permission, a participant can see the form for filling in her document type and number. image:authorizations_id_document_offline_request.png[ID document authorization offline form] === 2. An administrator review this request -In the admin panel, the administrator can review the request by clicking in the "Offline verification" button. +In the administrator panel, the administrator can review the request by clicking in the 'Offline verification' button. -image:authorizations_id_document_offline_button.png[ID document authorization offline button in admin] +image:authorizations_id_document_offline_button.png[ID document authorization offline button in administrator panel] Then she'll need to fill some data provided by the participant and by reviewing the document physically provided by her. -image:authorizations_id_document_offline_confirm.png[ID document authorization offline confirmation form in admin] +image:authorizations_id_document_offline_confirm.png[ID document authorization offline confirmation form in administrator panel] .ID Documents authorization offline flow |=== @@ -115,27 +115,27 @@ image:authorizations_id_document_offline_confirm.png[ID document authorization o |Participant email |Required -|Email of the registered participant +|Participant email address |Type of the document |Required |Can be: DNI, NIE or Passport -|Document number (with letter) +|Document number - with letter |Required -|Document number of the participant. For instance, "12345678Z" +|Document number of the participant. For instance, '12345678Z' |=== -=== 3. The request is accepted or rejected +=== 3. The accepting or declining of a request -In the cases where the verifications don't match (meaning that the email or the document number provided by the -participant and the ones filled by the administrators aren't the same), then the participant need to ammend it with her +In the cases where the verifications do not match - meaning that the email or the document number provided by the +participant and the ones filled by the administrators are not the same - then the participant need to amend it with her user account. == Both -It's also possible to enable both of these verifications methods. In this case, the participant will be asked to choose +It is also possible to enable both of these verifications methods. In this case, the participant has the option to choose which kind of verification she wants to do. image:authorizations_id_document_account_choose.png[Choose ID document verification kind] diff --git a/vale.ini b/vale.ini new file mode 100644 index 0000000000..11aaa103b8 --- /dev/null +++ b/vale.ini @@ -0,0 +1,6 @@ +StylesPath = .github/styles +Vocab = Decidim +MinAlertLevel = suggestion +Packages = alex, Google +[*.{adoc}] +BasedOnStyles = Vale, alex, Google