Commit Graph

267 Commits

Author SHA1 Message Date
Aaron Carlino
5fb7ef0bcf DOCS: Remove links to common problems 2020-07-24 10:38:37 +12:00
Ingo Schommer
229df95fe9 DOCS Warning about protected file serving in 4.x 2019-09-13 18:01:44 -07: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
Ingo Schommer
15396116e5 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-24 14:00:48 +12:00
James Cocker
797b749098
Corrected legacy_paths to legacy_filenames 2019-01-14 14:35:11 +00:00
Robbie Averill
aa93598c30
DOCS Change upgrade.yml to legacy.yml to avoid confusion with .upgrade.yml from the upgrader tool 2018-10-19 17:59:55 +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
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
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
3aba5a7136 DOCS Mention public folder in 4.0.0 upgrading overview
It's one of the most noteworthy manual changes,
let's not hide it from devs who will (correctly) start their upgrade process by looking at the 4.0.0 guide
2018-06-15 16:23:19 +12:00
Ingo Schommer
0a61f7ed16 DOCS Link to public folder instructions from 4.0.0 docs
It's far too common for people to follow 4.0.0, only to get surprised theres more to it
2018-06-15 16:20:57 +12:00
Aaron Carlino
23bf8d2b3c add docs for new file extension process 2018-06-11 15:45:36 +12:00
Christopher Darling
cab1ea0dbe
DOCS fix 4.0.0 changelog example code
ThemeResourceLoader::inst()->findThemedResource() requires two arguments af2c3886b9/src/View/ThemeResourceLoader.php (L286-L294)
2018-06-05 16:58:37 +01:00
Ingo Schommer
86b1665fd2 Docs for vendor expose through FTP
See https://forum.silverstripe.org/t/upgrade-from-4-0-3-to-4-1-0-unspported-browser-message/272/7
2018-04-12 14:11:26 +12:00
JorisDebonnet
26280f8ab9
Update 4.0.0.md
Fixed several small issues
2018-02-22 03:22:13 +01:00
Damian Mooyman
e359948eb3
Merge remote-tracking branch 'origin/4.0' into 4
# Conflicts:
#	src/Core/CoreKernel.php
2018-02-05 17:52:38 +13:00
Christopher Joe
78a6b4b4c3 Cleanup upgrade docs and 4.0 change logs 2018-02-01 15:27:02 +13:00
Damian Mooyman
8d077203d4 API Implement support for public/ webroot folder (#7741)
* API Implement support for public/ webroot folder

* Bugfixes and refactor based on feedback
2018-01-12 16:25:02 +13:00
Robbie Averill
2e139dc5fd DOCS Update getRelativeResourcePath (deprecated) to getResource()->getRelativePath() in upgrade examples 2017-11-27 10:53:21 +13:00
Damian Mooyman
4439d051cf DOCS Add note on removed deprecated setApplicationLink / setApplicationName
Fixes #7631
2017-11-23 15:20:00 +13:00
Daniel Hensby
4d1e659fed
Merge branch pull request #7604 from open-sausages/pulls/4.0/owns-example-upgrading
DOCS Adjust owns upgrading example
Fixes #7598
2017-11-16 10:53:38 +00:00
Damian Mooyman
58b43f29a9
DOCS Adjust owns upgrading example
Fixes #7598
2017-11-16 11:38:26 +13:00
Daniel Hensby
3cd0b23172
DOCS add import to upgrade example 2017-11-08 14:56:13 +00:00
Daniel Hensby
079fffb0f0
DOCS Update 4.0.0 changelog to indicate stable release 2017-11-08 12:58:30 +00:00
Damian Mooyman
6d8df46b8a Added 4.0.0 changelog 2017-11-08 15:14:54 +13:00
Daniel Hensby
102de3d34c
DOCS Add required import for docs example 2017-11-02 11:50:47 +00:00
Chris Joe
326f74ebe6
Merge pull request #7535 from open-sausages/pulls/4.0/fix-object-replace-link
DOCS Fix broken docs hashlink
2017-10-31 23:34:08 +13:00
Chris Joe
db3c074643
Merge pull request #7533 from open-sausages/pulls/4.0/document-compositefield-setid
DOCS Upgrade path for CompositeField::setID()
2017-10-31 22:22:20 +13:00
Damian Mooyman
d48e8960b4
DOCS Fix broken docs hashlink
Fixes #7534
2017-10-31 11:56:29 +13:00
Damian Mooyman
a145e24fd2
DOCS Upgrade path for CompositeField::setID()
Fixes #7264
2017-10-31 11:18:50 +13:00
Damian Mooyman
ab581646e1
DOCS Remove AssetField reference
Fixes #7529
2017-10-31 09:08:10 +13:00
Christopher Darling
7b1c89fdea
DOCS: fix links to getting_started/environment_management 2017-10-30 12:56:54 +00:00
Aaron Carlino
5b48a9a07b Remove reference to database_fields 2017-10-30 16:13:41 +13:00
Aaron Carlino
46ce733b9a Update changelogs to include notes about database_fields 2017-10-30 12:36:01 +13:00
Damian Mooyman
cdfb413395
Code block whitespace / formatting cleanup 2017-10-27 15:38:27 +13:00
Ingo Schommer
8725672eae Fix changelog anchors
See https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/f61751b19e5d22dba7e72d2c195b723376dc2b71/tests/docs/en/test.md for correct format.
2017-10-26 08:41:18 +13:00
Damian Mooyman
f52eecdc7f Merge pull request #7507 from open-sausages/pulls/4.0/changelog
Improve changelog
2017-10-25 12:36:05 +13:00
Damian Mooyman
ebe20bb643
Remove obsolete ToC
Update composer recommendations
2017-10-25 12:04:04 +13:00
Ingo Schommer
d56c756074 Fixed changelog indentation 2017-10-25 07:24:57 +13:00
Ingo Schommer
69f16c605c Consistent anchors in changelog headliens 2017-10-24 22:41:18 +13:00
Ingo Schommer
19d33f4de7 Moved up file migration in changelog 2017-10-24 22:37:04 +13:00
Ingo Schommer
862fcec553 Moved up .env docs in changelog
They're needed much earlier
2017-10-24 22:34:48 +13:00
Ingo Schommer
ff0b648d75 Detail links in changelogs 2017-10-24 22:33:20 +13:00
Ingo Schommer
a08c1f42d9 Deprioritised docs on minor upgrade paths 2017-10-24 22:21:49 +13:00
Ingo Schommer
5027af3926 Consistent 4.0 changelog presentation
- Use "Removed/Changed/Added/Moved" prefixes to make content more scannable
- Removed "change" vs "remove" distinction in subheadings (hard to separate, and not meaningful in practice)
- Linearised messages, less nesting - easier to parse (don't need to remember context from a few lines above)
- Simplified language (e.g. "use" instead of "please use")
- Simplified headline wording (remove repetitive "upgrade code that uses X")
- More anchor links across sections
- More use of diffs to clearly communicate before/after states
- Consistently apply backtick code formatting
- Consistently use "()" to denote methods (easier to read)
- Removed duplicate SQLQuery instructions (and simplified the augmentSQL example)
- Add new composer.json intro
2017-10-24 22:18:46 +13:00
Damian Mooyman
56b49dad34 DOCS Improve high level file documentation (#7501)
* DOCS Improve high level file documentation
Fixes https://github.com/silverstripe/silverstripe-assets/issues/62

* Updates based on feedback
2017-10-24 22:12:28 +13:00
Damian Mooyman
e76f01ebfa Merge pull request #7496 from open-sausages/pulls/4/inspect-upgrade-warnings
Upgrading rules for new inspect/warning capabilities
2017-10-24 15:25:34 +13:00
Damian Mooyman
b9cb1e69e6 BUG Replace phpdotenv with thread-safe replacement 2017-10-20 18:43:11 +13:00