Documentation issueshttps://lab.civicrm.org/groups/documentation/-/issues2018-04-17T00:51:25Zhttps://lab.civicrm.org/documentation/docs/user-en/-/issues/188Document risk of exposing data to anonymous users via profiles2018-04-17T00:51:25ZhomotechsualDocument risk of exposing data to anonymous users via profiles*Created by: seancolsen*
*Migrated from https://issues.civicrm.org/jira/browse/CRM-18160*
See https://issues.civicrm.org/jira/browse/CRM-18122
It is much too easy to grant permissions that inadvertently expose data.
Barring imp...*Created by: seancolsen*
*Migrated from https://issues.civicrm.org/jira/browse/CRM-18160*
See https://issues.civicrm.org/jira/browse/CRM-18122
It is much too easy to grant permissions that inadvertently expose data.
Barring improvements to profiles and/or permissions (and even if they were improved) we should have clear documentation on the risk of doing so, and steps you can take to avoid it.
I should be discussed and/or cross referenced in
* http://docs.civicrm.org/user/en/stable/initial-set-up/permissions-and-access-control/ and
* http://docs.civicrm.org/user/en/stable/initial-set-up/security/
* http://docs.civicrm.org/user/en/stable/organising-your-data/profiles/
When working on this, it might be a good time to merge information from the following wiki pages into the book and delete the wiki page:
* https://wiki.civicrm.org/confluence/display/CRMDOC/Default+Permissions+and+Roles
* https://wiki.civicrm.org/confluence/display/CRMDOC/Access+Control+Context+and+Overview
Once complete, it probably makes sense to update UI references to the documentation in appropriate pages like the profiles config pages.
---
Further recommendations from a comment in the original issue
1. On http://docs.civicrm.org/user/en/stable/initial-set-up/permissions-and-access-control/ in the "Permissions and Access Control" section, add some verbiage stating that ACLs restricting access to contacts can be overridden in a search profile that's configured as "Public Pages and Listings" in 4.6 or "Expose Publicly and for Listings" in 4.7.
1. On http://docs.civicrm.org/user/en/stable/organising-your-data/profiles/ in the "Adding fields and choosing field settings in Profiles" section, item 6 "Visibility," indicate that the "Public Pages and Listings" in 4.6 or "Expose Publicly and for Listings" settings can cause data otherwise restricted by ACLs or to logged-in users to be made public. This should be given extra emphasis and styled as a "black box" warning.
1. civicrm/templates/CRM/UF/Form/Field.hlp should be updated to reflect the possibility of exposure of data publicly.
1. http://docs.civicrm.org/user/en/stable/initial-set-up/security/ deals with physical and network security and, in my opinion, isn't relevant and does not need to be revised.
https://lab.civicrm.org/documentation/docs/user-en/-/issues/126".merge_file_ZAZG0Z" and similar strings appearing in docs2016-10-30T10:01:03ZAllenShaw".merge_file_ZAZG0Z" and similar strings appearing in docsThe page at https://docs.civicrm.org/user/en/latest/email/scheduled-reminders/ contains several blockquote elements containing only a string like ".merge_file_ZAZG0Z". Perhaps this is an artifact of some automated process? I don't see e...The page at https://docs.civicrm.org/user/en/latest/email/scheduled-reminders/ contains several blockquote elements containing only a string like ".merge_file_ZAZG0Z". Perhaps this is an artifact of some automated process? I don't see equivalent content in the .md file (https://github.com/civicrm/civicrm-user-guide/blob/master/docs/email/scheduled-reminders.md), so creating a PR doesn't seem like it would help here.
https://lab.civicrm.org/documentation/docs/user-en/-/issues/195Convert old "note" text to admonitions2018-03-23T20:08:25ZhomotechsualConvert old "note" text to admonitions*Created by: seancolsen*
[Admonitions](https://docs.civicrm.org/dev/en/latest/markdownrules/#admonitions) are those colored boxes which say "Note" or "Warning" or other things. It was only a couple months ago that we enabled features in...*Created by: seancolsen*
[Admonitions](https://docs.civicrm.org/dev/en/latest/markdownrules/#admonitions) are those colored boxes which say "Note" or "Warning" or other things. It was only a couple months ago that we enabled features inserting admonitions our docs books. So we have lots of content which was written before we started using admonitions. The User Guide would look nicer if we converted this old content to use admonitions.
Here's a command which currently finds 58 occurrences of content which could probably be converted to use admonitions.
```
grep -PIr '^(> )?(\*\*)?((Note)|(NOTE)|(Warning)|(WARNING)|(Caution)|(CAUTION)|(Tip)|(TIP)|(Important)|(IMPORTANT)|(NB)|(N\.B\.))' .
```
For each of these things, we want to convert markdown like this...
```markdown
**Note:** CiviCRM rocks!
```
to markdown like this...
```markdown
!!! note
CiviCRM rocks!
```
Read more about the [syntax for admonitions](https://docs.civicrm.org/dev/en/latest/markdownrules/#admonitions)2018 User Guide sprinthttps://lab.civicrm.org/documentation/docs/user-en/-/issues/192More VERP docs2017-06-02T22:52:17ZxurizaemonMore VERP docsAdd some docs for VERP config. Seems to be a bit of a FAQ!Add some docs for VERP config. Seems to be a bit of a FAQ!https://lab.civicrm.org/documentation/docs/user-en/-/issues/190Smarty in Email templates2017-10-29T00:12:03ZhomotechsualSmarty in Email templates*Created by: seancolsen*
*Migrated from: https://issues.civicrm.org/jira/browse/CRM-14714*
---
http://wiki.civicrm.org/confluence/display/CRMDOC/Smarty+in+mail+templates could probably now go in the book. Potentially an argument f...*Created by: seancolsen*
*Migrated from: https://issues.civicrm.org/jira/browse/CRM-14714*
---
http://wiki.civicrm.org/confluence/display/CRMDOC/Smarty+in+mail+templates could probably now go in the book. Potentially an argument for adding this as a configuration setting now as well. https://lab.civicrm.org/documentation/docs/user-en/-/issues/167Update "Community" page2017-06-02T23:55:59ZhomotechsualUpdate "Community" page*Created by: seancolsen*
This page needs some updating:
https://docs.civicrm.org/user/en/latest/the-civicrm-community/the-civicrm-community/
Lots of outdated content here. Someone who is up-to-date on the latest tools that the comm...*Created by: seancolsen*
This page needs some updating:
https://docs.civicrm.org/user/en/latest/the-civicrm-community/the-civicrm-community/
Lots of outdated content here. Someone who is up-to-date on the latest tools that the community is using should scan through this page and make updates as necessary. https://lab.civicrm.org/documentation/docs/user-en/-/issues/147Change theme to Material2017-03-12T14:42:56ZhomotechsualChange theme to Material*Created by: seancolsen*
I think it would be nice to put the new Material theme in place in the User Guide? You can see it in action in the [Developer Guide](https://docs.civicrm.org/dev/en/master/).
Is that okay with you @joanneche...*Created by: seancolsen*
I think it would be nice to put the new Material theme in place in the User Guide? You can see it in action in the [Developer Guide](https://docs.civicrm.org/dev/en/master/).
Is that okay with you @joannechester? I'll wait to get a go-ahead from you before making this change. https://lab.civicrm.org/documentation/docs/user-en/-/issues/166Update "Contributing to this guide"2017-05-13T00:30:33ZhomotechsualUpdate "Contributing to this guide"*Created by: seancolsen*
This page needs some updating:
https://docs.civicrm.org/user/en/latest/the-civicrm-community/contributing-to-this-manual/
Offer a one-paragraph summary and then link to content that already exists here:
ht...*Created by: seancolsen*
This page needs some updating:
https://docs.civicrm.org/user/en/latest/the-civicrm-community/contributing-to-this-manual/
Offer a one-paragraph summary and then link to content that already exists here:
https://docs.civicrm.org/dev/en/latest/documentation/https://lab.civicrm.org/documentation/docs/user-en/-/issues/144update info about recurring contributions2017-06-02T23:57:31Zhomotechsualupdate info about recurring contributions*Created by: seancolsen*
The User Guide seems to have only [minimal info](https://docs.civicrm.org/user/en/stable/contributions/payment-processors/#support-for-recurring-contributions) about recurring contributions.
Today someone in...*Created by: seancolsen*
The User Guide seems to have only [minimal info](https://docs.civicrm.org/user/en/stable/contributions/payment-processors/#support-for-recurring-contributions) about recurring contributions.
Today someone in MM [asked](https://chat.civicrm.org/civicrm/pl/r5crg8875ir5pdjtc5hhkr87uy) about this and ended up on this [wiki page](https://wiki.civicrm.org/confluence/display/CRMDOC/PayPal+Website+Payments+Standard+and+Recurring+Contributions). I glanced over the wiki page and it seems a bit out of date. Would be good to get up-to-date info in the User Guide including stuff about [iATS](https://civicrm.org/extensions/iats-payments) which (I think?) has the best support for it. https://lab.civicrm.org/documentation/docs/user-en/-/issues/141Move some content to the Administrator Guide, as needed2018-03-05T16:01:35ZhomotechsualMove some content to the Administrator Guide, as needed*Created by: wmortada*
The User Guide currently caters for both users and administrators. I think these are two distinct audiences and the User Guide would be a lot easier for users to read if the administrative sections were removed.
...*Created by: wmortada*
The User Guide currently caters for both users and administrators. I think these are two distinct audiences and the User Guide would be a lot easier for users to read if the administrative sections were removed.
This links with a related issue to [Create "Administrator Guide" book, separate from User Guide and Developer Guide](https://github.com/civicrm/civicrm-docs/issues/17).
Many people use CiviCRM everyday and need simple clear information about how to do so. They don't need to know how to install it and set it up. Yet the User Guide has a section on installation and basic set-up fairly early on.
I think the User Guide would be much more accessible to the many people that are using CiviCRM systems day to day if we could take out the more technical aspects of setting up CiviCRM. The proposed Administrator Guide would be an ideal place for this.
This would mean that the guides are split as follows:
- **Administrator Guide** - everything that you need to know to install, set up and configure CiviCRM
- **User Guide** - everything that you need to know to use CiviCRM on a day to day basis (presuming that it has already been set up for you by someone else).
The User Guide can reference the Administrator Guide and vice versa, as required.
I would suggest that the following sections are taken out of the User Guide and used to create the Administrator Guide:
- Initial set up
- [whole section]
- Advanced configuration
- [whole section]
- Organising your data
- Mapping your data
- Contributions
- Key concepts and configuration
- Sales tax and VAT
- Pledges
- Set-up
- Email
- Set-up
- SMS
- Set-up
- Case Management
- Set-up
- Campaign
- Set-up
- Petition
- Set-up
- Civic Engagement
- Set-up
- Grants
- Set-up
- Website integration
- [whole section]
I haven't looked through all of these pages in detail, so there may need to be some adjustments, but I hope that you get the general idea.https://lab.civicrm.org/documentation/docs/user-en/-/issues/137Reference hosting in the installation chapter2018-03-23T21:01:29ZMichael McAndrewReference hosting in the installation chapterThe [installation](https://docs.civicrm.org/user/en/latest/initial-set-up/installation-and-basic-set-up/) chapter doesn't mention that hosted CiviCRM is an option. It says "Before reading further, please be aware that much of the informa...The [installation](https://docs.civicrm.org/user/en/latest/initial-set-up/installation-and-basic-set-up/) chapter doesn't mention that hosted CiviCRM is an option. It says "Before reading further, please be aware that much of the information contained here is intended for technicians and may be difficult to understand if you have little or no experience in setting up web applications." but doesn't mention that you can bypass all the technical side if you sign up with a host.2018 User Guide sprinthttps://lab.civicrm.org/documentation/docs/user-en/-/issues/107Deprecate "Credits" page with link to GitHub contributors instead2018-03-25T16:32:02ZhomotechsualDeprecate "Credits" page with link to GitHub contributors instead*Created by: joannechester*
Do we have a way of maintning that sort of list, or do we change ot so that we have, say,:
Contributors
v4.7 Michael mcandrew, Joanne Chester, Steve Kessler ...
V4.6 Michael mcandrew, Joanne Chester, Kate Sn...*Created by: joannechester*
Do we have a way of maintning that sort of list, or do we change ot so that we have, say,:
Contributors
v4.7 Michael mcandrew, Joanne Chester, Steve Kessler ...
V4.6 Michael mcandrew, Joanne Chester, Kate Sneed,...
2018 User Guide sprinthttps://lab.civicrm.org/documentation/docs/user-en/-/issues/108Document "contributions widgets" functionality2017-06-03T05:27:51ZhomotechsualDocument "contributions widgets" functionality*Created by: joannechester*
*Created by: joannechester*
https://lab.civicrm.org/documentation/docs/user-en/-/issues/111Fix broken list formatting2018-03-23T00:01:52ZhomotechsualFix broken list formatting*Created by: joannechester*
online contributions thank and receipt tab
*Created by: joannechester*
online contributions thank and receipt tab
2018 User Guide sprinthttps://lab.civicrm.org/documentation/docs/user-en/-/issues/114Document the process for turning on advanced logging2018-03-23T21:05:58ZhomotechsualDocument the process for turning on advanced logging*Created by: joannechester*
See [this se question.](http://civicrm.stackexchange.com/questions/11556/how-to-extend-database-log-report-from-contact)
*Created by: joannechester*
See [this se question.](http://civicrm.stackexchange.com/questions/11556/how-to-extend-database-log-report-from-contact)
https://lab.civicrm.org/documentation/docs/user-en/-/issues/146Clarify process for merging master into stable2017-03-17T00:29:55ZhomotechsualClarify process for merging master into stable*Created by: seancolsen*
There was some [discussion](https://chat.civicrm.org/civicrm/pl/b77we4y9rpb15yapndwa1pat6r) today about changes made in `master` not easily making their way into `stable`. What's our process for this? Currently ...*Created by: seancolsen*
There was some [discussion](https://chat.civicrm.org/civicrm/pl/b77we4y9rpb15yapndwa1pat6r) today about changes made in `master` not easily making their way into `stable`. What's our process for this? Currently there appear to be [quite a few](https://github.com/civicrm/civicrm-user-guide/compare/4.7...master) changes in `master` that have yet to be ported to `stable`. https://lab.civicrm.org/documentation/docs/user-en/-/issues/138Make "scheduled jobs" page easier for non-technical readers2018-03-05T17:04:00ZMichael McAndrewMake "scheduled jobs" page easier for non-technical readersThe [scheduled jobs](https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/) section starts with reference to cron, which is a fairly technical subject. We should instead talk about the scheduled jobs UI first.
The cro...The [scheduled jobs](https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/) section starts with reference to cron, which is a fairly technical subject. We should instead talk about the scheduled jobs UI first.
The cron references should be prefaced with "this is a job for your host or sys admin". They might want to consult the admin guide for more information.https://lab.civicrm.org/documentation/docs/user-en/-/issues/46Replace action menu images and edit text to show/use new names2016-03-12T09:26:14ZhomotechsualReplace action menu images and edit text to show/use new names*Created by: joannechester*
This is based on https://issues.civicrm.org/jira/browse/CRM-16467
Images to change:
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/Search%20Action.PNG -done
http://civicrm-user-guide-rtfd.readt...*Created by: joannechester*
This is based on https://issues.civicrm.org/jira/browse/CRM-16467
Images to change:
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/Search%20Action.PNG -done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/Groups&tags_actions%20Update.png -done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/CiviCRM_update-CiviCore-ExportFromSearch-en.png -done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/Batch%20Update%20Contribution%20Via%20Profile.png - not in current book?
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/advanced%20search%20schedule%20mass%20mailing.png - Done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/CiviCRM_SMS_sending-by-advanced-search.png - not in current book?
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/Batch%20Update%20Contribution%20Via%20Profile.png - not in current book?
and perhaps
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/img/petition_signatures_email.png
and missing image (../img/CiviCRM_contributions_sendreceipts.png) in Manual receipts and thank you letters. - DONE
Text to update will be near images and also:
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/organising-your-data/relationships/ - done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/organising-your-data/profiles/ (batch update via profiles) -Done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/events/keeping-track-of-events-and-participants/ - done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/membership/finding-and-viewing-memberships/ -done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/email/set-up/ (actions associated with smart group) - done
http://civicrm-user-guide-rtfd.readthedocs.org/en/latest/email/everyday-tasks/ - done
4.7https://lab.civicrm.org/documentation/docs/dev/-/issues/861Document hook_civicrm_links op 'pcp.user.actions'2022-10-11T15:17:33ZbgmDocument hook_civicrm_links op 'pcp.user.actions'Related core PR: https://github.com/civicrm/civicrm-core/pull/18570Related core PR: https://github.com/civicrm/civicrm-core/pull/18570https://lab.civicrm.org/documentation/docs/dev/-/issues/859broken link2020-09-22T03:14:37Zhomotechsualbroken link*Created by: eileenmcnaughton*
Document https://github.com/civicrm/civicrm-dev-docs/blob/master/README.md
Link in pic gives a 404
<img width="457" alt="Screen Shot 2020-09-21 at 8 55 11 AM" src="https://user-images.githubusercontent.c...*Created by: eileenmcnaughton*
Document https://github.com/civicrm/civicrm-dev-docs/blob/master/README.md
Link in pic gives a 404
<img width="457" alt="Screen Shot 2020-09-21 at 8 55 11 AM" src="https://user-images.githubusercontent.com/336308/93722061-2fbb2600-fbe8-11ea-8273-e2c97a9dc9bd.png">