Documentation issueshttps://lab.civicrm.org/groups/documentation/-/issues2023-04-27T21:38:13Zhttps://lab.civicrm.org/documentation/docs/dev/-/issues/872Update AngularJS Loader for new methods2023-04-27T21:38:13Zmattwiremjw@mjwconsult.co.ukUpdate AngularJS Loader for new methodshttps://docs.civicrm.org/dev/en/latest/framework/angular/loader/
See https://github.com/civicrm/civicrm-core/pull/20419
@colemanw @seamusleehttps://docs.civicrm.org/dev/en/latest/framework/angular/loader/
See https://github.com/civicrm/civicrm-core/pull/20419
@colemanw @seamusleehttps://lab.civicrm.org/documentation/docs/dev/-/issues/884Documentation contains discriminatory example2023-04-01T00:13:21Zkatharina.uDocumentation contains discriminatory exampleOn the following documentation page, there is an example for the API Call getoptions that I consider discriminatory.
https://docs.civicrm.org/dev/en/latest/api/v3/actions/
![Screenshot_2023-03-31_10-38-31](/uploads/ddf3b4c762072444f38b50...On the following documentation page, there is an example for the API Call getoptions that I consider discriminatory.
https://docs.civicrm.org/dev/en/latest/api/v3/actions/
![Screenshot_2023-03-31_10-38-31](/uploads/ddf3b4c762072444f38b508c7891028a/Screenshot_2023-03-31_10-38-31.png)
"Transgender" is not a 3rd gender next to "male" and "female". Instead, transgender people _**are**_ either male, female, or non-binary. More information as to why this is hurtful for trans people can be easily researched online.
I am implementing CiviCRM for an organisation fighting discrimination, including gender discrimination.
So I would be very glad if you could correct this mistake / exchange the example.
I propose the following:
array(
1 => 'Female',
2 => 'Male',
3 => 'Non-binary'
)https://lab.civicrm.org/documentation/docs-publisher/-/issues/103Documentation contains discriminatory example2023-03-31T12:56:00Zkatharina.uDocumentation contains discriminatory exampleOn the following documentation page, there is an example for the API Call getoptions that I consider discriminatory.
https://docs.civicrm.org/dev/en/latest/api/v3/actions/
![Screenshot_2023-03-31_10-38-31](/uploads/e4f4ab2e15031353b48dd8...On the following documentation page, there is an example for the API Call getoptions that I consider discriminatory.
https://docs.civicrm.org/dev/en/latest/api/v3/actions/
![Screenshot_2023-03-31_10-38-31](/uploads/e4f4ab2e15031353b48dd8fc3d4d07f9/Screenshot_2023-03-31_10-38-31.png)
"Transgender" is not a 3rd gender next to "male" and "female". Instead, transgender people _**are**_ either male, female, or non-binary. More information as to why this is hurtful for trans people can be easily researched online.
I am implementing CiviCRM for an organisation fighting discrimination, including gender discrimination.
So I would be very glad if you could correct this mistake / exchange the example.
I propose the following:
array(
1 => 'Female',
2 => 'Male',
3 => 'Non-binary'
)https://lab.civicrm.org/documentation/docs/installation/-/issues/2Fix google listing2023-01-09T10:38:54ZStoobFix google listingAlthough I don't believe this is an English specific Doc issue I don't know where else to put it.
As of February 9, google "civicrm documentation" and although we are the top listing this **No information is available for this page.** i...Although I don't believe this is an English specific Doc issue I don't know where else to put it.
As of February 9, google "civicrm documentation" and although we are the top listing this **No information is available for this page.** is displayed/
![co](/uploads/84b410fd05c839baa748b7c0ea5f1218/co.png)
Clicking "learn more" in Google brings you to this information page. https://support.google.com/webmasters/answer/7489871?hl=en I don't know why google feels this way. My guess is that it is a meta setting in the Doc website or on the server.https://lab.civicrm.org/documentation/docs/dev/-/issues/196Should we document more of the tools from civicrm-buildkit.git/bin/ ?2022-10-13T15:20:25ZhomotechsualShould we document more of the tools from civicrm-buildkit.git/bin/ ?*Created by: seancolsen*
This is mostly a question for @totten but others can weigh in too if they like...
Tim, you recently you wrote this [awesome how-to](https://civicrm.stackexchange.com/questions/17717/how-do-i-upgrade-civicrm-on-...*Created by: seancolsen*
This is mostly a question for @totten but others can weigh in too if they like...
Tim, you recently you wrote this [awesome how-to](https://civicrm.stackexchange.com/questions/17717/how-do-i-upgrade-civicrm-on-a-local-site-that-i-installed-with-buildkit-civibuil/17721#17721) and mentioned `givi` within it. But as far as I can tell `givi` pretty much isn't mentioned anywhere else, not even in the [list of tools included within buildkit](https://github.com/civicrm/civicrm-buildkit/tree/d20229ac9f63aaf183687157a5e655c953b81f5e#cli-tools). This is one example, but there are other tools in `civicrm-buildkit.git/bin/` which also didn't make the cut to be mentioned in that list.
Now that I've [copied that list into the Dev Guide](https://docs.civicrm.org/dev/en/latest/tools/#civicrm-specific-tools) I've begun to study it more closely and am wondering if it would be good to make it more comprehensive. Are there other tools (e.g. `givi`) which we should mention in this list? Or is it worth adding one more bullet point like *"And several other small tools which you can find in the `bin` directory"*?https://lab.civicrm.org/documentation/docs/dev/-/issues/192Find a place for "Your first pull request" tutorial2022-10-13T15:20:20ZhomotechsualFind a place for "Your first pull request" tutorial*Created by: seancolsen*
TL;DR: Grab the content from [Your First Pull Request](https://github.com/civicrm/civicrm-buildkit/blob/d20229ac9f63aaf183687157a5e655c953b81f5e/doc/daily-coding.md#your-first-pull-request) and find a home for i...*Created by: seancolsen*
TL;DR: Grab the content from [Your First Pull Request](https://github.com/civicrm/civicrm-buildkit/blob/d20229ac9f63aaf183687157a5e655c953b81f5e/doc/daily-coding.md#your-first-pull-request) and find a home for it in the Dev Guide.
I think it could potentially be incorporated into the [Contributing](https://docs.civicrm.org/dev/en/latest/core/contributing/) page by interspersing these commands into their relevant sections of that page.
Longer story: I'm migrating docs content out of the [buildkit repo](https://github.com/civicrm/civicrm-buildkit) and into the Dev Guide and as part of this process I'm deleting that [file](https://github.com/civicrm/civicrm-buildkit/blob/d20229ac9f63aaf183687157a5e655c953b81f5e/doc/daily-coding.md) which contains a mix of content that needs some work to be well-incorporated into the Dev Guide. I'm using issues to track the process of this migration, section-by-section, since I think the content will likely need to go to multiple placeshttps://lab.civicrm.org/documentation/docs/dev/-/issues/187Document common PHP utility functions2022-10-13T15:20:12ZhomotechsualDocument common PHP utility functions*Created by: MegaphoneJon*
Despite coding Civi for 7+ years, I still have only the haziest idea of what utility functions are considered best practice. This leads me (and many others, I'd wager) to copy/paste coding.
While this level ...*Created by: MegaphoneJon*
Despite coding Civi for 7+ years, I still have only the haziest idea of what utility functions are considered best practice. This leads me (and many others, I'd wager) to copy/paste coding.
While this level of documentation is best handled in code, some documentation of the most common utility functions - particularly those with security implications when not used - would be helpful.https://lab.civicrm.org/documentation/docs/dev/-/issues/180Clarify what to expect after you submit your first PR2022-10-13T15:20:09ZhomotechsualClarify what to expect after you submit your first PR*Created by: seancolsen*
Based on some [chat discussion](https://chat.civicrm.org/civicrm/pl/q1t7nmedbfb9irg55w4h7o6ayy) it'd be nice to add some clarity for developers to better understand what happens after they submit their first PR....*Created by: seancolsen*
Based on some [chat discussion](https://chat.civicrm.org/civicrm/pl/q1t7nmedbfb9irg55w4h7o6ayy) it'd be nice to add some clarity for developers to better understand what happens after they submit their first PR. This is [the relevant section](https://docs.civicrm.org/dev/en/latest/core/contributing/#open-a-pull-request) which needs improvement.
* [ ] Briefly explain the PR review process, and what developers can expect
* [ ] Link to the page on [PR reviewing](https://docs.civicrm.org/dev/en/latest/core/pr-review/)
related: #179https://lab.civicrm.org/documentation/docs/dev/-/issues/179Mention the need for Jenkins whitelisting in "Contributing"2022-10-13T15:20:06ZhomotechsualMention the need for Jenkins whitelisting in "Contributing"*Created by: seancolsen*
In this section: https://docs.civicrm.org/dev/en/latest/core/contributing/#open-a-pull-request
Add text which clarifies that the automated build process does not run if you're not whitelisted.*Created by: seancolsen*
In this section: https://docs.civicrm.org/dev/en/latest/core/contributing/#open-a-pull-request
Add text which clarifies that the automated build process does not run if you're not whitelisted.https://lab.civicrm.org/documentation/docs/dev/-/issues/178Review (and potentially reorganize) "Advanced patterns" page2022-10-13T15:20:00ZhomotechsualReview (and potentially reorganize) "Advanced patterns" page*Created by: seancolsen*
The [Advanced patterns](https://docs.civicrm.org/dev/en/latest/extensions/advanced/) page is kind of a grab bag of random stuff that seems like it should be better organized. Also it'd be nice if someone knowled...*Created by: seancolsen*
The [Advanced patterns](https://docs.civicrm.org/dev/en/latest/extensions/advanced/) page is kind of a grab bag of random stuff that seems like it should be better organized. Also it'd be nice if someone knowledgeable could look this page over and make sure everything here is still relevant.https://lab.civicrm.org/documentation/docs/dev/-/issues/63Migrate content from multiple sources about testing2022-10-13T15:19:53ZhomotechsualMigrate content from multiple sources about testing*Created by: seancolsen*
There is some content here related to testing:
https://github.com/civicrm/civicrm-core/blob/master/tests/README.md
which references:
https://wiki.civicrm.org/confluence/display/CRMDOC/Testing
I think it wou...*Created by: seancolsen*
There is some content here related to testing:
https://github.com/civicrm/civicrm-core/blob/master/tests/README.md
which references:
https://wiki.civicrm.org/confluence/display/CRMDOC/Testing
I think it would be good to move this content into the Dev Guide and delete the file from civicrm-core. Is that okay @totten ?https://lab.civicrm.org/documentation/docs/dev/-/issues/78Grab relevant content from Tim's "API and the Art of Installation" blog post2022-10-13T15:19:48ZhomotechsualGrab relevant content from Tim's "API and the Art of Installation" blog post*Created by: seancolsen*
This post: https://civicrm.org/blog/totten/api-and-art-installation*Created by: seancolsen*
This post: https://civicrm.org/blog/totten/api-and-art-installationhttps://lab.civicrm.org/documentation/docs/dev/-/issues/99Document error handling2022-10-13T15:14:20ZMichael McAndrewDocument error handlingI don't see (in the wiki or here) decent documentation on best practices for error handing, exceptions, etc. with CiviCRM. Would be nice to see. Including with the API.I don't see (in the wiki or here) decent documentation on best practices for error handing, exceptions, etc. with CiviCRM. Would be nice to see. Including with the API.https://lab.civicrm.org/documentation/docs/dev/-/issues/123Steal how-can-i-use-xdebug-with-civicrm-unit-tests from SE2022-10-13T15:14:16ZMichael McAndrewSteal how-can-i-use-xdebug-with-civicrm-unit-tests from SESee http://civicrm.stackexchange.com/questions/15896/how-can-i-use-xdebug-with-civicrm-unit-tests/15899See http://civicrm.stackexchange.com/questions/15896/how-can-i-use-xdebug-with-civicrm-unit-tests/15899https://lab.civicrm.org/documentation/docs/dev/-/issues/128Talk about Civi::log interface instead of legacy CRM_Core_Error::debug here: ...2022-10-13T15:14:11Zmattwiremjw@mjwconsult.co.ukTalk about Civi::log interface instead of legacy CRM_Core_Error::debug here: https://docs.civicrm.org/dev/en/master/dev-tools/debugging/https://lab.civicrm.org/documentation/docs/dev/-/issues/160New criteria for extensions review2022-10-13T15:14:08ZhomotechsualNew criteria for extensions review*Created by: davialexandre*
I would like to propose 2 new criteria for extensions review:
| Category | Criterion | Required for<br>*contributed*<br>extensions? | Required for<br>*official*<br>extensions? |
|------ | ----- | :----------...*Created by: davialexandre*
I would like to propose 2 new criteria for extensions review:
| Category | Criterion | Required for<br>*contributed*<br>extensions? | Required for<br>*official*<br>extensions? |
|------ | ----- | :-----------------------------: | :---------------------: |
| QA | The extension can be uninstalled successfully | **Required** | **Required** |
| QA | While being uninstalled, the extension cleans up all of its data (that is, it removes any tables, option groups/values, menus, custom fields/groups, etc that were created during the installation) | **Required** | **Required** |https://lab.civicrm.org/documentation/docs/dev/-/issues/164Document best practicies around template overrides vs changing pages with jQuery2022-10-13T15:14:01ZhomotechsualDocument best practicies around template overrides vs changing pages with jQuery*Created by: seancolsen*
*Migrated from part of this ticket: https://issues.civicrm.org/jira/browse/CRM-18702*
It would be nice if overriding files and templates was explained, and when it is possible to use jQuery modifications of the...*Created by: seancolsen*
*Migrated from part of this ticket: https://issues.civicrm.org/jira/browse/CRM-18702*
It would be nice if overriding files and templates was explained, and when it is possible to use jQuery modifications of the DOMhttps://lab.civicrm.org/documentation/docs/dev/-/issues/167Capture content from Tim's angular convensions gist2022-10-13T15:13:56ZhomotechsualCapture content from Tim's angular convensions gist*Created by: seancolsen*
@totten [said the following](https://chat.civicrm.org/civicrm/pl/jd7o61qd57g6uj89u1b1abtg6e):
i thought it might be useful to write down the convention i followed when writing angular code. i mention for a coup...*Created by: seancolsen*
@totten [said the following](https://chat.civicrm.org/civicrm/pl/jd7o61qd57g6uj89u1b1abtg6e):
i thought it might be useful to write down the convention i followed when writing angular code. i mention for a couple reasons:
* this convention is basically "stuff tim ran with a while back". if it should be changed, then i'd like to know which parts should change
* i'm not sure where the doc for it should go
url: https://gist.github.com/totten/49ae7d5fc67d9e32d15cd383f8e3959fhttps://lab.civicrm.org/documentation/docs/dev/-/issues/169Migrate SE content: "How to develop extension that relies on libs brought in ...2022-10-13T15:13:52ZhomotechsualMigrate SE content: "How to develop extension that relies on libs brought in by composer"*Created by: seancolsen*
Awesome stuff here written by @totten https://civicrm.stackexchange.com/questions/11357/how-to-develop-extension-that-relies-on-libs-brought-in-by-composer/11514#11514 Would be great to get this in the Dev Guid...*Created by: seancolsen*
Awesome stuff here written by @totten https://civicrm.stackexchange.com/questions/11357/how-to-develop-extension-that-relies-on-libs-brought-in-by-composer/11514#11514 Would be great to get this in the Dev Guide somewhere.https://lab.civicrm.org/documentation/docs/dev/-/issues/173Clarifications for the Style Guide2022-10-13T15:13:47ZhomotechsualClarifications for the Style Guide*Created by: stevekessler*
While working on some documentation recently I found myself looking to the Style Guide (https://docs.civicrm.org/dev/en/master/best-practices/documentation-style-guide/) and not finding the clarity I was looki...*Created by: stevekessler*
While working on some documentation recently I found myself looking to the Style Guide (https://docs.civicrm.org/dev/en/master/best-practices/documentation-style-guide/) and not finding the clarity I was looking for.
1. Is there an expected way to link to an external link. For example a link to a specific WordPress extension
2. We say that "Elements of the system and interface should be capitalized" but should the name of a text field be bold? We use bold for things you click in but what about the names of fields? Is the **Button Title Field** or the Button Title Field?
3. Also, should the _Edit Widget Colors_ be bolded in the phrase "expand the Edit Widget Colors fieldset."?
4. Is there a way that we should write CMS specific nomenclature? For example a Drupal Block, WordPress Widget, etc.?
You can look at https://docs.civicrm.org/user/en/latest/contributions/widgets/ to see where these examples started from?
Thanks,
Steve