Commit Graph

2845 Commits

Author SHA1 Message Date
Aaron Carlino
3fcbeaddef Reverse argument signature of pathed query properties 2018-10-18 11:22:51 +13:00
Aaron Carlino
1f6a84bd8b Add docs for new args/fields API 2018-10-18 11:22:51 +13:00
Federico Jaramillo Martínez
8e5ca9be38
Change rule names in array example 2018-10-11 10:12:38 -05:00
Federico Jaramillo Martínez
b9222cf421
Example to override a value that is an array.
Add an example for how to override a configuration value that has is array.
2018-10-11 10:09:40 -05:00
John Milmine
1fb4c6f39f Correcting docs around summary field relabelling
Although this is weird that it doesn't use the same logic and searchable fields.
2018-10-11 12:49:32 +01:00
Robbie Averill
7215637673
Merge pull request #8460 from open-sausages/pulls/4/lazy-loadable-gidfield
API Add a new GridFieldLazyLoader component
2018-10-11 13:43:10 +02:00
Loz Calver
554c34eff7
DOCS: Add YAML example for including extra JS in the CMS 2018-10-11 12:33:53 +01:00
Maxime Rainville
0b5a654d73 Add changelog entry for the GridFieldLazyLoader. 2018-10-09 17:33:23 +13:00
Maxime Rainville
d68f02ad25
Merge pull request #8393 from sachajudd/pulls/4/document-help-menu
DOCS Add docs for CMS help menu links
2018-10-05 14:02:14 +13:00
Robbie Averill
79812d10c2
Merge pull request #8441 from open-sausages/pull/4.3/refernce-new-search-in-changelog
Document new Search component in change logs.
2018-10-04 08:25:24 +00:00
Philipp Staender
fafd9dad6d
fixing name of constant ASSETS_PATH 2018-10-04 04:34:16 +02:00
Maxime Rainville
14a8707bf2 Address PR feedback for Search changelog 2018-10-04 13:35:48 +13:00
Maxime Rainville
191d93697d Document new Search component in change logs. 2018-10-04 13:29:48 +13:00
Sacha Judd
f5b6ce01cf DOCS Add docs for CMS help menu links
[ci skip]
2018-10-04 10:50:57 +13:00
Robbie Averill
ee24413c30 Merge branch '4.2' into 4 2018-10-03 15:28:05 +02:00
Robbie Averill
598e9358fd Merge branch '4.1' into 4.2 2018-10-03 15:27:51 +02:00
Sebastian Kalicki
9051fb923d
removed http... 2018-10-02 05:19:27 +02:00
Sebastian Kalicki
c6c9ce8fbf
added an http / https switch 2018-10-02 00:10:55 +02:00
Hans Philip Eide
140436692a
Update index.md
When exporting path to ~/.bash_profile the change do not take action before you reload the shell. Calling 'source  ~/.bash_profile' executes the change.
2018-09-28 15:44:58 +02:00
DorsetDigital
da38505446
Doc update - add FQCN to example code
Add fully qualified classname to aggregate caching example
2018-09-27 10:21:01 +01:00
Carlo1139
748409e61a
Typo in code snippet
Changed $ction to $action
2018-09-25 10:35:19 +02:00
Sam Minnée
5b7a84141b NEW: Add Hierarchy::prepopulate_numchildren_cache() (#8380)
* NEW: Add Hierarchy::prepopulate_numchildren_cache()
API: Hierarchy::stageChildren() customisations must be applied to the base class and not include record-specific behaviour.

Adds the ability to prepopulate the cache for Hierarchy::numChildren()
in a batch.

Note that this optimisation means that stageChildren() is not called on
each record in order to calculate numChildren(). This means that the
structure of the stageChildren() query must be the same for all records
and the behaviour cannot be customised only for a subclass of the base
data class. For example, apply your customisations to SiteTree and not
a subclass.

This is an useful part of optimising the query count on tree generation.
See https://github.com/silverstripe/silverstripe-framework/issues/8379

* NEW: Add Hierarchy::prepopulateTreeDataCache()

This provides a more extensible way of preopulating caches for optimised
tree generation.

Fixes https://github.com/silverstripe/silverstripe-framework/issues/8391
2018-09-25 12:25:23 +12:00
Ingo Schommer
a2bb70c46d FIX Don't flush manifests in tests by default
It's massively slowing down test execution,
particularly for rapid execution through test-driven-development (TDD)
2018-09-24 18:12:35 +12:00
Robbie Averill
3b7802bb51
Merge pull request #8388 from sminnee/showqueries-backtrace
NEW: Add ?showqueries=backtrace
2018-09-19 11:21:36 +02:00
Sam Minnee
40dde226fd NEW: Add ?showqueries=backtrace
This variant of showqueries will include a backtrace after each query.
This is extremely verbose but can be helpful when diagnosing where
queries have come from.

This is something that I have frequently added as a local hack on my
environment, I figured that exposing it as a formal feature would be
useful.
2018-09-19 14:28:40 +12:00
Luke Edwards
d9d22a2895 Update docs to reflect prop-types change 2018-09-19 10:05:49 +12:00
Ingo Schommer
605ea158e8
Merge pull request #8361 from open-sausages/pulls/4/release-docs
Release process docs
2018-09-17 13:55:53 +12:00
Luke Edwards
a33866ff4c
Merge pull request #8353 from open-sausages/pulls/4.2/2227-show-link-tracking
API: Add Link Tracking section to Relations developer guide
2018-09-13 14:23:34 +12:00
bergice
01db5c9e98 API: Add Link Tracking section to Relations developer guide and describe show_sitetree_link_tracking, show_file_link_tracking.
Refactor form scaffolder.
2018-09-13 11:02:09 +12:00
Ingo Schommer
7f05c7c6d4 DOCS Clarified latest vs. next 2018-09-13 08:11:07 +12:00
Ingo Schommer
793d6615eb DOCS Don't mention 5.3, its unsupported 2018-09-13 08:09:27 +12:00
Ingo Schommer
1f881f5c3f DOCS Clarify sec release process 2018-09-13 08:09:27 +12:00
Ingo Schommer
dd4bcac3a7 DOCS Release support clarification
See https://github.com/silverstripe/silverstripe-framework/issues/8189
2018-09-13 08:09:24 +12:00
Robbie Averill
54ebcc7ae4
DOCS Update references to extending Object in extensions doc 2018-09-12 16:39:59 +02:00
Robbie Averill
093b6b1646
Merge pull request #8369 from jmfederico/patch-2
Update 01_Extensions.md - Fix small typo
2018-09-12 16:35:17 +02:00
Stephan
710bc683fd
Removed SS_CONFIGSTATICMANIFEST 2018-09-10 16:10:35 +02:00
Federico Jaramillo Martínez
8244fe3a48
Update 01_Syntax.md - Fix How To's links 2018-09-09 15:59:58 -05:00
Federico Jaramillo Martínez
81dc13d2e7
Update 01_Extensions.md - Fix small typo 2018-09-09 15:47:03 -05:00
Federico Jaramillo Martínez
6e2b4c2558
Update 05_Template_Inheritance.md
Documentation mentions themes when talking about modules.
2018-09-09 10:07:49 -05:00
Nicholas Byfleet
0a2920d7e6
Update 04_Directory_Structure.md 2018-09-06 11:43:49 +12:00
Ingo Schommer
e5371091fa DOCS Simpler description on pull request target 2018-09-05 13:54:31 +12:00
Ingo Schommer
b4d5d9f1ff DOCS Clarified issue labelling 2018-09-05 13:54:17 +12:00
Martin D
b1563b73bf DOCS How to specify textual name with Email::admin_email (#8337)
* Allow use of display names with SwiftMailer

The syntax to allow display names with SwiftMailer is as follow:
`->setFrom(['john@doe.com' => 'John Doe'])`

Just like you set the `Email.admin_email`, you can set the default sender display name through the `Email.admin_email_displayname` configuration setting.

Refs:
- https://swiftmailer.symfony.com/docs/introduction.html#basic-usage
- https://docs.silverstripe.org/en/4/developer_guides/email/#administrator-emails

* Update Email.php

Simpler code using `Email.admin_email` as an associative array

* Update index.md

Added documentation showing how to add an email display name.
2018-08-29 11:42:12 +12:00
Loz Calver
dbfc253021
Fix incorrect version number in 4.3.0 changelog 2018-08-28 09:07:22 +01:00
maks
b9922a7314
$has_one docs
The ` $has_one` can be used both for `1-to-1` and `many-to-1` relations, depending on how is configured the inverse mapping on the related class. The documentation seems to suggest that `$has_one` implies a `1-to-1` relation, but then it gives an example of a `many-to-1` relationship. Since we are focusing on `$has_one` I would also put the `Player` class before the `Team` class.
2018-08-18 15:06:08 +02:00
Andrew Aitken-Fincham
a97e22c8f1
Update 07_Permissions.md
Added `$context` to `canCreate()` to reflect actual method signature.
2018-08-17 13:46:29 +12:00
Robbie Averill
b22f33ae84 Merge branch '4.2' into 4 2018-08-15 13:23:27 +12:00
Robbie Averill
48c6dec47d Merge branch '4.1' into 4.2 2018-08-15 13:23:07 +12:00
Robbie Averill
1ad2d6535e Merge branch '4.0' into 4.1 2018-08-15 13:22:46 +12:00
Bernard Hamlin
25c84709f1 Add detail to negation docs
I felt the negation docs didn't cover checking if a value was *not* another value and didn't point out that `not` can't be combined with other operators.

[ci skip]
2018-08-15 13:19:35 +12:00
Scott Hutchinson
3bd2cbf199 DOCS indentation on pagination guide [ci skip]
For all those copy + paste fiends
2018-08-14 15:36:52 +12:00
Nicholas Byfleet
6667203d73
Update index.md
Changed a sentence so that it makes sense.
2018-08-01 16:30:18 +12:00
Ingo Schommer
2d6964c243
Merge pull request #8261 from open-sausages/pulls/4/secure-remember-me-cookie
NEW Option for secure "remember me" cookie
2018-07-31 09:19:15 +12:00
Daniel Hensby
4d83330981
Merge branch '4.2' into 4 2018-07-30 17:11:42 +01:00
Ingo Schommer
114b0a5ea7
NEW Option for secure "remember me" cookie
Fixes #8234
2018-07-30 16:41:49 +01:00
root
9d7eefce1d Added 4.2.1 changelog 2018-07-30 14:12:55 +00:00
Daniel Hensby
d0598c02c5
Merge branch '4.2' into 4 2018-07-30 11:07:15 +01:00
Daniel Hensby
ec5640cbd9
Merge tag '4.2.0' into 4.2
Release 4.2.0
2018-07-30 11:04:57 +01:00
Maxime Rainville
fde7b9ddc5 FIX Specify minimum composer version
Specify the minimal version of composer to use in upgrading guide.
2018-07-30 12:35:49 +12:00
Loz Calver
ef335a8a30 Update many-many-through docs (closes #8290) 2018-07-27 09:30:13 +01:00
Maxime Rainville
900ca9c8d7 BUG Recommend install of upgrader with PHAR exec.
Update the Upgrading guide to recommend installing of the PHAR
executable of the upgrader over using `composer glboal require`.
2018-07-26 14:41:32 +12:00
Michal Kleiner
0035f4a907
Fix backtick in changelog breaking sentence formatting 2018-07-26 10:07:29 +12:00
root
1bcd449ace Added 4.2.0 changelog 2018-07-24 19:10:40 +00:00
Daniel Hensby
ae00147de1
Merge pull request #8280 from open-sausages/pulls/4/simpler-vary-header
FIX: Remove X-Requested-With from default Vary header
2018-07-24 01:45:07 +01:00
Ingo Schommer
9300e802f7
Updated caching docs (out of sync with implementation)
See https://github.com/silverstripe/silverstripe-framework/issues/8272
2018-07-23 19:09:10 +01:00
Sam Minnee
bde3121a33
FIX: Remove X-Requested-With from default Vary header
3.x forward port of https://github.com/silverstripe/silverstripe-framework/pull/8242
2018-07-23 14:18:05 +01:00
Daniel Hensby
ef97164c0a
DOCS Update docs to reflect true config merge priorities 2018-07-23 14:15:25 +01:00
lhasselb
06349f409b
Update 02_Sessions.md 2018-07-21 12:27:12 +02:00
DorsetDigital
4b90bb264a
Add use statement to example
Add the relevant 'use' statement to the sample code to remind people that it's needed!
2018-07-16 14:06:28 +01:00
Daniel Hensby
1a634f5ba6
Merge pull request #8244 from altwohill/column-not-distinct
Make column query not distinct
2018-07-16 13:01:32 +01:00
Daniel Hensby
89a2ce5d8f
DOCS Add changes to 4.3.0 changelog 2018-07-16 12:16:17 +01:00
Daniel Hensby
ac5c3416a4
Merge branch '4.2' into 4 2018-07-13 17:06:51 +01:00
Daniel Hensby
bd2abc7a12
Merge branch '4.1' into 4.2 2018-07-13 16:44:23 +01:00
Daniel Hensby
ec9281ee02
Merge branch '4.0' into 4.1 2018-07-13 16:42:00 +01:00
Daniel Hensby
d80ef3d9e6
DOCS Update docs to reflect true config merge priorities 2018-07-13 15:43:56 +01:00
Maxime Rainville
80b9ca4178
Use permanent url for install phar upgrader
[ci skip]
2018-07-10 13:57:41 +12:00
Maxime Rainville
eff2251942 DOCS Document how to install upgrader as a phar
[ci skip]
2018-07-06 12:37:08 +12:00
Maxime Rainville
3262665b2d Fix link and turn of phrase. 2018-07-03 10:12:59 +12:00
Lukas
cc9b36e011 fix link
@maxime-rainville Link is dead - I think #step1 describes it?
2018-07-03 10:12:59 +12:00
Ingo Schommer
dd9b8c94a5 DOCS Minor versioned edits
[ci skip]
2018-07-02 15:55:09 +12:00
Maxime Rainville
6108fbf2b4 Correct typo 2018-07-02 15:41:48 +12:00
Maxime Rainville
e0762d5a95 Complete version doc rewrite. 2018-07-02 15:41:48 +12:00
Maxime Rainville
d0a16bacd2 Documenting how to rollback and restore versioned DataObjects. 2018-07-02 15:41:47 +12:00
Maxime Rainville
81d27fcf9c Redrafting versioning doc WIP. 2018-07-02 15:41:47 +12:00
Maxime Rainville
bc7ada58b3 Restructure iversioning doc. 2018-07-02 15:41:47 +12:00
Juan Molina
5cd3180e85
Replace broken link to tutorial 2018-06-29 16:03:32 +02:00
Ingo Schommer
f7c001eaf8 Removed duplicate upgrade instructions
They're already present in the new upgrading guide

Folded upgrading "list of changes" into 4.0.0 guide

They duplicate each other, and create confusion in the upgrading
doc because there's *both* an "overview" of changes at the top,
and "important changes" at the bottom - why are they at the bottom when they're important?

Added "skip" and "continue" anchor links

[ci skip]
2018-06-27 15:17:06 +12:00
Ingo Schommer
9b6fb70c5d Removed "overview of changes" upgrading docs duplication 2018-06-27 15:16:42 +12:00
Ingo Schommer
1b06be1a64 Consistent upgrading crosslinks in changelogs 2018-06-27 15:16:30 +12:00
Maxime Rainville
580999b570 Correcting typo. 2018-06-27 15:16:30 +12:00
Maxime Rainville
4fb30da80e Update recipe-core and recipe-cms versions
Update recipe-core and recipe-cms version to use the retag 4.x releases.
2018-06-27 15:16:29 +12:00
Maxime Rainville
e80d3a8ff1 Remove the bits that said composer usage was optional. 2018-06-27 15:16:29 +12:00
Maxime Rainville
c8b6888582 Update the doc about the all command. 2018-06-27 15:16:29 +12:00
Maxime Rainville
3ceed740f4 Rename skip-namespace argument. 2018-06-27 15:16:29 +12:00
Maxime Rainville
c23ce32f88 Rewrite upgrading guide
🚧 Original upgrading doc.
I'm keeping it around just so I know what content hasn't been restructured.

🚧 Setting outline of new upgrading guide.

I'm just outlining the TOC here.
https://github.com/silverstripe/silverstripe-upgrader/issues/72

🚧 Typo correction.

🚧 Move most of original content into new structure.

📝 Documenting how to recompose your dependencies.

📝 Finish documenting the reorganise command.

📝 Add a conlusion to upgrade

📝 Drafting environment upgrade doc

Move environment upgrade doc out of change log and integrating it into the upgrading guide.

📝 Document how to namespace project

🚧 Working on step 4.

📝 Adding doc for the upgrade step.

Finalise first draft of the upgrade guide.

Remove typo

Implementing feedback on the doc.

Implementing upgrade guide feedback.wq

Add refrence to upgrade guide into change log.

Implement specific upgrade guide peer review suggestion.

Wording tweaks.

Remove reference to ACME and rewrite overview.

The end of the upgrading guide tweaks ... I think.
2018-06-27 15:16:26 +12:00
Luke Edwards
a33a08091d
Merge pull request #8212 from open-sausages/pulls/4/docs-app-folder-use
DOCS Consistent app/ folder and composer use
2018-06-26 13:09:24 +12:00
Ingo Schommer
259aa06010 DOCS More resilient example domain
myapp.com is owned, example.com is specifically reserved for documentation use cases:
https://en.wikipedia.org/wiki/Example.com

[ci skip]
2018-06-26 10:13:36 +12:00
Ingo Schommer
2e1e8e07b9 DOCS Consistent app/ folder and composer use
- Stronger wording around "use composer"
- Consistent domain and email address naming
- Removed example for publishing non-composer modules (those shouldn't be encouraged)
- Removed instructions for installing modules from archives

[ci skip]
2018-06-25 10:40:19 +12:00
Juan Molina
2b7f562297
Correct path in $ModulePath example
The images/ subfolder was missing from the example. That said, this is not working as expected for me (see  #8210).
2018-06-24 23:51:52 +02:00
Ingo Schommer
3b96a2c9ac DOCS Vendor paths for test docs
[ci-skip]
2018-06-25 08:53:57 +12:00