Commit Graph

947 Commits

Author SHA1 Message Date
Ingo Schommer
c61881a4c0
DOCS Clearer create module instructions (#9365)
* DOCS Clearer create module instructions

Incl. link to skeleton

* Update docs/en/02_Developer_Guides/05_Extending/00_Modules.md

Co-Authored-By: Garion Herman <garion@silverstripe.com>

Co-authored-by: Garion Herman <garion@silverstripe.com>
2020-01-08 10:41:28 +13:00
Valentino Pesce
c8c1c86d70
FIX: module link "recaptcha" not found 2019-12-23 15:38:27 +01:00
Andrew Aitken-Fincham
910f5efbf2 fix markdown tables for url variables documentation 2019-12-19 10:54:45 +00:00
Tristan
aad33e36d7
Change from "Team" to Team::class
To be consistent with the rest of the doc
2019-11-28 11:34:41 +13:00
Nicolaas
d1fc27d03a
MINOR: clearer distinction between class names and actual names 2019-11-26 15:57:45 +13:00
Stevie Mayhew
8e27a4f978
Merge pull request #9334 from open-sausages/pulls/4/doc-gridfield-protected-method
DOC Explain how to use the new protected getGridField and getGridFieldConfig methods on ModelAdmin
2019-11-26 07:45:55 +13:00
Loz Calver
f4713d95f6
Merge pull request #9333 from creative-commoners/pulls/4/canonicalurlmiddleware-docs
DOCS Add note about applying forceSSL to non-live environments
2019-11-25 11:37:30 +00:00
Maxime Rainville
b21c69d814 DOC Explain how to use the new protected getGridField and getGridFieldConfig methods on ModelAdmin 2019-11-25 12:41:24 +13:00
Garion Herman
bf38997b6e DOCS Add note about applying forceSSL to non-live environments 2019-11-25 12:14:26 +13:00
Aaron Carlino
e520a2b990 Fix broken callout tags 2019-11-19 13:53:43 +13:00
Ingo Schommer
cca6d8e1be DOCS Remove archive download references (#9250)
See https://github.com/silverstripe/silverstripe-framework/issues/9232.

Also simplifies composer instructions a bit:
- Removes composer update --no-dev references, that's a bit of an edge case that people can just discover on getcomposer.org if they need it
- Changed example from the unused and oudated silverstripe/forum to silverstripe/blog
- Updated example versions to 4.x
- Remove "updating composer" section, it now tells you if its out of date
- Remove ss-auto-git-ignore module reference. The module hasn't been updated in ages, and it's much less necessary now that all relevant modules are on composer
- Add .env example config to getting started docs, I didn't realise it was stripped from the default --prefer-dist composer install
2019-11-18 20:02:00 +13:00
Aaron Carlino
6888901468
NEW: Update docs to be compliant with Gatsby site (#9314)
* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon
2019-11-18 17:58:33 +13:00
DorsetDigital
999d277311
Change example domains
The current examples use an actual, real-world domain.   Have changed to the 'example.com' domain, reserved by IANA for this kind of purpose.
2019-11-14 08:35:08 +00:00
DorsetDigital
7e361b6127
Doc: Remove old reference to theme
Update siteconfig doc to remove reference to setting the current theme.
2019-11-09 10:28:05 +00:00
Mojmir Fendek
e2bea6b41f API Add withConfig method (#9011)
* With config functionality added.
* Update docs/en/02_Developer_Guides/04_Configuration/00_Configuration.md
2019-10-31 16:12:04 +13:00
Serge Latyntsev
bd2ccf70fa
Merge pull request #9282 from open-sausages/pulls/4/docs/clarify-basic-auth
DOCS Clarify BasicAuth limitations
2019-10-22 14:01:51 +13:00
Maxime Rainville
e59625fe5a
NEW Add ability to define image size preset for the TinyMCE editor. (#9276)
* NEW Add ability to define image size preset for the TinyMCE editor.
* DOC Explain how to define image size pre-sets
2019-10-22 11:50:28 +13:00
jeremy
7900d2aeb1
Update docs/en/02_Developer_Guides/06_Testing/00_Unit_Testing.md
Better worded

Co-Authored-By: Robbie Averill <robbie@averill.co.nz>
2019-10-18 11:23:44 +11:00
jeremy
1197b94415
Update Test documentation about database behaviours
This update is based on what I have experienced and this conversation on Slack https://silverstripe-users.slack.com/archives/C6PLF83H9/p1571281365001600
2019-10-18 10:38:23 +11:00
Ingo Schommer
8dcda91538 DOCS Clarify BasicAuth limitations 2019-10-10 10:41:39 +13:00
Serge Latyntcev
7dfc35d204 DOC Fix the required NodeJS version for CMS custamisation 2019-10-01 14:27:23 +13:00
Loz Calver
daf995da63
Fix syntax error in DataList docs 2019-09-30 09:36:12 +01:00
Maxime Rainville
d7f5ed3e65 DOC Substituce old apache syntax for Require 2019-09-25 16:59:48 +12:00
Garion Herman
637a891b8c DOC Include link to semver.org in modern JS / GQL warning 2019-09-25 11:22:04 +12:00
Garion Herman
3db0fa46b5 DOC Add warning about Semver status of modern JS / GraphQL tooling 2019-09-25 10:26:06 +12:00
Christopher Darling
c8f274de80
DOCS fix DataList::exclude() code example 2019-09-15 20:34:18 +01:00
Robbie Averill
b8e81983b9 DOCS Update PSR-12 compliance in GridField_ActionProvider docs code examples
[ci skip]
2019-09-13 18:09:10 -07:00
Robbie Averill
ed47f43133
Merge pull request #9169 from jakxnz/patch-1
Update 04_Create_a_GridField_ActionProvider.md
2019-09-13 18:05:51 -07:00
Ingo Schommer
229df95fe9 DOCS Warning about protected file serving in 4.x 2019-09-13 18:01:44 -07:00
Andre Kiste
75cd9dc944
Merge pull request #9202 from open-sausages/pulls/4/document-ss32-variant-migration
DOC Explain how to mgirate SS3.2 variants
2019-09-11 11:47:28 +12:00
Matt Peel
7083f016c1
Update secure coding standards
As of SS4.0.0 and the introduction of TrustedProxyMiddleware, the default now if no trusted proxies are defined is that nothing is a trusted proxy, whereas in SS3 a missing declaration was treated as everything being allowed.
2019-09-10 12:55:24 +12:00
Andre Kiste
23719af2a1
Apply suggestions from code review
Typos
2019-09-09 13:36:53 +12:00
Maxime Rainville
c165561580
Fix typos
Co-Authored-By: Robbie Averill <robbie@averill.co.nz>
2019-09-09 09:06:40 +12:00
Ingo Schommer
ca5b1cbf61 DOCS Rewrite server requirements
* Remove overly specific PHP RNG instructions (that's just built into PHP7 through random_bytes now, which will throw if no suitable RNG is available)
 * Remove PHP 5 RNG requirements, since we don't support that PHP release any mre
 * Remove verbose explanation of PHP 5.6 support
 * Remove conflicting instructions for PHP memory limits
 * Remove version numbers from supporetd databases other than MySQL, it's up to the community modules to define that
 * Remove Oracle support (code is nine years old!)
 * Make "community supported" status clearer on databases, people can draw their own conclusions as open source users on Github
 * Remove IIS version number, I think we should just stick to "needs web.config" and not give the impression that this is actively tested
 * Remove mention of OSes for web servers, that's kind of irrelevant in today's hosting world (containers, PaaS, etc)
 * Shorten install instructions in favour of a "quickstart" and point to lessons instead
 * Remove mention of archive download option, we really shouldn't promote this - composer is the de-facto standard
 * Add generic descriptions of the hosting environment considerations without going too much into specifics
 * Remove Apache version number, we don't test on different versions, and really mostly rely on mod_rewrite working properly. Laravel does the same (doesn't claim specific Apache version support)
2019-09-03 18:38:15 +12:00
Serge Latyntsev
296dc6a489 DOC Fix versioned snapshot image markdown (#9209) 2019-09-02 13:29:08 +12:00
Maxime Rainville
534e59faad DOC Explain how to mgirate SS3.2 variants 2019-08-28 15:08:55 +12:00
Ryan Potter
fa325d2360
Update pagination code snippet
Update pagination snippet to use summarised pagination.
2019-08-13 15:17:38 +12:00
Maxime Rainville
4380d7d155 API Add option to disable user-agent header session validation 2019-08-06 22:00:01 +12:00
Jackson Darlow
753b02d915
Update 04_Create_a_GridField_ActionProvider.md
Added missing parameters to boilerplate method
2019-08-06 13:36:45 +12:00
Jackson Darlow
9f7aad3b8f
Update 04_Create_a_GridField_ActionProvider.md 2019-08-06 13:32:44 +12:00
Robbie Averill
3224c9971b Merge branch '4.4' into 4 2019-08-02 11:24:54 +12:00
Robbie Averill
3b96c51688 Merge branch '4.3' into 4.4 2019-08-02 11:24:45 +12:00
Robbie Averill
2d2b0b82f0 DOCS Fix incorrect rendering of note on list item
[ci skip]
2019-07-25 12:03:12 +02:00
Robbie Averill
f1d8a04928
DOCS Fix broken markdown links for docs.silverstripe.org
[ci skip]
2019-07-22 13:02:57 +02:00
Ingo Schommer
4d93e48b10
DOCS Add silverstripe/login-forms (#9112)
See https://github.com/silverstripe/recipe-cms/issues/26.
Dependant on https://github.com/silverstripe/silverstripe-installer/pull/257.
2019-07-16 10:11:37 +12:00
UndefinedOffset
571a4d9ace NEW: Added support for config condition if PHP extension is loaded 2019-07-02 14:55:36 -03:00
Ingo Schommer
0a6096a1bb
DOCS File migration background notes (#9058) 2019-06-21 08:47:40 +12:00
Robbie Averill
dcf4c64704
Merge pull request #9077 from lerni/ss-log-example-config-docs-fix
fix #9075 log example yml-config in docs
2019-06-19 20:17:43 +12:00
lerni
0c7458cd21 add single quotes 2019-06-19 08:21:31 +02:00
lerni
e652b3e421 fix #9075 log example yml-config in docs 2019-06-18 09:17:25 +02:00
Ingo Schommer
732dfe5aaa DOCS Clarify cascade publish/delete perm checks
We decided during implementation not to check permissions explicitly on cascading objects due to performance concerns.
For example, when publishing a page with embedded images, publish permissions on the image are implied - even if Image->canPublish() would return false for this author.

See https://github.com/silverstripe-security/security-issues/issues/57
2019-06-18 16:27:29 +12:00
Guy Marriott
bb5b610636
Merge branch '4.4' into 4 2019-06-17 08:58:50 +12:00
Serge Latyntsev
2e33456e46 Mention versioned snapshots in the versions documentation (#9057)
* Mention versioned snapshots in the versions documentation

* Add screenshot
2019-06-16 23:52:30 +12:00
Rob Ingram
663e23fae3
Update 03_Track_member_logins.md
The extension point for members has changed from `memberLoggedIn` to `afterMemberLoggedIn`.
2019-06-12 10:13:20 +12:00
Juan Molina
ef5f2a526f
Minor revision, broken link
Minor typos and broken link corrected, added some typographic consistency.
2019-06-10 18:46:14 +02:00
Aaron Carlino
d04e54c1be Merge branch '4.4' into 4 2019-06-10 17:33:30 +12:00
Aaron Carlino
c747b1f8d3 Merge branch '4.3' into 4.4 2019-06-10 17:32:07 +12:00
Aaron Carlino
f766555d61 Merge branch '4.2' into 4.3 2019-06-10 17:27:05 +12:00
Serge Latyntcev
ca56e8d78e [CVE-2019-12246] Denial of Service on flush and development URL tools 2019-06-10 17:23:56 +12:00
Maxime Rainville
addf98a5e0 DOC Improve File migration do 2019-06-07 17:09:52 +12:00
blueskies79
cad84974d2
Update Config example namespace
I think it's handy to add this namespace to the docs ;-)
2019-06-06 11:43:28 +02:00
Ingo Schommer
30496144b9 DOCS More detail on queuedjobs file migrations 2019-06-05 15:10:09 +12:00
Loz Calver
487beb40ce
Merge pull request #9004 from blueskies79/patch-2
Update 04_Data_Types_and_Casting
2019-05-30 09:23:06 +01:00
Maxime Rainville
5b6d0946f4 API Add extension points to MigrateFileTask (#8994)
* API Add extension points to MigrateFileTask

* Apply suggestions from code review

Co-Authored-By: Guy Marriott <guy@scopey.co.nz>
2019-05-28 09:24:01 +12:00
Maxime Rainville
9bfce8c1a4 API Add extension points to MigrateFileTask (#8994)
* API Add extension points to MigrateFileTask

* Apply suggestions from code review

Co-Authored-By: Guy Marriott <guy@scopey.co.nz>
2019-05-28 09:19:05 +12:00
blueskies79
c7eede1d66
Reverted DBField & list both [Field] and [DBField]
I changed the list of types to the suggested format for clarity and changed Field back to DBField as suggested.
2019-05-26 15:40:25 +02:00
blueskies79
f08915ccf2
Update 04_Data_Types_and_Casting
This is a suggestion to update the docs to use the actual type names used in code. All the examples use the non-DB type names (ie: 'Wheels' => 'Int') but the bulleted list suggests it should be 'Wheels' => 'DBInt'. This is a bit confusing for new SS developers. Could we change this?
2019-05-23 12:09:59 +02:00
Ingo Schommer
75f87ac409 DOCS Grammar fixes 2019-05-23 10:38:56 +12:00
Ingo Schommer
1cb22b665d DOCS Clarify different file access types
[ci-skip]
2019-05-23 09:25:46 +12:00
Ingo Schommer
74c869f362 DOCS Note about custom File->canView()
See https://github.com/silverstripe/silverstripe-framework/issues/8493

[ci-skip]
2019-05-23 09:14:36 +12:00
Ingo Schommer
c82c1520fc DOCS Clarified file permission control
[ci-skip]
2019-05-23 09:08:08 +12:00
Guy Marriott
b9a8f64ef0
Update wording in example in syntax docs 2019-05-20 16:38:55 +12:00
Federico Jaramillo Martínez
368c88d59a
Fix link to related lesson 2019-05-14 12:06:17 -05:00
Sebastian Kalicki
e83edf7e94
Update 00_Configuration.md 2019-05-09 11:28:11 +02:00
Vinnie
168a4fe489
Update docs for GridField_ActionMenuItem required parameters
I found these errors while going through this tutorial,
missing ```use use SilverStripe\Forms\GridField\GridField;```

interface GridField_ActionMenuItem required parameters on  getTitle() and getGroup()

incorrect if statement on getExtraData() - $field is not defined
2019-05-09 09:01:54 +12:00
Ingo Schommer
1f78e8ae80 NEW Clean up secureassets module artefacts (#8948)
See https://github.com/silverstripe/silverstripe-assets/issues/231
2019-05-02 21:05:19 +12:00
Andre Kiste
48db515fbd NEW Fix folder permissions (#8950)
* Add `FixFilePermissionsHelper` subtask
* Changed name to folder permissions, added more loggin
2019-05-02 16:28:57 +12:00
Ingo Schommer
0696045e59 NEW Legacy thumbnail migration task (#8924)
* NEW Legacy thumbnail migration task

See https://github.com/silverstripe/silverstripe-assets/issues/235
Makes a start at https://github.com/silverstripe/silverstripe-assets/issues/219 as well

* API Removed migrate_legacy_file support

For the vast majority of sites, you really don't want to run your file migration as part of dev build.
The step is involved enough to warrant it's own task.
I don't think this is an API change, since the setting won't have affect
for anyone who has already enabled it - they would've already done the one-off migration.

See https://github.com/silverstripeltd/open-sourcerers/issues/91
and https://github.com/silverstripe/silverstripe-assets/issues/235
2019-05-02 09:33:53 +12:00
Adrian Humphreys
e648fd31f9 Docs: Update Dynamic_Default_Fields.md (#8941) 2019-04-30 09:00:09 +12:00
Garion Herman
5c4367f46b Use environment variables in example SMTP config
Currently the email documentation provides an example of how to use the SMTP adapter in SwiftMailer, but this example hardcodes the password in the config file which is a security issue. It is possible to reference environment variables instead, so we should document and encourage this.
2019-04-30 08:59:54 +12:00
Adrian Humphreys
212a99c904 Add info around namespacing with controllers 2019-04-30 08:59:29 +12:00
Ingo Schommer
da91f44c00 DOCS File migration changes for 4.4.0 (#8910)
* DOCS File migration changes for 4.4.0

See https://github.com/silverstripe/silverstripe-versioned/issues/177

* Update docs/en/02_Developer_Guides/14_Files/03_File_Security.md

Co-Authored-By: chillu <ingo@silverstripe.com>

* Corrected statements on archived/versioned files

* Corrected statement on filesystem paths of protected vs. public

* Update docs/en/02_Developer_Guides/14_Files/03_File_Security.md

Co-Authored-By: chillu <ingo@silverstripe.com>

* Clarify redirect behaviour
2019-04-30 08:59:25 +12:00
Erlend Mongstad
80b097eb68
Added missing Permission class to example
Following the example will give the following error;

```[Emergency] Uncaught Error: Class {my namespace}\Permission not found```

Added the missing class
2019-04-17 02:36:13 +02:00
Robbie Averill
6b07b2c47c Update docs/en/02_Developer_Guides/01_Templates/How_Tos/03_Disable_Anchor_Links.md
Fix code styling

Co-Authored-By: DorsetDigital <DorsetDigital@users.noreply.github.com>
2019-04-16 22:32:55 +01:00
DorsetDigital
321ef827b8
Update 03_Disable_Anchor_Links.md
Update example code for disabling anchors on a per-instance basis.  The previous code was unclear and statically called a non-static method on SSViewer  (presumably this was SS3 code)
2019-04-16 21:22:27 +01:00
Robbie Averill
8a06682e31 Merge branch '4.3' into 4
# Conflicts:
 #	src/ORM/Connect/DBSchemaManager.php
2019-04-11 11:24:17 +12:00
Ingo Schommer
fcdc146996 DOCS Limitations of publishall
Fixes https://github.com/silverstripe/silverstripe-cms/issues/2406
2019-04-10 10:42:49 +12:00
Al
9a43952385
Fix formatting
Last code block was not closed
2019-04-10 08:22:51 +12:00
Guy Marriott
a9d57f5bfb
Merge pull request #8241 from creative-commoners/pulls/4.3/separate-logging
Separate core error logging from standard LoggerInterface
2019-04-05 08:49:09 +13:00
Hayden Shaw
30775aa428
DOCS HistoryViewerField updates
* Add missing rollback operation in scaffolding example
* Update block_id references to id  to allow query to read query to run successfully in conjunction with HistoryViewerField
2019-04-02 16:59:52 +13:00
Anton Smith
167881cc38 Update path 2019-04-02 12:46:19 +13:00
Andre Kiste
f3535972e4 DOC Add more clear instructions on handling upgrade conflicts (#8836)
* Add more clear instructions on handling upgrade conflicts

* More module upgrading info

* Make it make sense

* Tweak sentence
2019-03-26 16:20:53 +13:00
DorsetDigital
abe76e9b29
Update 02_RSSFeed.md
Change file name to PageController to match code.
Change example code to use parameter in `Link()` method rather than using concatenation
2019-03-23 13:22:37 +00:00
Joe Chenevey
af34fab461
Update 00_CSV_Import.md
Fix reference in `$model_importers` to use `Player::class` for namespaced model reference.
2019-03-18 10:55:41 -04:00
Ingo Schommer
71c32fea20 DOCS Clarify legacy_filenames=true tradeoffs 2019-02-28 08:56:53 +13:00
Ingo Schommer
1f08ed3765 DOCS Note about replaced files on keep_archived_files flag 2019-02-28 08:27:29 +13:00
Ingo Schommer
b4b2f576f0 DOCS Clarify file migration and mention known bug 2019-02-26 09:44:32 +13:00
Scott Hutchinson
57184c245c
DOCS Update HTTP Cache headers docs to include note about testing in dev mode [ci skip] 2019-02-22 10:16:11 +13:00
Robbie Averill
3e90fdf42f Merge branch '4.3' into 4 2019-02-19 08:41:05 +07:00
Robbie Averill
ed74549c4f Merge branch '4.2' into 4.3 2019-02-19 08:39:59 +07:00