Commit Graph

435 Commits

Author SHA1 Message Date
Simon Welsh
5ca000d0a5 Correct routing rule block indentation 2012-12-07 08:15:53 +13:00
Ingo Schommer
0eab45392e Merge pull request #962 from chillu/pulls/buildtools
Updated docs to fit new 'buildtools' workflow
2012-12-04 01:24:35 -08:00
Will Rossiter
100ad658db Email doc formatting
Workaround markdown parser throwing a fit with code straight after list.
2012-12-04 20:00:09 +13:00
Will Rossiter
bf67679155 Fix typo in email docs. 2012-12-04 19:56:36 +13:00
Will Rossiter
4cb81dafdf Fix typo with setTemplate() rss docs. 2012-12-04 19:54:26 +13:00
Simon Welsh
9106e41498 Fix related to ModelAdmin links 2012-12-01 11:57:07 +13:00
ARNHOE
8590bec1a9 SummaryFields doesn't change Title of Field
$field_labels does for me.
2012-11-30 09:53:01 +01:00
Adam Judd
2d8b7daaf9 Add limit() details to datamodel.md 2012-11-26 23:59:31 -08:00
Hamish Friedlander
40fd5abb57 DOC Update composer docs with changes from 3.0.3 2012-11-26 16:29:20 +13:00
Hamish Friedlander
e934030bc1 Merge changes for 3.0.3 release into 3.0 2012-11-26 11:34:28 +13:00
Hamish Friedlander
77f7778b4a Add 3.0.3 changelog 2012-11-26 11:20:21 +13:00
Ingo Schommer
96acd50681 Update composer contributing instructions 2012-11-22 15:10:10 +01:00
Sam Minnee
ecd921cc0a Fixed glitches in the sample composer.json shown in the docs 2012-11-22 17:03:11 +13:00
Ingo Schommer
7c3ce86bbb Updated docs to fit new 'buildtools' workflow 2012-11-21 16:15:48 +01:00
Ingo Schommer
df4fde3864 Pjax docs 2012-11-18 23:48:43 +01:00
Ingo Schommer
32f829d094 NEW Support for Behat tests, and initial set of tests 2012-11-16 15:31:55 +13:00
Hamish Friedlander
5edf86fe7a Merge branch '3.0.3' into 3.0 2012-11-16 14:57:50 +13:00
Hamish Friedlander
fb7db6de6d Add 3.0.3-rc2 changelog 2012-11-16 14:45:20 +13:00
Ingo Schommer
8c2e3230c8 Added ModelAdmin customization docs 2012-11-15 22:14:15 +01:00
Ingo Schommer
4fcdfe8d64 Testing docs recommend "phpunit" over "sake"
- Moved some docs around to reflect this change
- Described how to symlink from vendor/bin/phpunit
- Added note about browser-runs not being recommended
- Added more examples on how to run through "sake",
  to complement the existing descriptions for "phpunit"
