From 3239cfd495de4f7809d5d6abb8359465b5330019 Mon Sep 17 00:00:00 2001 From: Cam Findlay Date: Wed, 14 Jan 2015 08:59:55 +1300 Subject: [PATCH] DOCS - fix reported broken links by zippy in IRC --- .../00_Getting_Started/00_Server_Requirements.md | 4 ++-- .../00_Getting_Started/04_Directory_Structure.md | 16 ++++++++-------- .../00_Model/11_Scaffolding.md | 10 +++++----- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/en/00_Getting_Started/00_Server_Requirements.md b/docs/en/00_Getting_Started/00_Server_Requirements.md index 9d4b9c136..41b26d3cc 100644 --- a/docs/en/00_Getting_Started/00_Server_Requirements.md +++ b/docs/en/00_Getting_Started/00_Server_Requirements.md @@ -45,7 +45,7 @@ comfortably allows over a million page views per month. Caching and other optimi ten or even one hundred times. SilverStripe CMS can be used in multiple-server architectures to improve scalability and redundancy. -For more information on how to scale SilverStripe see the [Performance](../../developer_guides/performance/) Gluide. +For more information on how to scale SilverStripe see the [Performance](/developer_guides/performance/) Guide. ## Client side (CMS) requirements @@ -57,5 +57,5 @@ systems. SilverStripe CMS is designed to make excellent, standards-compliant websites that are compatible with a wide range of industry standard browsers and operating systems. A competent developer is able to produce websites that meet W3C -guidelines for HTML, CSS, JavaScript, and accessibility, in addition to meeting specific guildelines, such as +guidelines for HTML, CSS, JavaScript, and accessibility, in addition to meeting specific guide lines, such as e-government requirements. diff --git a/docs/en/00_Getting_Started/04_Directory_Structure.md b/docs/en/00_Getting_Started/04_Directory_Structure.md index 635125115..22f385523 100644 --- a/docs/en/00_Getting_Started/04_Directory_Structure.md +++ b/docs/en/00_Getting_Started/04_Directory_Structure.md @@ -10,8 +10,8 @@ directories is meaningful to its logic. Directory | Description --------- | ----------- `assets/` | Contains images and other files uploaded via the SilverStripe CMS. You can also place your own content inside it, and link to it from within the content area of the CMS. -`cms/` | Contains all the files that form the CMS area of your site. It’s structure is similiar to the mysite/ directory, so if you find something interesting, it should be easy enough to look inside and see how it was built. -`framework/` | The framework that builds both your own site and as the CMS that powers it. You’ll be utilizing files in this directory often, both directly and indirectly. +`cms/` | Contains all the files that form the CMS area of your site. It’s structure is similar to the mysite/ directory, so if you find something interesting, it should be easy enough to look inside and see how it was built. +`framework/` | The framework that builds both your own site and as the CMS that powers it. You’ll be utilising files in this directory often, both directly and indirectly. ## Custom Code Structure @@ -23,7 +23,7 @@ existing modules or the directories lists in "Core Structure". | `/` | This directory contains all of your code that defines your website. | | `/_config` | YAML configuration specific to your application | | `/code` | PHP code for model and controller (subdirectories are optional) | - | `/templates` | HTML [templates](templates) with *.ss-extension | + | `/templates` | HTML [templates](/developer_guides/templates) with *.ss-extension | | `/css ` | CSS files | | `/images ` | Images used in the HTML templates | | `/javascript` | Javascript and other script files @@ -35,7 +35,7 @@ existing modules or the directories lists in "Core Structure". | `themes/yourtheme/` | The themes folder can contain more than one theme - here's your own | -See [themes](/topics/themes) +See [themes](/developer_guides/templates/themes) ## Module Structure {#module_structure} @@ -56,13 +56,13 @@ Example Forum: Module developers can bundle developer documentation with their code by producing plain text files inside a 'docs' folder located in the module folder. These files -can be written with the Markdown syntax (See [Contributing Documentation](/misc/contributing/documentation)) +can be written with the Markdown syntax (See [Contributing Documentation](/contributing/documentation)) and include media such as images or videos. -Inside the docs folder, developers should organize the markdown files into each +Inside the docs folder, developers should organise the markdown files into each separate language they wish to write documentation for (usually just `en`). Inside each languages' subfolder, developers then have freedom to create whatever structure -they wish for organizing the documentation they wish. +they wish for organising the documentation they wish. Example Forum Documentation: @@ -89,4 +89,4 @@ by using a `flush=1` query parameter. See the ["Manifests" documentation](/devel ## Best Practices ### Making /assets readonly -See [secure-development#filesystem](/topics/security#filesystem) +See [Secure coding](/developer_guides/security/secure_coding#filesystem) diff --git a/docs/en/02_Developer_Guides/00_Model/11_Scaffolding.md b/docs/en/02_Developer_Guides/00_Model/11_Scaffolding.md index 3aeddd0f8..79d508417 100644 --- a/docs/en/02_Developer_Guides/00_Model/11_Scaffolding.md +++ b/docs/en/02_Developer_Guides/00_Model/11_Scaffolding.md @@ -6,7 +6,7 @@ summary: A Model-driven approach to defining your application UI. The ORM already has a lot of information about the data represented by a `DataObject` through its `$db` property, so SilverStripe will use that information to provide scaffold some interfaces. This is done though [api:FormScaffolder] to provide reasonable defaults based on the property type (e.g. a checkbox field for booleans). You can then further -customize those fields as required. +customise those fields as required. ## Form Fields @@ -32,7 +32,7 @@ An example is `DataObject`, SilverStripe will automatically create your CMS inte } } -To fully customize your form fields, start with an empty FieldList. +To fully customise your form fields, start with an empty FieldList. :::php updateCMSFields`. +[DataExtension](/developer_guides/extending/extensions), and a call to `DataExtension->updateCMSFields`. ## Searchable Fields -The `$searchable_fields` property uses a mixed array format that can be used to further customize your generated admin +The `$searchable_fields` property uses a mixed array format that can be used to further customise your generated admin system. The default is a set of array values listing the fields. :::php @@ -218,7 +218,7 @@ Non-textual elements (such as images and their manipulations) can also be used i ); } -## Related Documenation +## Related Documentation * [SearchFilters](searchfilters)