Commit Graph

68 Commits

Author SHA1 Message Date
Maxime Rainville
3f15957b5f DOC New release lifecycle 2019-12-18 17:05:11 +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
Aaron Carlino
c1047fac32 DOCS: Add docs for versioned files migration 2019-09-24 16:04:22 +12:00
Maxime Rainville
62cdc43e78 DOC Add missing reference to TagToShortcodeTask. 2019-06-11 15:17:25 +12:00
Andre Kiste
0c6c57f1ef Add getFieldMap method to retrieve a list of all fields for any giv… (#8892)
* Add `getFieldMap` method to retrieve a list of all fields for any given class

* Add `TagsToShortcodeTask` to upgrading guide

Adding after the file migration part as this is where it makes the most sense to run it.

* `getFieldMap` accepts an array

* Move to `DataObjectSchema`

* Add `HTMLVarchar` to documentation
Minor refactoring

* Add test for checking that `subclassesfor` works without the base class
Add test `DataObjectSchema::getFieldMap` returns the correct array

* Remove cms dependency
2019-04-30 10:43:14 +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
Matt Peel
a61cb1de99 Fix reference to webconfig.php, an invalid file
The upgrading docs reference webconfig.php, which is incorrect and has never existed. I presume the docs mean to reference web.config, which is the IIS configuration file.

I've also fixed a couple of minor spelling mistakes and mentioned Apache for htaccess and IIS for web.config so people know what they're for.

[ci skip]
2019-04-30 08:55:03 +12:00
Christopher Darling
fcef36b7fa
DOCS composer autoload examples should be psr-4
currently 'psr4'
2019-04-15 06:55:01 +01:00
Ingo Schommer
d04ef04999 DOCS Upgrading guide known issues and self-update 2019-04-09 08:24:15 +12:00
Rob McGrail
7396f57088
Change case in link
Link doesn't resolve on https://docs.silverstripe.org/en/4/upgrading/upgrading_module/ because of the capital letter
2019-03-29 10:42:31 +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
Andre Kiste
d1fa6e40d8
Fix some minor typos 2019-02-26 15:38:03 +13:00
Maxime Rainville
98988cfcf1 DOCS Escape \*nix in upgrading guide 2019-02-19 14:57:55 +13:00
Maxime Rainville
e07937c532 DOCS Implement some feedback from code review. 2019-02-19 14:55:01 +13:00
Guy Marriott
36df1ac119
Correcting typos identified in code review
Co-Authored-By: maxime-rainville <maxime@rainville.me>
2019-02-19 11:10:12 +13:00
Maxime Rainville
4653b69168 DOCS Add a paragraph about how to update the upgrader 2019-02-14 15:06:20 +13:00
Maxime Rainville
27a9dbe4cd
Correct typos 2019-02-13 15:16:09 +13:00
Maxime Rainville
480183b5c5 DOCS Tweak some code samples. 2019-02-13 15:02:01 +13:00
Maxime Rainville
91ccc811cc DOCS Ddd an index page to the upgrade section 2019-02-13 13:53:55 +13:00
Maxime Rainville
068e486c81 DOCS Rename the upgrading guide. 2019-02-13 13:39:07 +13:00
Maxime Rainville
a138e26e64 DOCS finalise module upgrade guide, correct mistakes in original upgrade guide 2019-02-12 22:07:23 +13:00
Maxime Rainville
3fd4e604c6 DOCS Document more steps on the upgrade of modules. 2019-02-07 18:47:01 +13:00
Maxime Rainville
8d3fa81bc0 DOC Document how to update dependency on module upgrade 2019-02-05 14:32:51 +13:00
Maxime Rainville
66f32fb65a DOCS Draft upgrading module guide intro and branching section 2019-02-04 14:58:51 +13:00
Maxime Rainville
2b77e7041e
Merge pull request #8741 from open-sausages/pulls/4/rename-warnings-docs
Add documentation on using `renameWarnings` in the upgrader
2019-01-24 09:28:21 +13:00
bergice
a975ec023c Add documentation on using renameWarnings in the upgrader 2019-01-23 11:24:11 +13:00
Andre Kiste
4a51412c39
Merge pull request #8693 from open-sausages/pulls/4/cwp-recipe-improvement
DOCS Add a reference to new cwp-constraint upgrader flag.
2019-01-22 10:32:35 +13:00
Maxime Rainville
b6e3ff85c7 DOCS Add some extra info about the --strict flag for the upgrader 2019-01-17 16:20:14 +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
Maxime Rainville
a765ce26a0 DOCS Add a reference to new cwp-constraint upograder flag. 2019-01-06 21:24:33 +13:00
micmania1
f1710f0bfd DOCS add step to upgrade existing database class references 2018-11-22 12:53:26 +13: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
Nicholas Byfleet
6667203d73
Update index.md
Changed a sentence so that it makes sense.
2018-08-01 16:30:18 +12: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
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
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
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
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
Maxime Rainville
1448f78a72
Adding reference to reorganise. 2018-04-19 15:20:42 +12:00