2012-11-15 14:15:46 +01:00
Ingo Schommer
0a580deb3f Documenting PHPUnit install through composer 2012-11-15 13:40:07 +01:00
Stig Lindqvist
84692bf499 Corrections to composer docs for update and install 2012-11-13 22:57:02 +13:00
Sam Minnee
875e01ff1c Added composer docs for update and install 2012-11-12 11:58:41 +13:00
Sam Minnee
cc96b4d0ff More clarification of composer docs 2012-11-12 11:48:49 +13:00
Stig Lindqvist
e43a4f22fb Update docs/en/installation/composer.md
DOC Corrected a spelling error on the example of advanced usage.
2012-11-09 19:08:13 +13:00
Ingo Schommer
edb4ecd4d9 Note about backtick in entwine shortcuts 2012-11-07 13:05:48 +01:00
Ingo Schommer
bcee252c2f Fixed sapphiredocs references 2012-11-06 11:01:48 +01:00
Sam Minnee
c1ae13ffb0 Added docs about composer branch names and forks. 2012-11-06 16:48:03 +13:00
Sam Minnee
10f34f43d5 Tidy up formatting of composer docs. 2012-11-06 12:30:45 +13:00
Sam Minnee
4e72ae8667 Added composer documentation for using project forks. 2012-11-06 12:26:43 +13:00
Sam Minnee
3013fa013f Removed 'from-source' documentation 2012-11-06 11:48:39 +13:00
Sean Harvey
34f9c8e866 adding 3.0.3-rc1 to changelog index 2012-11-06 10:58:55 +13:00
Sean Harvey
896ce60432 Adding changelog for 3.0.3-rc1 2012-11-06 10:41:24 +13:00
Sam Minnee
cf7f51a826 Removed unnecessary step in composer instructions. 2012-11-05 18:33:01 +13:00
Sam Minnee
3f6740f185 Improved module installation docs for composer. 2012-11-05 16:30:35 +13:00
Sam Minnee
2d3c33d400 FIX: Fixed details about version in composer create-project 2012-11-04 21:50:56 +13:00
Sam Minnee
c1ae8f9e7a Added docs for composer 2012-11-03 18:00:58 +13:00
Ingo Schommer
80f40c6070 Merge pull request #907 from stojg/docs-forms-7727
MINOR: Fixes to the topics/forms.md
2012-10-31 15:19:29 -07:00
stojg
5ca1d5b228 BUG Fixes to the topics/forms.md documentation
- Added an example on how to setup a controller with a form
- Notice about adding form methods to $allowed_actions
- Using the FormField::create() in all examples
- Corrected some errors in the examples that did not work
- Aligned docs to use 120 chars lines
2012-11-01 11:14:06 +13:00
Ingo Schommer
a7753dfa5b Moved GridField docs to reference 2012-10-30 18:59:26 +01:00
Ingo Schommer
a502b222cc Merge remote-tracking branch 'origin/2.4' into 3.0 2012-10-30 17:24:52 +01:00
Ingo Schommer
9e595db7f3 Changelogs 2012-10-30 17:00:41 +01:00
Russell Michell
031681814b MINOR: Fixed typo; "SilverStripe" was mis-spelled. 2012-10-29 08:13:43 +13:00
Simon Welsh
b031188080 Updated gridfield docs
Fixes GridFieldConfig_RelationEditor example (was the same as RecordEditor) and fixes related links.
2012-10-27 11:30:26 +13:00
Juan Molina
f6f96a630e Update docs/en/changelogs/3.0.0.md
Fixed broken links. Hash links were not working. I don’t know how to hide heading-anchor-link links. Tried to correct some layout errors (code quotes).
2012-10-25 17:21:31 +03:00
Simon Welsh
29c2fec977 Changes flush and build URLs for tutorials. 2012-10-23 13:38:53 +13:00
martimiz
3b65b38826 UPDATE: replace subclassing with a DataExtension, add has_many warning
I replaced the subclassing example by one using a DataExtension. This
is the preferred way to add extra functionality to the Image class. You
can now add any existing image from the assets section instead of only
those belonging to the subclass.

Added a warning not to use has_many relations, because the UploadField
doesn't fully support them.
2012-10-22 12:28:18 +02:00
Zauberfisch
3a9edde8c4 MINOR: fixed docs
fixed AllowedExtensions docs
added AllowedMaxFileSize docs
2012-10-16 20:53:12 +00:00
martimiz
1c32cde7e7 ENHANCMENT - documentation for the UploadField
Documentation for the uploadfield. Only the implementation in the CMS
is documented, as the field doesn't seem to fully support being used in
the frontend just yet.
2012-10-16 19:14:52 +02:00
Ingo Schommer
9e34a989a8 Removed wrong datamodel docs
See https://groups.google.com/forum/?hl=en&fromgroups=#!topic/silverstripe-dev/Leh8fN0MjDY
2012-10-16 15:07:47 +02:00
martimiz
5186bada17 FIX DateField Calendar - make dates with day- and monthnames validate
In locales other than en_US, as a result of missing jQuery locale
files, the DatePicker defaulted to English whenever day and monthnames
were used, breaking validation. Needed to change official locale files
before adding, because Zend_Date and jQuery day/monthnames not matching
again breaks validation.

Removed hard setting the names to uppercase, breaking validation for
other locales

Changed order in convert_iso_to_jquery_format(), to prevent EEE(E)
settings from being overwritten

Added a check for existing locale files, and made DatePicker fallback
to ISO yyy-MM-dd if a missing locale file would otherwise break
validation.

Added documentation for the DateField
2012-10-12 10:16:35 +02:00
Juan Molina
7625d103f0 Update docs/en/installation/from-source.md
Removed broken links and confusing contributing/collaboration text.
2012-10-11 17:06:51 +03:00
Sam Minnee
9e7b8baecf Point people at silverstripe-dev and not the forum for discussing patches. 2012-10-09 14:53:48 +13:00
Sam Minnee
7d203a9af1 Moved all translator-targeted documentation to contributing/translation and left translation-process for advanced topics relating to module maintainers and the core team. 2012-10-09 14:53:47 +13:00
Sam Minnee
c4d2f9e6b2 Corrected a number of inbound links pointing to the documentation. 2012-10-09 14:53:47 +13:00
Sam Minnee
c28dd4c24b Make the copyright assignment clearer, and gave some explanation of why we do this. 2012-10-09 14:53:45 +13:00
Sam Minnee
65d20e4acc Simplified some of the code contribution guidelines.
The current guides have a few areas where they recommend an approach that is more complex than what most people take.

 - Rebase straight onto upsteam/msaster
 - Force push a rebased branch

