Commit Graph

1086 Commits

Author SHA1 Message Date
Stevie Mayhew
38a62425f8
Merge pull request #9849 from edwilde/patch-3
DOC add a callout to the deprecation notice
2021-02-15 10:51:32 +13:00
Stevie Mayhew
4583046195
Merge pull request #9855 from edwilde/patch-7
DOC: fix api link syntax and a couple of typos
2021-02-15 10:50:54 +13:00
Stevie Mayhew
63073f7ae5
Merge pull request #9854 from edwilde/patch-6
DOC: fix broken heading
2021-02-15 10:50:19 +13:00
Stevie Mayhew
97df9725e5
Merge pull request #9852 from edwilde/patch-5
DOC: fix invalid syntax on link
2021-02-15 10:49:55 +13:00
Stevie Mayhew
f3ff7b7bbb
Merge pull request #9858 from edwilde/patch-9
DOC: fix typo
2021-02-15 10:49:16 +13:00
Ed Wilde
e60a25cfbd
DOC: fix typo
Fixing typo in searchable fields description.
2021-02-15 10:31:38 +13:00
Ed Wilde
12943d0616
DOC: fix typo 2021-02-15 10:28:52 +13:00
Ed Wilde
01eedff4a4
DOC: fix api link syntax and a couple of typos
The link to the api documentation for `writeWithoutVersion()` was invalid and not rendering as a link. Also fixed a couple of typos in surrounding text.
2021-02-15 09:47:54 +13:00
Ed Wilde
3a214a2ed3
DOC: fix broken heading
It appears there may be a bug in gatsby which causes code blocks in headings to not be output. I can't find a specific issue in their project to link this to, so it might be best to simply remove the code block here allowing the header to display correctly.
2021-02-15 09:24:15 +13:00
Ed Wilde
da56fa785b
DOC: fix invalid syntax on link
Fixing the markdown syntax for the link to HTTP Cache Headers.
2021-02-12 16:11:36 +13:00
Ed Wilde
300cef2bd1
Merge branch '4' into patch-3 2021-02-12 15:44:48 +13:00
Bryn Whyman
54f439ace0
Merge pull request #9848 from edwilde/patch-2
DOC complete first sentence describing middleware
2021-02-12 11:33:26 +13:00
Ed Wilde
cf50aa71b5
DOC: fix missing closing backtick for code display, add required alt attribute
Otherwise the code is output as html, and displays as a missing image. The alt attribute is required for image tags, whereas self closing is no longer required for html5.
2021-02-11 12:18:36 +13:00
Ed Wilde
c3499d20e5
DOC add a callout to the deprecation notice
This seems more inline with other docs pages I have seen.
2021-02-11 11:33:01 +13:00
Ed Wilde
95a142a9de
DOC complete first sentence describing middleware
To me, the existing sentence did not look complete.
2021-02-11 11:25:24 +13:00
Ingo Schommer
1be5f471de DOCS Resolver signature and context provider examples 2021-02-05 11:19:08 +13:00
Aaron Carlino
8c2a9ba07a Document edge case for non-assets install 2021-02-03 14:10:53 +13:00
Maxime Rainville
062656d923 DOC Add "Defining the ModelAdmin models" section 2021-01-30 23:00:29 +13:00
Aaron Carlino
24ca17053d Docs for GraphQL 4 changes 2021-01-28 11:10:24 +13:00
Aaron Carlino
caa224e37b DOCS: Remove BuildState documentation 2021-01-28 11:10:24 +13:00
Lars Prakken
7a1a1dc132
Update index.md
The piece in the docs regarding adding a value to the list of common languages is not valid anymore.

SS4 uses the php-intl extension,  so before adding an extra locale, the user needs to check whether the installed ICU lib on the server supports it.

