Documentation issueshttps://lab.civicrm.org/groups/documentation/-/issues2022-10-11T15:17:33Zhttps://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/user-en/-/issues/448Add documentation about partially paid contributions2020-10-07T21:10:34ZBetty DolfingAdd documentation about partially paid contributionsWhen doing PR reviewing we saw that there is no user documentation on partially paid contributions (https://github.com/civicrm/civicrm-core/pull/16546) and how that is handled by CiviCRM. It would be good to add this to the user document...When doing PR reviewing we saw that there is no user documentation on partially paid contributions (https://github.com/civicrm/civicrm-core/pull/16546) and how that is handled by CiviCRM. It would be good to add this to the user documentation.https://lab.civicrm.org/documentation/docs/sysadmin/-/issues/273Document the steps required to export the CiviCRM database and exclude trigge...2020-10-15T09:27:40Zjustinfreeman (Agileware)Document the steps required to export the CiviCRM database and exclude triggers to avoid the "invalid definer permission" error issueDocument the steps required to export the CiviCRM database and exclude triggers to avoid the "invalid definer permission" error issue.
https://docs.civicrm.org/sysadmin/en/latest/misc/switch-servers/
mysql-dump --skip-triggers
This cha...Document the steps required to export the CiviCRM database and exclude triggers to avoid the "invalid definer permission" error issue.
https://docs.civicrm.org/sysadmin/en/latest/misc/switch-servers/
mysql-dump --skip-triggers
This change is also dependent on https://lab.civicrm.org/dev/core/-/issues/2124
The "Misc" section should also be moved to something like "Common Administration Tasks". Also related to #74
**Background info**
skip-triggers was around 9 years ago - https://serverfault.com/questions/327079/exporting-mysql-without-trigger-data
"If the DEFINER clause is omitted, the default definer is the user who executes the CREATE TRIGGER statement. This is the same as specifying DEFINER = CURRENT_USER explicitly."
https://dev.mysql.com/doc/refman/8.0/en/create-trigger.html
Agileware Ref: CIVICRM-1584justinfreeman (Agileware)justinfreeman (Agileware)https://lab.civicrm.org/documentation/docs/dev/-/issues/88remove wiki links from hooks page2017-02-11T00:39:35Zhomotechsualremove wiki links from hooks page*Created by: seancolsen*
old wiki links on this page need to be removed
https://docs.civicrm.org/dev/en/master/hooks/*Created by: seancolsen*
old wiki links on this page need to be removed
https://docs.civicrm.org/dev/en/master/hooks/https://lab.civicrm.org/documentation/docs/user-en/-/issues/449There is no documentation (I could find) about how to set up or access the Co...2021-05-05T19:50:59Zjustinfreeman (Agileware)There is no documentation (I could find) about how to set up or access the Contact Dashboard pageThere is no documentation (I could find) about how to set up or access the Contact Dashboard page. CiviCRM has this permission "CiviCRM: access Contact Dashboard" - but finding what URL to use to view the Contact Dashboard page requires ...There is no documentation (I could find) about how to set up or access the Contact Dashboard page. CiviCRM has this permission "CiviCRM: access Contact Dashboard" - but finding what URL to use to view the Contact Dashboard page requires some serious Google Kung-Fuey!
Would be good to have in the User Guide this information, in it's own section I would say too.
There is this section, but I don't think it's relevant for this topic.
https://docs.civicrm.org/user/en/latest/the-user-interface/menu-dashboard-and-dashlets/
Two methods:
/civicrm/user
Or from back-end, when viewing a Contact, use the Actions menu button to click on the Contact Dashboard item. URL looks something like:
/wp-admin/admin.php?page=CiviCRM&q=civicrm%2Fuser&reset=1&id=62&cid=62
Permissions:
Requires the user to be logged in and the assigned role needs to have the "CiviCRM: access Contact Dashboard" permission enabled.
OR
The use a Contact Checksum URL and the Anonymous role needs to have the "CiviCRM: access Contact Dashboard" permission enabled.https://lab.civicrm.org/documentation/docs/sysadmin/-/issues/274Create documentation on the different admin themes available2020-11-13T16:03:28ZwmortadaCreate documentation on the different admin themes availableWe now have a number of different admin themes available but this is rather hidden and many users are unaware that there is even an option to change theme. I think it would be good to make this more visible and suggest that we add a page...We now have a number of different admin themes available but this is rather hidden and many users are unaware that there is even an option to change theme. I think it would be good to make this more visible and suggest that we add a page to the Sysadmin guide that covers this.
I would suggest that it covers the following themes as a minimum:
* [Shoreditch](https://civicrm.org/extensions/shoreditch)
* [Finsbury Park](https://civicrm.org/extensions/finsbury-park-cross-cms-admin-theme)
* [Haystack](https://lab.civicrm.org/extensions/haystacktheme)
* [Aah](https://github.com/artfulrobot/aah)
There is some discussion about themes on [this page](https://docs.civicrm.org/sysadmin/en/latest/customize/theme/) but it doesn't mention the above other than Shoreditch and is focussed more on the technicalities of creating a theme rather than installing an existing theme.
More details about themes: https://lab.civicrm.org/dev/user-interfacehttps://lab.civicrm.org/documentation/docs/sysadmin/-/issues/1Plan an outline for this guide2021-07-29T02:07:26ZhomotechsualPlan an outline for this guide*Created by: seancolsen*
I am proposing the following outline for this guide and I'd love to get feedback from others:
* Home
* Planning your site *(migrated from [this content](https://docs.civicrm.org/user/en/latest/getting-prepar...*Created by: seancolsen*
I am proposing the following outline for this guide and I'd love to get feedback from others:
* Home
* Planning your site *(migrated from [this content](https://docs.civicrm.org/user/en/latest/getting-prepared/is-civicrm-for-you/) in the User Guide)*
* Identifying your needs
* Trying a demo
* Hosting
* Choosing a CMS
* Transitioning to CiviCRM
* Requirements
* Installation
* Install in Drupal 8
* Install in Drupal 7
* Install in Drupal 6
* Install in WordPress
* Install in Joomla
* Install in Backdrop
* Multi-site installation
* Setup
* Setup *(including: checklist, etc.)*
* Backups *(including: backup, restore)*
* Monitoring *(including: System status, recommended sysadmin monitoring tools)*
* Securing your site *(including: CMS Permissions, Civi ACLs, CAPTCHA, SSL, PHPIDS)*
* Data migration
* Sync users and contacts
* Scheduled jobs *(including: scheduled jobs, Cron job setup)*
* CiviMail setup *(including: content from [Andrew's blog post](https://civicrm.org/blog/andrewhunt/alternatives-to-mandrill)*
* SMS setup
* Payment processors
* Detailed logging
* Troubleshooting
* Upgrades
* Upgrades overview
* Upgrade in Drupal 8
* Upgrade in Drupal 7
* Upgrade in Drupal 6
* Upgrade in WordPress
* Upgrade in Joomla
* Upgrade in Backdrop
* Upgrade troubleshooting
* Customization
* Basic customization *(mostly points to User Guide)*
* Extensions *(including: installing, removing, upgrading extensions. Also will point to the Dev Guide)*
* Other languages
* Drupal integration
* *(sub-pages will eventually here, but will not be covered by MIH campaign)*
* Backdrop integration
* Wordpress integration
* Joomla integration
* Custom development
* Special situations
* Changing installation directories
* Changing domain names
* Switching servers
* Switching CMS platforms
* Data redactionWiki Migrationhttps://lab.civicrm.org/documentation/docs/dev/-/issues/90Update markdown instructions for Material2017-02-13T19:00:00ZhomotechsualUpdate markdown instructions for Material*Created by: seancolsen*
The new Material theme adds some new markdown features. Document these in the markdown page.*Created by: seancolsen*
The new Material theme adds some new markdown features. Document these in the markdown page.https://lab.civicrm.org/documentation/docs/user-en/-/issues/425Screenshot for event location page needs updating2020-04-02T09:33:56ZhomotechsualScreenshot for event location page needs updating*Created by: eileenmcnaughton*
Per this PR https://github.com/civicrm/civicrm-core/pull/16230 there is a new check box that needs to be added to the PR*Created by: eileenmcnaughton*
Per this PR https://github.com/civicrm/civicrm-core/pull/16230 there is a new check box that needs to be added to the PRhttps://lab.civicrm.org/documentation/docs/user-en/-/issues/443Check and update localization instructions2020-05-04T11:44:36Zmattwiremjw@mjwconsult.co.ukCheck and update localization instructionshttps://github.com/civicrm/civicrm-user-guide/blob/master/docs/initial-set-up/installation-and-basic-set-up.md
Following merge of https://github.com/civicrm/civicrm-core/pull/17006. Also mention https://lab.civicrm.org/extensions/kaml...https://github.com/civicrm/civicrm-user-guide/blob/master/docs/initial-set-up/installation-and-basic-set-up.md
Following merge of https://github.com/civicrm/civicrm-core/pull/17006. Also mention https://lab.civicrm.org/extensions/kamlanguage and the CiviCRM language switcher if it makes sense.https://lab.civicrm.org/documentation/docs/sysadmin/-/issues/2What is the minimum CiviCRM version that this guide should support?2017-10-25T21:22:32ZhomotechsualWhat is the minimum CiviCRM version that this guide should support?*Created by: seancolsen*
Some of the installation and upgrade docs in the wiki go *waay* back to super old versions. How far back should we go with this guide? This is particularly relevant for *upgrades* where a user might still be on ...*Created by: seancolsen*
Some of the installation and upgrade docs in the wiki go *waay* back to super old versions. How far back should we go with this guide? This is particularly relevant for *upgrades* where a user might still be on an old version and require instructions specific to that version for how to upgrade *off* of it.
For example, the page on [upgrading Drupal 7 sites for CiviCRM 4.7](https://wiki.civicrm.org/confluence/display/CRMDOC/Upgrading+CiviCRM+for+Drupal+7) says:
> Upgrading from a version prior to 2.2? First upgrade to 2.2 [using these instructions](https://wiki.civicrm.org/confluence/display/CRMDOC22/Upgrade+Drupal+Sites+to+2.2).
So a specific question here is: *do we want to migrate this page on [upgrading Drupal sites to 2.2](https://wiki.civicrm.org/confluence/display/CRMDOC22/Upgrade+Drupal+Sites+to+2.2)?* ... I say no.
The [stats](https://stats.civicrm.org/?tab=sites) only go back to 4.2.
I propose that the scope of this guide be limited to 4.0 and later. Curious to hear feedback from others on this proposal. Wiki Migrationhttps://lab.civicrm.org/documentation/docs/dev/-/issues/83hook_civicrm_trigger_info clean content2017-02-11T04:14:18Zhomotechsualhook_civicrm_trigger_info clean content*Created by: seancolsen*
The markdown file for `hook_civicrm_trigger_info` will need some cleaning after import*Created by: seancolsen*
The markdown file for `hook_civicrm_trigger_info` will need some cleaning after importhttps://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/user-en/-/issues/412CiviCRM User Guide Update: Understanding Unsubscribe vs. Opt Out 2020-04-17T09:15:01ZhomotechsualCiviCRM User Guide Update: Understanding Unsubscribe vs. Opt Out *Created by: roshanikothari*
Understanding Unsubscribe vs. Opt Out in CiviCRM
https://docs.civicrm.org/user/en/latest/email/mass-mailings-using-civimail/
You can provide several options for users to unsubscribe from your email lists...*Created by: roshanikothari*
Understanding Unsubscribe vs. Opt Out in CiviCRM
https://docs.civicrm.org/user/en/latest/email/mass-mailings-using-civimail/
You can provide several options for users to unsubscribe from your email lists.
Option 1: Manage Your Preferences
If you have several different email lists, you can provide users the options to select which lists they want to unsubscribe from.
Option 2: Unsubscribe from a specific Email List
You can give users the option to unsubscribe from that specific Email List (Group). There are some things to keep in mind if you go with this option. If someone Unsubscribes from this specific Email List, they could still get another bulk email if that is a different Email List (Group). Even though the user thinks they unsubscribed from receiving Bulk Emails from your organization, they have just unsubscribed from that specific Email List (Group). Another disadvantage is that they will no longer be included in the Group. For example, if you have a Group for Major Donors that you are using as a Mailing List, they will no longer be in that Group.
Option 3: Opt Out from Bulk Emails
Often users think that they are unsubscribing, they will not get any more bulk emails from your organization. However, in CiviCRM, unsubscribe actually means opt out. You can give people the option to either go to the Manage Your Preferences page or you can give people the option to Opt Out from all your bulk emails. Here's an example. If you have an email newsletter list, and someone unsubscribes from the list, they may still get a bulk email from your organization if you create a Smart Group that is a mailing list based on zip code/postal code. This Group is based on search, so it's not necessarily a list you may want to list on your Manage Your Preferences page. In this case, you may want to link the Unsubscribe link to Opt Out page, but call it "Unsubscribe." Here's the code to use. {action.optOutUrl} In the CiviCRM backend, under Communications Preferences, when someone Opts Out, this box will be checked 'NO BULK EMAILS (User Opt Out) Email Format.'https://lab.civicrm.org/documentation/docs/sysadmin/-/issues/3How should we use branches within this repository?2020-10-08T00:24:50ZhomotechsualHow should we use branches within this repository?*Created by: seancolsen*
The content in this guide is tricky because it has several dimensions. For example:
* CMS
* CMS *version*
* CiviCRM version
* And sometimes CiviCRM version is complicated... when we're talking about upgrad...*Created by: seancolsen*
The content in this guide is tricky because it has several dimensions. For example:
* CMS
* CMS *version*
* CiviCRM version
* And sometimes CiviCRM version is complicated... when we're talking about upgrading CiviCRM, the user is potentially dealing with two different major versions
I'm unsure how to organize all this, I'd like input from others.
The User Guide, by comparison, uses git branches to store different docs for 4.6 vs 4.7. We can use branches for the Sysadmin Guide too, but how do we want to use them?
Here is my proposal:
* Use branches `4.6` and `master` to represent the CiviCRM *target* version. In the case of *installing* this is straightforward. In the case of *upgrading* the reader would use the guide for the version they're upgrading *to* (not from). In rare cases where we might need to provide different documentation for point releases (e.g. 4.7.21 etc) then we would use [admonitions](https://docs.civicrm.org/dev/en/latest/documentation/markdown/#admonitions).
* For documentation that differs by CMS, use different pages within the guide.
* When CMS versions are substantially different (i.e Drupal), treat different versions (6, 7, 8) effectively as different CMS platforms. So, use different installation pages for "Drupal 7" and "Drupal 8".Wiki Migrationhttps://lab.civicrm.org/documentation/docs/dev/-/issues/79hook_civicrm_alterAPIPermissions - take image out of page2017-02-11T04:14:18Zhomotechsualhook_civicrm_alterAPIPermissions - take image out of page*Created by: seancolsen*
After importing the hooks (not done yet), the `hook_civicrm_alterAPIPermissions` page needs a little clean up. Figure out what is going on with that image at the bottom of the page and get it out of there. *Created by: seancolsen*
After importing the hooks (not done yet), the `hook_civicrm_alterAPIPermissions` page needs a little clean up. Figure out what is going on with that image at the bottom of the page and get it out of there. https://lab.civicrm.org/documentation/docs/user-en/-/issues/355Clarify permissions for 'profile listings and forms'2020-04-17T10:22:09ZhomotechsualClarify permissions for 'profile listings and forms'*Created by: wmortada*
I found the section on '[Using the "Profile listings and forms" permission](https://docs.civicrm.org/user/en/latest/initial-set-up/permissions-and-access-control/#using-the-profile-listings-and-forms-permission)' ...*Created by: wmortada*
I found the section on '[Using the "Profile listings and forms" permission](https://docs.civicrm.org/user/en/latest/initial-set-up/permissions-and-access-control/#using-the-profile-listings-and-forms-permission)' a bit unclear. I think it could be made clearer.
I have spent some time trying to understand exactly what the 'profile listing and forms' permission does. I believe that it is basically just a shortcut for applying all four separate permissions relating to profiles:
- profile create
- profile view
- profile edit
- profile listings
Could someone please confirm if this is true? If so, I would suggest that we make this explicit in the documentation. If not, I think we need to explain what this permission is more clearly.https://lab.civicrm.org/documentation/docs/user-en/-/issues/447CiviMail workflow support is undocumented2020-05-18T23:55:44ZhomotechsualCiviMail workflow support is undocumented*Created by: MegaphoneJon*
CiviMail has an option "Enable workflow support for CiviMail". This is undocumented; there are some tickets on Jira relating to its creation and bugs, but the only documentation I could find was in "Using Civ...*Created by: MegaphoneJon*
CiviMail has an option "Enable workflow support for CiviMail". This is undocumented; there are some tickets on Jira relating to its creation and bugs, but the only documentation I could find was in "Using CiviCRM", which is copyrighted. I'll ping @lcdservices and @JoeMurray; I don't know whether they'd be willing to let us use that in the official docs, who holds copyright, etc. If this isn't an option for whatever reason, we'll need to write copy.https://lab.civicrm.org/documentation/docs/sysadmin/-/issues/4Should we migrate install/upgrade docs for Drupal 6?2017-10-25T21:22:32ZhomotechsualShould we migrate install/upgrade docs for Drupal 6?*Created by: seancolsen*
I would like some opinions from others on this one.
Our downloads currently offer CiviCRM for Drupal 6:
![image](https://user-images.githubusercontent.com/42411/30514706-91ddd51e-9ad7-11e7-8e70-8b0a89b07...*Created by: seancolsen*
I would like some opinions from others on this one.
Our downloads currently offer CiviCRM for Drupal 6:
![image](https://user-images.githubusercontent.com/42411/30514706-91ddd51e-9ad7-11e7-8e70-8b0a89b0776c.png)
But the page on [installing for Drupal 6](https://wiki.civicrm.org/confluence/display/CRMDOC/Installing+CiviCRM+for+Drupal+6) has a big warning:
![image](https://user-images.githubusercontent.com/42411/30514721-f3538de8-9ad7-11e7-9398-66433ac379d3.png)
I'm leaning towards migrating this content as-is (with the warning). Do other people have thoughts on whether maybe I should remove the warning or maybe I should just not even migrate these Drupal 6 pages? Wiki Migrationhttps://lab.civicrm.org/documentation/docs/dev/-/issues/100"community" page vs https://civicrm.org/help2017-06-03T04:32:56Zhomotechsual"community" page vs https://civicrm.org/help*Created by: seancolsen*
Quite a bit of overlap between these two pages:
* https://civicrm.org/help
* https://docs.civicrm.org/dev/en/master/basics/community/
It would be nice to have one authoritative list of these community re...*Created by: seancolsen*
Quite a bit of overlap between these two pages:
* https://civicrm.org/help
* https://docs.civicrm.org/dev/en/master/basics/community/
It would be nice to have one authoritative list of these community resources. I think this is the *third* time I've found the list in multiple places. (I already cleaned up the duplicate situation in a couple other places.) Having it on civicrm.org does make sense. Perhaps we move content there and link Dev Guide readers to that page? I'm not sure.