I also fixed the conflict resolution help to be relevant to rebase commands, and kept the push instruction out of the rebase instruction.
2012-10-09 14:53:45 +13:00
Sam Minnee
433d29ce7b Removed 'release candidate branch' step of contributing.
I don't know what that release candidate branch stuff is, but:

 * I've never seen any of the core team do it
 * I think it's overkill for most patches
 * I think it's being too prescriptive: if contributors want to do that, that's cool, but it doesn't affect the core team.
 * It makes our contributing guidelines more complex than they need to be.
2012-10-09 14:53:44 +13:00
Sam Minnee
439339d4fc Broke up contributing docs into 4 sections and unified code contribtion guide.
The guidelines for contributing code were scattered across a section of contributing.md and collaboration-on-git.md.  I've updated this to have separate contributing/code.md page with all the content in a single cohesive page.  We also have contributing/documentation.md, contributing/issues.md and contributing/translation.md.
2012-10-09 14:53:39 +13:00
kentvv
ef0cd7b428 Update docs/en/howto/extend-cms-interface.md
Minor changes to file links.
2012-10-08 13:11:33 +13:00
Juan Molina
ab065b41bd Update docs/en/howto/simple-contact-form.md
Minor code highlighting fix.
2012-10-08 00:11:57 +03:00
Juan Molina
2c480ed94e Update docs/en/reference/dataextension.md
Removed ForumRole broken link and minor typo.
2012-10-07 18:11:40 +03:00
Ingo Schommer
be13ba3ef9 Removed 'built-in page controls' links from docs
See https://github.com/silverstripe/sapphire/pull/842, thanks Juanitou!
2012-10-05 17:39:19 +02:00
Hamish Friedlander
11f1c0a5c3 NEW Add documentation for the new config system in 3.0 2012-10-04 16:34:57 +13:00
Ingo Schommer
4684601c38 Fixed markdown whitespace usage 2012-10-02 11:38:16 +02:00
Ingo Schommer
fe4f0c92e2 Markdown line endings 2012-10-02 00:02:44 +02:00
Sam Minnee
1f7fc1f76a FIX Remove instances of lines longer than 120c
The entire framework repo (with the exception of system-generated files) has been amended to respect the 120c line-length limit.  This is in preparation for the enforcement of this rule with PHP_CodeSniffer.
2012-09-30 17:18:13 +13:00
Will Rossiter
a86b54b3ed Update tutorial to include RSS feed API change. 2012-09-27 18:46:48 +12:00
Howard Grigg
69e9876059 Correct brush name in template docs to avoid js popup 2012-09-25 22:27:30 +10:00
Simon Welsh
2b172aa891 Merge branch 'patch-2' of https://github.com/anselmdk/sapphire into 3.0 2012-09-24 18:22:49 +12:00
Anselm Christophersen
0df9b1c8a0 added CroppedImage 2012-09-23 19:46:06 +03:00
Ingo Schommer
e2f073f38a Method visibility according to coding conventions 2012-09-20 10:46:59 +02:00
Howard Grigg
7381cb46a3 Updated Template docs to include using backslash to escape 2012-09-18 22:35:46 +10:00
Will Rossiter
e509fb501d Tidy up RSSFeed docs based on community feedback. (Thanks Matt Howlett) 2012-09-18 19:42:21 +12:00
Ingo Schommer
c1064ccd0f Merge pull request #783 from halkyon/iis_install_simplify
Simplify IIS installation instructions, refer to stable download
2012-09-17 16:06:58 -07:00
Sean Harvey
40c3af37c2 Merge tag '3.0.2' into 3.0 2012-09-17 14:27:42 +12:00
Sean Harvey
ea35b08634 Added 3.0.2 changelog (and added missing 3.0.1 changelog to the list) 2012-09-17 13:25:31 +12:00
Sean Harvey
a6f5b99a5c Formatted warnings correctly 2012-09-17 12:24:45 +12:00
Peter Indiola
7f3f560a60 Update docs/en/topics/forms.md
Minor update to line 79 of the Form Fields sample code. Missing comma for the next field. throws error when using the code.
2012-09-15 09:06:37 +08:00
Sean Harvey
7a8c35f4e3 Merge pull request #789 from anselmdk/patch-1
Removed some line breaks for code blocks to render properly in the doc m...
2012-09-12 16:18:30 -07:00
Ingo Schommer
0670a15923 Merge branch '3.0.2' into 3.0 2012-09-13 00:55:00 +02:00
Sean Harvey
1aed488762 Simplify IIS installation instructions, refer to stable download
The documentation was quite verbose, and most of this can be replaced
with instructions on using PHP Manager for IIS which sets up most of
the PHP configuration for us, with small tweaks done afterwards.