If that is the case,  the locale can added through the config system by adding a piece of yaml.
2021-01-21 15:23:30 +01:00
Ingo Schommer
070e950c06
Merge pull request #9778 from christopherdarling/patch-18
DOCS replace broken Director link to Routing
2021-01-14 11:38:43 +13:00
Ingo Schommer
315e8f5a1b
Merge pull request #9736 from open-sausages/pulls/4/docs-protected-folder
DOCS Recommend moving .protected out of webroot
2021-01-14 11:13:01 +13:00
Ingo Schommer
d308bb022c
DOCS GraphQL blacklisted fields (#9768) 2021-01-14 10:19:24 +13:00
Ingo Schommer
f029680209
Merge pull request #9782 from open-sausages/pulls/4/docs-caching-filesystem
DOCS Filesystem capacity issue potential on caches
2021-01-14 09:15:51 +13:00
Ingo Schommer
87cff9c492
Merge pull request #9792 from lerni/patch-1
fix indentation in yml example for Resampled image quality
2021-01-14 09:15:26 +13:00
Ingo Schommer
ebce0cc825
Merge pull request #9793 from open-sausages/pulls/4/docs-graphql-getbylink
DOCS GraphQL filter plugin
2021-01-14 09:14:51 +13:00
Patrick Nelson
157d426d39
FIX: URL to Symfony cache adapters
Fix URL to Symfony cache adapters and also addressing some weird double-bullet formatting.
2020-12-27 19:41:09 -08:00
Martin D
869aaa79ab
DOC Fix FlysystemAssetStore reference (#9807)
Fixed `FlysystemAssetStore` namespace in YML configuration
2020-12-22 15:55:45 +13:00
Ingo Schommer
835284fdfe DOCS GraphQL filter plugin
See https://github.com/silverstripe/silverstripe-cms/pull/2620

[skip ci]
2020-12-08 13:50:01 +13:00
Ingo Schommer
a9f9de167a
Merge pull request #9777 from unclecheese/pulls/4/plugin-away
DOCS: Document new stateless plugins
2020-12-08 10:17:47 +13:00
Lukas
61afab2ed8
fix indentation 2020-12-07 12:08:31 +01:00
Aaron Carlino
fe972d62d5
DOCS: Document new schema config, change to resolver discovery pattern (#9781) 2020-12-01 21:27:52 +13:00
Ingo Schommer
40d19d04ec DOCS Filesystem capacity issue potential on caches
Context: https://github.com/silverstripe/silverstripe-framework/issues/6678
2020-11-25 17:05:33 +13:00
Christopher Darling
154fb70468 DOCS replace broken Director link to Routing 2020-11-19 17:53:31 +00:00
Aaron Carlino
e69cfd152e DOCS: Document new stateless plugins 2020-11-19 13:27:08 +13:00
Scott Hutchinson
bdb2deb3f5
DOCS Update HistoryViewerField to require javascript more consistently (#9773) 2020-11-16 13:56:50 -08:00
wernerkrauss
f673996aa0
DOCS Fix classname reference in SearchContext docs (#9771)
`static::class` is also used by `DataObject::getDefaultSearchContext()`.
2020-11-16 10:34:15 +13:00
Steve Boyd
f21515e0b1 Merge branch '4.7' into 4 2020-11-12 15:13:46 +13:00
James Cocker
37a5c9af15
01_Error_Handling: % wrapped in quotes
Ensures % wrapped in quotes for Silverstripe 4.7 support
2020-11-06 16:08:53 +00:00
Steve Boyd
4d0dc9176b
DOC Document nullable DataObject in used on table extension guide (#9755) 2020-11-04 12:15:26 +13:00
Steve Boyd
3cde64a7aa DOC Document the file usage table
Co-authored-by: Bryn Whyman <bryn.whyman@silverstripe.com>
2020-11-03 14:24:42 +13:00
Aaron Carlino
51b4a76bd8 Graphql doc fix 2020-11-01 13:10:10 +13:00
Aaron Carlino
c1cda2b113
WIP: Add new graphql 4 docs (#9652)
* DOCS: Add new graphql 4 docs

* Reorganise docs

* Docs done

* Basic graphql index page

* TOC for getting started

* show folders on graphql index page

* Add middleware note

* Docs update

* Update docs to reflect flushless schema

* Docs updates

* Docs for getByLink

* Query caching docs

* Docs on nested operations

* update docs for new graphql dev admin

* Docs for configurable operations

* Replace readSiteTrees with readPages

* Schema defaults docs

* Docs for inherited plugins

* Docs for customising *

* Docs for field whitelisting

* Change whitelist word

* New docs on modelConfig

* Document dev/build extension

* Document default/global plugins

* Document new input type fields config

* Apply suggestions from code review

Co-authored-by: Andre Kiste <bergice@users.noreply.github.com>

* Note about when procedural schema gets built

* Fix link

* Apply suggestions from code review

Co-authored-by: Andre Kiste <bergice@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Andre Kiste <bergice@users.noreply.github.com>

* DOCS Note about plugins in custom queries

* DOCS Note about filter and custom resolvers

* DOCS Note about canview paging

* DOCS Updated guidance on _extend

See https://github.com/silverstripe/silverstripe-graphql/issues/296

* Apply suggestions from code review

Co-authored-by: Andre Kiste <bergice@users.noreply.github.com>

* DOCS Pre-release warning

Co-authored-by: Ingo Schommer <ingo@silverstripe.com>
Co-authored-by: Andre Kiste <bergice@users.noreply.github.com>
Co-authored-by: Ingo Schommer <me@chillu.com>
2020-10-20 10:56:17 +13:00
Ingo Schommer
fee31c2c6c DOCS Recommend moving .protected out of webroot
Note that it's currently unclear whether Silverstripe Cloud or CWP support this,
but it shouldn't block us from recommend this in the open source project.
It's documented in the "server requirements", which should make it pretty
clear that this requires you to have control over server configuration (or check with those that have).

See https://github.com/silverstripe/silverstripe-framework/issues/7710
2020-10-15 17:08:37 +13:00
Serge Latyntcev
c2d8d2790f DOC Document partial template caching aggregates recommendation 2020-10-05 11:29:19 +13:00
Guy Marriott
478d487f0e
Merge pull request #9707 from robbieaverill/pulls/4.7/exceptions 2020-10-01 17:16:43 -07:00
Dylan Grech
effe5c2e6f
#9706: Updated doc for case-sensitive filter (#9710)
* #9706: Updated doc for case-sensitive filter

* #9706: Updated doc for case-sensitive filter

Co-authored-by: Dylan Grech <dylangrech@innovativecodes.com>
2020-09-26 10:02:21 +12:00
Robbie Averill
27bd5d12e3 ENH Replace E_USER_ERROR errors with exceptions 2020-09-24 23:51:21 -07:00
RuthAdele
4e22277c69
Add namespacing to YAML example 2020-09-25 13:58:12 +09:30
Michael Pritchard
86702f0ad4 Updated 00_Unit_Testing.md (#9699) 2020-09-18 14:13:08 +01:00
Garion Herman
a712000404
Merge pull request #9682 from silverstripe-terraformers/feature/partial-cache-docs
DOCS: Example of partial cache expiry setting.
2020-09-16 15:49:50 +12:00
RuthAdele
bd2f017557
Update 02_Pagination.md
Adding commonly used $FirstItem and $LastItem to the Template Variables list.
2020-09-14 21:26:33 +09:30
cloph
13725d2f92
DOC HistoryViewer: explain "magic names" (#9670)
DOC HistoryViewer: explain "magic names"
GraphQL scaffolding uses names consisting of the first part of the namespace and the classname, but to inject it to the HistoryViewer field you need to use the database table name.
Co-authored-by: Steve Boyd <emteknetnz@gmail.com>
2020-09-12 12:56:23 +12:00
Mojmir Fendek
2c1cb79156 DOCS: Example of partial cache expiry setting. 2020-09-11 08:58:44 +12:00
Serge Latyntcev
d9c0b079d1 DOC Fix Partial Template Cache documentation header 2020-09-10 12:58:16 +12:00
Jackson Darlow
2753f823ee
DOC Added a tip to docs describing how to set a cookie for less than a day (#9552)
DOC Added a tip to docs describing how to set a cookie for less than a day
Co-authored-by: Garion Herman <garion@silverstripe.com>
2020-09-10 12:34:33 +12:00
Steve Boyd
589631df00
Merge pull request #9280 from open-sausages/pulls/4/doc-breadcrumb
DOC Update breadcrumb template in theme rather than app.
2020-09-10 09:48:23 +12:00
Serge Latyntcev
e632ee3e52 DOC Update Partial Template Cache documentation
- create a new documentation section explaining the "cached" block
 - clean up the Performance documentation section,
   moving explanations about "cached" block away,
   adding new warnings and recommendations
2020-09-07 13:45:08 +12:00
Maxime Rainville
4ee7102761 DOC Update breadcrumb template in theme rather than app. 2020-09-02 13:23:24 +12:00
Jackson Darlow
699913406b
NEW Added a dev view to output the current config from dev/config (#9542)
* #3236 Added dev/config view

* Refactored use of echo to

* Added config/audit for matching missing property definitions in the current config

* Minor enhancements to dev/config implementation
2020-08-28 07:19:03 +12:00
Ingo Schommer
bffb7e2577 Revert "DOCS MFA authentication"
Underlying feature isn't merged yet,
see https://github.com/silverstripe/silverstripe-installer/issues/280

Revert "Update docs/en/02_Developer_Guides/09_Security/03_Authentication.md"

This reverts commit 72a02a3d0e.

Revert "Update docs/en/02_Developer_Guides/09_Security/03_Authentication.md"

This reverts commit c54f8e4864.

Revert "DOCS MFA authentication"

This reverts commit 5fe5833fb2.
2020-08-20 18:40:59 +12:00
Ingo Schommer
f8b4570cb1
DOCS MFA authentication (#9536)
See https://github.com/silverstripe/silverstripe-installer/issues/280
2020-08-20 18:33:36 +12:00
Ingo Schommer
72a02a3d0e
Update docs/en/02_Developer_Guides/09_Security/03_Authentication.md
Co-authored-by: Serge Latyntsev <dnsl48@gmail.com>
2020-08-20 18:32:57 +12:00
Ingo Schommer
c54f8e4864
Update docs/en/02_Developer_Guides/09_Security/03_Authentication.md
Co-authored-by: Serge Latyntsev <dnsl48@gmail.com>
2020-08-20 18:32:39 +12:00
Maxime Rainville
9f94c739c1 DOC Correct the example for getters/setters 2020-08-06 10:15:14 +12:00
Robbie Averill
821ef9559a
Merge pull request #9618 from open-sausages/pulls/4/docs-hostname
DOCS HTTP header in server requirements
2020-07-29 10:44:29 -07:00
Ingo Schommer
b6169a87c2 DOCS HTTP header in server requirements 2020-07-29 14:28:20 +12:00
Robbie Averill
84b4057a9a
Merge pull request #9406 from chrispenny/feature/standardise-get-cms-validator
v4 improvement: Standardise getCMSValidator for DataObjects/Forms
2020-07-16 15:58:33 -07:00
Aaron Carlino
f13c928b14 Fix _images pathing 2020-07-15 11:32:38 +12:00
Damen Hansen
d5893bf23c
Update 01_File_Management.md
Changed very small typo in setAllowedExtensions. Changed Extensiones to Extensions.
2020-07-13 14:20:27 +12:00
Garion Herman
d408a4e714 Merge branch '4.6' into 4 2020-07-13 12:28:14 +12:00
Garion Herman
fbe0f5a981 Merge branch '4.5' into 4.6 2020-07-13 12:27:02 +12:00
Maxime Rainville
0eb476916d DOC Explain how to implement a custom QueryPermissionChecker 2020-07-10 17:59:49 +12:00
scttw
34f5004b26
Update 04_Rendering_Templates.md
The method of including a Layout template into a full template file isn't documented, and isn't intuitive especially if you have come from the SS3 way of doing it via $this->customise($data)->renderWith(['MyCustomTemplate', 'Page']);  Adding this as an example will help people add layout templates to Controller actions, and form responses where a custom layout needs to inherit it's parent template.
2020-07-08 16:15:32 +10:00
Maxime Rainville
87c041b92d
DOC Add extra information on how to customise a file HTTP response
* DOC Add extra information on how to customise an file HTTP response
* Apply suggestions from code review
Co-authored-by: Robbie Averill <robbie@averill.co.nz>
2020-06-30 15:54:42 +12:00
James Cocker
b4a3cc700a
Fixes getCMSFields TabSet example
Current example results in: "[Emergency] Uncaught InvalidArgumentException: TabSet can only contain instances of other Tab or Tabsets"
2020-06-29 16:37:26 +01:00
Loz Calver
64688dbc10
Merge pull request #9563 from shoosah/patch-1
Update 02_HTTP_Cache_Headers.md
2020-06-29 09:46:28 +01:00
Sherry Shahbazi
04872742eb
Update 02_HTTP_Cache_Headers.md 2020-06-29 15:54:17 +12:00
mr-macedawg
d7885adf34
Update 09_Casting.md
Changed SS_DateTime to DBDatetime as SS_DateTime was changed to DBDateTime in version 4.0
2020-06-29 12:15:01 +10:00
Sam Minnée
714c4cba9c
Merge pull request #9546 from andrewandante/feature/disambiguate_first_methods_on_lists
deprecate First and Last in order to disambiguate for array lists
2020-06-23 14:46:29 +12:00
Guy Marriott
4df45f4fe0
Merge pull request #9550 from jakxnz/pulls/4/docs-regarding-cached-get-ones
Added documentation regarding some cached ORM scenarios
2020-06-17 09:04:07 -07:00
Jackson Darlow
6813c0f7e8 Added documentation regarding some cached ORM scenarios 2020-06-17 17:17:04 +12:00
Andrew Aitken-Fincham
7c95237e8d update template docs, move deprecation to 5.0, capitalise Is 2020-06-15 12:25:13 +01:00
Jackson Darlow
ae1a883b32 Added mention of Session.timeout to secure_coding docs 2020-06-12 14:43:37 +12:00
Ingo Schommer
5fe5833fb2 DOCS MFA authentication
See https://github.com/silverstripe/silverstripe-installer/issues/280
2020-06-04 08:46:34 +12:00
cpenny
d4165db690 Update getter name to getCMSCompositeValidator 2020-05-28 12:23:35 +12:00
cpenny
bca4be77ed Update name to CompositeValidator. Add docblocks 2020-05-28 11:18:46 +12:00
cpenny
11e2005b9b Add deprecation notice for 4.6 and update docs 2020-05-28 11:18:46 +12:00
Indy Griffiths
63fd20093e
DOCS fix incorrect Injector YAML examples 2020-05-26 22:30:01 +12:00
Maxime Rainville
a24a923d0c
DOC Create dedicated article about limiting allowed file types (#9505) 2020-05-20 20:36:51 +12:00
Michal Kleiner
21129b1624
Use short array syntax across the framework's codebase 2020-05-16 10:34:45 +01:00
Maxime Rainville
10efe79b93
DOC Explain how to configure a low level application middleware (#9504) 2020-05-07 11:22:32 +12:00
Mojmir Fendek
7dc6b36c16
Unique key for DataObject (#9400)
NEW Unique key for DataObject
2020-05-04 09:10:51 +12:00
Dustin Quam
e344b66dbe
Fixed broken link to the module creation docs 2020-05-01 12:19:32 -05:00
Robbie Averill
8bd9f48669
Merge pull request #9501 from mattclegg/1588075087
DOCS: Fix typos & grammer
2020-04-28 09:42:03 -07:00
mattclegg
76bc7524a7
DOCS: Fix typos & grammer 2020-04-28 17:50:39 +05:45
Serge Latyntcev
cb36aab80c Merge branch '4.5' into 4 2020-04-15 14:49:19 +12:00
Serge Latyntcev
a9c05f3287 Merge branch '4.4' into 4.5 2020-04-15 14:48:59 +12:00
Serge Latyntcev
cf898a2672 Merge branch '4.3' into 4.4 2020-04-15 14:47:59 +12:00