Commit Graph

310 Commits

Author SHA1 Message Date
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
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
Naomi Guyer
6d8976ec87 MINOR: Forms, navigation howto plus adjustments to tutorial one (#6367 )
* Created "How to make a simple contact form"
* Created "Create a navigation menu"
* Adjusted tutorial one from Andy's notes
2012-08-07 21:06:34 +02:00
Naomi Guyer
11c71e1a5a NEW Updated tutorial 4 2012-08-07 21:06:34 +02:00
Naomi Guyer
2d80ea5939 MINOR: Documentation, tutorial (part3, and tidy-up part 1&2 )
Fixed up Forms documentation, and replaced some images in first 2
tutorials
2012-08-07 21:06:34 +02:00