In addition, there were references to SVN version control locations
which are long since used, we now refer to stable download locations
on silverstripe.org instead, for SilverStripe as well as the mssql
module.
2012-09-13 10:08:38 +12:00
Anselm Christophersen
1434190c36 Removed some line breaks for code blocks to render properly in the doc module
See <http://doc.silverstripe.org/framework/en/tutorials/5-dataobject-relationship-management> for what I mean
2012-09-12 19:53:06 +03:00
Ingo Schommer
db1bffb054 Added 3.0.2-rc2 changelog 2012-09-12 11:17:40 +02:00
Howard Grigg
20fead5feb DOCS - Correcting links to Roadmap and Changelog 2012-09-11 18:00:46 +10:00
Will Rossiter
189259f65b Merge pull request #785 from halkyon/req_tweaks
IIS Requirement documentation tweaks
2012-09-10 20:50:38 -07:00
Sean Harvey
b48a27b47d Tweak IIS and SQL Server requirements in system requirements docs
In addition to supporting IIS 7+ with a note that IIS 6 *may* work,
mark the IIS 6.x install docs with a cautionary note that those instructions
are no longer maintained and may not work.
2012-09-11 15:45:54 +12:00
Sean Harvey
42140d3a3d Tweaking IIS and SQL Server requirements documentation 2012-09-11 15:00:36 +12:00
Mateusz Uzdowski
147bec5be4 Rewrite the permission docs for IIS7.
Include more specific information on how to set up permission on
folders, including a screenshot.
2012-09-10 14:01:17 +12:00
Sam Minnee
f49439c1a4 Added 3.0.2-rc1 docs 2012-09-05 11:05:21 +12:00
Stig Lindqvist
19772f3c04 ENHANCEMENT: Updates to the GridField documentation (fixes #7524) 2012-09-02 22:30:29 +02:00
Will Rossiter
b99c9e8c57 Add reference to documentation directory structure 2012-09-02 12:30:11 +12:00
Will Rossiter
678232f533 Add reference for template documentation 2012-08-30 18:43:19 +12:00
Sam Minnée
898f9ad3a9 DOC Gave easier instructions for would-be authors
The use of GitHub for documentation isn't ideal in a world full of wikis,
but we do it because it has other substantial advantages. However, we
shouldn't assume that every would-be author is comfortable using pull requests.

This change presents the edit-on-github interaction as the most straightforward
one, suggesting that advanced users may which to check out locally.
2012-08-30 12:54:52 +12:00
martimiz
82500dd4c4 NEW Custom menu icons for the CMS main menu
Add optional custom menu icons to the CMS main menu for every class
extending LeftAndMain (ModelAdmin). Works by setting optional static
$menu_icon = '/path/to/image' and providing custom styling for added
icons. Works for the menu as well as icon in the right-side (GridField) pane header.
2012-08-29 13:14:59 +02:00
Ingo Schommer
9ebac90864 Removed 'relation filters' from datamodel docs
Not implemented yet, so we shouldn't document it either
to avoid confusing devs. See #7595
2012-08-22 16:29:37 +02:00
Hamish Friedlander
b560d258d3 Re-enable Entwine Inspector in CMS & document 2012-08-20 11:26:11 +12:00
Will Rossiter
f6c69d5241 Update widget documentation (fixes #706) 2012-08-08 21:21:58 +12:00
Ingo Schommer
0c0bcc9aec NEW Rewritten tutorial 5 to GridField API
- Removed redundant "module" relationship, has_one is already present in Student->Project relationship
- Simplified FirstName/LastName to Name on Student and Mentor models, makes for less sample code
- Removed detail views for Student and Mentor, as they don't add much educational value
- Fixed indentation in code examples
- Using GridField relation editor, listing students on relation instead of holder
- Added optional exercises for the readers
- Added conclusion, explaining when to use Page vs. DataObject
- Updated sample data to GSOC '12 rather than '07, anonymized and randomised a bit
- Thanks to Naomi Guyer for contributing!
2012-08-07 21:09:40 +02:00
Ingo Schommer
0308cc2005 Tutorial 2/3 and some howto tweaks 2012-08-07 21:06:35 +02:00