Commit Graph

144 Commits

Author SHA1 Message Date
Steve Boyd
47855e3e49
Merge pull request #9579 from scttw/patch-1
DOC Update 04_Rendering_Templates.md
2021-03-23 10:00:59 +13:00
Ingo Schommer
c6d6358e45
Merge pull request #9835 from unclecheese/pulls/4/nuclear-refactor
DOCS: Document GraphQL 4 BuildState changes
2021-02-17 16:20:16 +13:00
Ingo Schommer
68eeef60d5 DOCS GraphQL build requirement changes 2021-02-17 12:40:40 +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
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
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
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
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
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
Andrew Aitken-Fincham
7c95237e8d update template docs, move deprecation to 5.0, capitalise Is 2020-06-15 12:25:13 +01:00
Mojmir Fendek
7dc6b36c16
Unique key for DataObject (#9400)
NEW Unique key for DataObject
2020-05-04 09:10:51 +12: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
Dan Hensby
5bf2ac83ee
Merge branch '4.5' into 4 2020-04-01 19:23:47 +01:00
Robbie Averill
5002f514b3
FIX Capitalisation fixes in welcome back message (#9439) 2020-03-23 15:54:30 +13:00
Zubair
9733060d1c
Fix Related section at bottom of document 2020-02-21 09:53:57 -05:00
Benjamin Blake
7c32a848aa
Updated the "Template Syntax" Documentation
Added a notice to the "Variables" section of the "Template Syntax" documentation to warn developers about common template variable gotchas
2020-01-27 15:18:40 -07: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
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
Ryan Potter
fa325d2360
Update pagination code snippet
Update pagination snippet to use summarised pagination.
2019-08-13 15:17:38 +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
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
Jonathon Menz
0cbc02add1 DOCS Added 'Modifying Meta Tags' entry 2019-02-01 09:33:20 -08:00
Maxime Rainville
728c982de2 DOCS Retroactively apply proposed change to vendor-expose doc 2019-01-09 16:28:40 +13:00
Maxime Rainville
1e01deea39 NEW Make resources dir configurable (#8519)
* NEW Make resources dir configurable.

* Removing reference to old `resources` and updating doc #8519

* Rrtarget to 4.4 release.

* DOC Reference SS_RESOURCES_DIR in Environment doc.

* API Add a Resources method to SilverStripe\Core\Manifest\Module to read the resources-dir from composer.json

* Clean up reference to SS_RESOURCES_DIR env var

* Set default resources-dir

* Update test to use RESOURCES_DIR const in expected resource url method

* Correcting typos

Co-Authored-By: maxime-rainville <maxime@rainville.me>

* MINOR Correctubg minor typos

* DOCS Document the intricacies of exposing static assets.
2019-01-09 15:35:45 +13:00
Aled Brown
ff1a0dd6fc
renderWith Namespace for Template Loading
Just calling MyCustomTemplate does not work in SS 4.2.X. Adding the full Namespace as a path is now required.
2018-11-21 15:28:12 +00: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
6e2b4c2558
Update 05_Template_Inheritance.md
Documentation mentions themes when talking about modules.
2018-09-09 10:07:49 -05: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
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
35943ac68a
Update 03_Requirements.md 2018-06-03 14:25:05 +02:00
Juan Molina
031f8b23ec
Update 03_Requirements.md
Update Blocking section to reflect new vendor path
2018-06-02 19:30:12 +02:00
Robbie Averill
e0993043f8 Merge branch '4.1' into 4 2018-05-30 15:08:39 +12:00
Robbie Averill
c8b0bc0ad7 Merge branch '4.0' into 4.1
# Conflicts:
  #	src/ORM/DataObject.php
  #	tests/php/ORM/DataObjectDuplicationTest.php
  #	tests/php/ORM/DataObjectDuplicationTest/Class1.php
2018-05-30 14:52:07 +12:00
Juan Molina
5e45a4be88
Update 05_Template_Inheritance.md
Minor grammar fix.
2018-05-25 14:17:28 +02:00
DorsetDigital
67fbaf3423
Update 06_Themes.md
Remove reference to theme picker in settings page which was removed in SS4
2018-04-13 12:12:55 +01:00
Ingo Schommer
bf8790a893 Docs: Remove forum and IRC references 2017-12-19 11:45:27 +13:00
Ingo Schommer
2fa1114bd3 Removed deprecated tutorials from docs 2017-12-19 11:45:27 +13:00