mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
MINOR: formatting changes and fixes to original document formatting
This commit is contained in:
Michael Andrewartha
Ingo Schommer
parent
f15f083f22
commit
8ad630d5a1
@ -72,7 +72,7 @@ Sitemap.php
|
||||
* Portuguese (Portugal) translation
|
||||
* Support for multilingual content
|
||||
* Added a Statistics area showing the following reports
|
||||
* Page views
|
||||
* Page views
|
||||
* User activity
|
||||
* Trends
|
||||
* Operating Systems
|
||||
@ -120,7 +120,6 @@ Sitemap.php
|
||||
* Replace the 'reorganise' button with 'Allowing drag & drog reordering' checkbox
|
||||
* Delete and Unpublish buttons turn red on hover
|
||||
* Added the ability to align images 'left on their own'
|
||||
|
||||
|
||||
## Enhancements
|
||||
|
||||
|
||||
@ -37,4 +37,4 @@
|
||||
### Other
|
||||
|
||||
Created with:
|
||||
{}
|
||||
<code>./sscreatechangelog --version 2.3.6 --branch branches/2.3 --stopbranch tags/2.3.5</code>
|
||||
@ -9,4 +9,4 @@
|
||||
* [rev:100744] Fixing Member_ProfileForm to validate for existing members via Member_Validator to avoid CMS users to switch to another existing user account by using their email address (from r100704) (from r100717)
|
||||
|
||||
Created with:
|
||||
<code>./sscreatechangelog --version 2.3.7 --branch branches/2.3 --stopbranch tags/2.3.6)</code>
|
||||
<code>./sscreatechangelog --version 2.3.7 --branch branches/2.3 --stopbranch tags/2.3.6</code>
|
||||
@ -49,7 +49,7 @@ See [2.4.1](2.4.1#securitydisallow_direct_execution_of_php_files)
|
||||
* [rev:103447] Fixed js applying to non-tinymce textarea fields in !ModelAdmin.js (fixes #5453)
|
||||
* [rev:103362] Fixed js applying to non-tinymce textarea fields in !ModelAdmin.js (fixes #5453)
|
||||
* [rev:103348] added moderation message for non-ajax mode
|
||||
* [rev:101258] Fixed missing closing <div> in !ContentController->successfullyinstalled() (from r101254)
|
||||
* [rev:101258] Fixed missing closing `<div>` in !ContentController->successfullyinstalled() (from r101254)
|
||||
|
||||
|
||||
<code>./sscreatechangelog --version 2.3.8 --branch branches/2.3 --stopbranch tags/2.3.7</code>
|
||||
`./sscreatechangelog --version 2.3.8 --branch branches/2.3 --stopbranch tags/2.3.7`
|
||||
@ -343,7 +343,7 @@ existing pages when their title is changed.
|
||||
* [rev:104720] Fixed installation problem where version error didn't show
|
||||
* [rev:104679] Make URLs lowercase
|
||||
* [rev:104678] Fixed Translatable::canEdit() to suit new permission customisation scheme
|
||||
* [rev:104675] Prevent !DataDifferencer from creating empty <ins /> and <del /> takes that confuse the browser.
|
||||
* [rev:104675] Prevent !DataDifferencer from creating empty `<ins />` and `<del />` takes that confuse the browser.
|
||||
* [rev:104672] Make !RsyncMultiHostPublisher protected; give default value.
|
||||
* [rev:104670] Director::test() shouldn't break if $_SESSION isn't set.
|
||||
* [rev:104666] Removed references to php5 binary in Makefile
|
||||
|
||||
@ -48,7 +48,7 @@
|
||||
* [110857] Enforcing canEdit() checks in !ComplexTableField_Popup - making form readonly if the current user can't edit
|
||||
* [110838] Case insensitive !DateField value navigation (fixes #5990, thanks gw0(
|
||||
* [110835] Passing $name in !MoneyField->!FieldCurrency() (fixes #5982, thanks andersw)
|
||||
* [110809] Removing "typography" class from HTMLEditorField container (should just apply to the contained <iframe>) (fixes #5949)
|
||||
* [110809] Removing "typography" class from HTMLEditorField container (should just apply to the contained `<iframe>`) (fixes #5949)
|
||||
* [110808] Allowing $extraClass on !CheckboxField !FieldHolder (fixes #5939, thanks mobiusnz)
|
||||
* [110759] ensure that pages can only be requested from staging and live
|
||||
* [110463] Fixed boundary PHP notice case in !RequiredFields::php() where a field name may not be defined in the $data array when a Form is submitted
|
||||
|
||||
@ -38,4 +38,4 @@
|
||||
* [rev:101258] Fixed missing closing `<div>` in ContentController->successfullyinstalled() (from r101254)
|
||||
|
||||
|
||||
{}
|
||||
`./sscreatechangelog --version 2.3.8-rc1 --branch branches/2.3 --stopbranch tags/2.3.7`
|
||||
@ -143,4 +143,4 @@
|
||||
|
||||
* [rev:101314] ENHNACEMENT Installer no longer asks for firstname and surname for default CMS admin account, this can be changed later on and doesn't need to be entered for installation
|
||||
|
||||
{}
|
||||
`./sscreatechangelog --version 2.4.0-rc1 --branch branches/2.4 --stoprevision 101127`
|
||||
@ -124,4 +124,4 @@
|
||||
* [rev:102071] Removed unnecessary sapphire/thirdparty/.gitignore, as the directory doesnt contain svn:externals any longer (fixes #5334)
|
||||
* [rev:102045] Fixed spelling mistake in ConfigureFromEnv class documentation
|
||||
|
||||
{}
|
||||
`./sscreatechangelog --version 2.4.0-rc2 --branch branches/2.4 --stoprevision 102039`
|
||||
@ -24,4 +24,4 @@
|
||||
* [rev:103975] Removed unnecessary $timeformat parameter from TimeField::__construct, and getting the default from Zend_Locale_Format in the same way that DateField behaves (unreleased API, so no api change).
|
||||
* [rev:103975] Automatically choosing $locale in TimeField::__construct, to be consistent with DateField
|
||||
|
||||
{}
|
||||
`./sscreatechangelog --version 2.4.0-rc2 --branch branches/2.4 --stoprevision 103839`
|
||||
@ -325,4 +325,4 @@
|
||||
* [rev:104667] Added explicit bash handler to sake
|
||||
* [rev:104442] Multi-use redemption page created
|
||||
|
||||
{}
|
||||
`./sscreatechangelog --version 2.4.1-rc1 --branch branches/2.4 --stopbranch tags/2.4.0`
|
||||
@ -35,7 +35,7 @@
|
||||
* [rev:110857] Enforcing canEdit() checks in !ComplexTableField_Popup - making form readonly if the current user can't edit
|
||||
* [rev:110838] Case insensitive !DateField value navigation (fixes #5990, thanks gw0(
|
||||
* [rev:110835] Passing $name in !MoneyField->!FieldCurrency() (fixes #5982, thanks andersw)
|
||||
* [rev:110809] Removing "typography" class from HTMLEditorField container (should just apply to the contained <iframe>) (fixes #5949)
|
||||
* [rev:110809] Removing "typography" class from HTMLEditorField container (should just apply to the contained `<iframe>`) (fixes #5949)
|
||||
* [rev:110808] Allowing $extraClass on !CheckboxField !FieldHolder (fixes #5939, thanks mobiusnz)
|
||||
* [rev:110759] ensure that pages can only be requested from staging and live
|
||||
* [rev:110463] Fixed boundary PHP notice case in !RequiredFields::php() where a field name may not be defined in the $data array when a Form is submitted
|
||||
|
||||
@ -156,7 +156,7 @@ Sample implementation of a custom loader. Assumes a CSV-file in a certain format
|
||||
* Converts property names
|
||||
* Splits a combined "Name" fields from the CSV-data into `FirstName` and `Lastname` by a custom importer method
|
||||
* Avoids duplicate imports by a custom `$duplicateChecks` definition
|
||||
* Creates `Team` relations automatically based on the `Gruppe` colum in the CSV data
|
||||
* Creates `Team` relations automatically based on the `Gruppe` column in the CSV data
|
||||
|
||||
|
||||
:::php
|
||||
|
||||
@ -34,6 +34,5 @@ methods. For example:
|
||||
} else {
|
||||
$this->FullTitle = $this->Title;
|
||||
}
|
||||
|
||||
parent::populateDefaults();
|
||||
}
|
||||
@ -70,6 +70,7 @@ a number of sets, grouped by the field that is passed as the parameter. In this
|
||||
defined earlier is used to break them up.
|
||||
|
||||
:::ss
|
||||
// Modules list grouped by TitleFirstLetter
|
||||
<h2>Modules</h2>
|
||||
<% control Modules.GroupedBy(TitleFirstLetter) %>
|
||||
<h3>$TitleFirstLetter</h3>
|
||||
@ -130,6 +131,7 @@ January to December. This can be accomplshed by sorting by the Date field:
|
||||
The final step is the render this into the template using the [api:DataObjectSet->GroupedBy()] method.
|
||||
|
||||
:::ss
|
||||
// Modules list grouped by the Month Posted
|
||||
<h2>Modules</h2>
|
||||
<% control NewsItems.GroupedBy(MonthPosted) %>
|
||||
<h3>$MonthPosted</h3>
|
||||
@ -138,5 +140,4 @@ The final step is the render this into the template using the [api:DataObjectSet
|
||||
<li>$Title ($Date.Nice)</li>
|
||||
<% end_control %>
|
||||
</ul>
|
||||
<% end_control %>
|
||||
|
||||
<% end_control %>
|
||||
@ -6,13 +6,11 @@ on tasks and goals rather than going into deep details.
|
||||
You will find it useful to read the introduction [tutorials](/tutorials) before tackling these How-Tos so you can understand some of
|
||||
the language and functions which are used in the guides.
|
||||
|
||||
* [Import CSV Data](csv-import). Build a simple CSV importer using either ModelAdmin or a custom controller
|
||||
* [Dynamic Default Fields](dynamic-default-fields). Pre populate a DataObject with data.
|
||||
* [Grouping DataObjectSets](grouping-dataobjectsets). Group results in a DataObjectSet to create sub sections.
|
||||
* [Import CSV Data](csv-import). Build a simple CSV importer using either [api:ModelAdmin] or a custom controller
|
||||
* [Dynamic Default Fields](dynamic-default-fields). Pre populate a [api:DataObject] with data.
|
||||
* [Grouping DataObjectSets](grouping-dataobjectsets). Group results in a [api:DataObjectSet] to create sub sections.
|
||||
* [PHPUnit Configuration](phpunit-configuration). How to setup your testing environment with PHPUnit
|
||||
|
||||
## Feedback
|
||||
|
||||
If you have a topic you would like covered in these how to's please ask for it on our [Bug Tracker](http://open.silverstripe.org)
|
||||
|
||||
|
||||
If you have a topic you would like covered in these how to's please ask for it on our [Bug Tracker](http://open.silverstripe.org)
|
||||
@ -3,7 +3,7 @@
|
||||
This guide helps you to run [PHPUnit](http://phpunit.de) tests in your SilverStripe project.
|
||||
See "[Testing](/topics/testing)" for an overview on how to create unit tests.
|
||||
|
||||
## Executing through "sake dev/tests" or "phpunit"?
|
||||
## Should I execute through "sake dev/tests" or "phpunit"?
|
||||
|
||||
Short answer: Both are valid ways.
|
||||
|
||||
@ -128,12 +128,12 @@ or through a `<php>` flag in your `phpunit.xml` (see [Appenix C: "Setting PHP IN
|
||||
|
||||
<phpunit>
|
||||
<!-- ... -->
|
||||
|
||||
<php>
|
||||
<var name="db" value="sqlite3"/>
|
||||
</php>
|
||||
|
||||
</phpunit>
|
||||
|
||||
Note: It is recommended that you still run your tests with the original
|
||||
database driver (at least on continuous integration) to ensure a realistic test scenario.
|
||||
<div class="hint" markdown="1">
|
||||
It is recommended that you still run your tests with the original database driver (at least on continuous integration)
|
||||
to ensure a realistic test scenario.
|
||||
</div>
|
||||
@ -2,19 +2,26 @@
|
||||
|
||||
From time to time, things will go wrong. Here's a few things to try when you're confused.
|
||||
|
||||
See ["8 Common SilverStripe Errors Explain (and solved!) (leftandmain.com)"](http://www.leftandmain.com/silverstripe-tips/2010/09/08/8-common-silverstripe-errors-explained-and-solved/) for more common problems.
|
||||
See ["8 Common SilverStripe Errors Explain (and solved!) (leftandmain.com)"](http://www.leftandmain.com/silverstripe-tips/2010/09/08/8-common-silverstripe-errors-explained-and-solved/)
|
||||
for more common problems.
|
||||
|
||||
## The output shows only "Website Error"
|
||||
|
||||
This first and foremost means that your environment is set to "live mode" (see [environment-management]), which disallows detailed error messages for security reasons. You'll typically need to get your environment into "dev mode" to see more information.
|
||||
This first and foremost means that your environment is set to "live mode" (see [environment-management]), which disallows
|
||||
detailed error messages for security reasons. You'll typically need to get your environment into "dev mode" to see more
|
||||
information.
|
||||
|
||||
If you can log-in to the CMS as an administrator, append `?isDev=1` to any URL to temporarily set your browsing session into "dev mode". If you can't log-in in the first place because of the error, add this directive to your `mysite/_config.php` (don't forget to remove it afterwards!):
|
||||
If you can log-in to the CMS as an administrator, append `?isDev=1` to any URL to temporarily set your browsing session into
|
||||
"dev mode". If you can't log-in in the first place because of the error, add this directive to your `mysite/_config.php`
|
||||
(don't forget to remove it afterwards!):
|
||||
|
||||
:::php
|
||||
Director::set_environment_type('dev'); // temporary debugging statement
|
||||
|
||||
Note: On "live" environments, the `?isDev=1` solution is preferred, as it means that your other visitors don't see ugly
|
||||
<div class="warning" markdown='1'>
|
||||
On "live" environments, the `?isDev=1` solution is preferred, as it means that your other visitors don't see ugly
|
||||
(and potentially security sensitive) PHP errors as well.
|
||||
</div>
|
||||
|
||||
## My templates don't update on page refresh
|
||||
|
||||
@ -29,7 +36,7 @@ to a lot of development problems. Here are some specifics situations:
|
||||
## A SQL query fails with "Column not found" or "Table not found"
|
||||
|
||||
Whenever you change the model definitions in PHP (e.g. when adding a property to the [$db](api:DataObject::$db) array,
|
||||
creating a new page type), SilverStripe will need to update the database. Visiting `http://`<my-domain>`/dev/build` in
|
||||
creating a new page type), SilverStripe will need to update the database. Visiting `http://<my-domain>/dev/build` in
|
||||
your browser runs a script that will check the database schema and update it as necessary. Putting `?flush=1` on the
|
||||
end makes sure that nothing that's linked to the old database structure will be carried over. If things aren't saving,
|
||||
pages aren't loading, or other random things aren't working it's possible that the database hasn't been updated to
|
||||
@ -48,7 +55,7 @@ every page on the site, if that's easier.
|
||||
|
||||
## I can see unparsed PHP output in my browser
|
||||
|
||||
Please make sure all code inside '*.php' files is wrapped in classes. Due to the way `[api:ManifestBuilder]`
|
||||
Please make sure all code inside `*.php` files is wrapped in classes. Due to the way `[api:ManifestBuilder]`
|
||||
includes all files with this extension, any **procedural code will be executed on every call**. Most common error here
|
||||
is putting a test.php/phpinfo.php file in the document root. See [datamodel](/topics/datamodel) and [controllers](/topics/controller)
|
||||
for ways how to structure your code.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Installation from Source Control #
|
||||
# Installation from Source Control
|
||||
|
||||
## Introduction
|
||||
|
||||
|
||||
@ -14,8 +14,8 @@ Never update a website on the live server without trying it on a development cop
|
||||
* Leave custom folders like *mysite* or *themes* in place.
|
||||
* Identify system folders in your webroot (`cms`, `sapphire` and any additional modules).
|
||||
* Delete existing system folders (or move them outside of your webroot)
|
||||
* Extract and replace system folders from your download (//Deleting instead of "copying over" existing folders
|
||||
ensures that files removed from the new SilverStripe release are not persisting in your installation//)
|
||||
* Extract and replace system folders from your download (Deleting instead of "copying over" existing folders
|
||||
ensures that files removed from the new SilverStripe release are not persisting in your installation)
|
||||
|
||||
* Visit http://yoursite.com/dev/build/?flush=1 to rebuild the website Database
|
||||
* Check if you need to adapt your code to changed APIs
|
||||
|
||||
@ -4,7 +4,7 @@ These instructions show you how to install SilverStripe on any web server.
|
||||
|
||||
For additional information about installing SilverStripe on specific operation systems, refer to:
|
||||
|
||||
* [Installation on a Windows Server](windows-pi.md)
|
||||
* [Installation on a Windows Server](windows-pi)
|
||||
* [Installation on OSX](mac-osx)
|
||||
|
||||
## Installation Steps
|
||||
|
||||
@ -65,7 +65,7 @@ If you want to learn more about git, please have a look at the [free online git
|
||||
Other modules will be hosted on [subversion](http://subversion.tigris.org), in which case you have to
|
||||
package your changes as a "patch" file. Please read the [official Subversion book](http://svnbook.red-bean.com/) (available free online) for a general introduction to subversion.
|
||||
|
||||
To submit a patch, [register](http://open.silverstripe.com/apply) and attach the patch to the appropriate ticket.
|
||||
To submit a patch, [register](http://open.silverstripe.com/register) or [Login](http://open.silverstripe.org/login) if you have already registered and attach the patch to the appropriate ticket.
|
||||
Please include in the comment the revision number that the patch is applicable for and a brief outline of what you fixed and how.
|
||||
Only use the provided link to submit patches, as it prefills information about owner and ticket-type:
|
||||
|
||||
@ -73,7 +73,7 @@ Only use the provided link to submit patches, as it prefills information about o
|
||||
|
||||
The core team is responsible for reviewing the patches and deciding if they will make it into core. If
|
||||
there are any problems they will assign the ticket back to you, so make sure you have an email address loaded into Trac
|
||||
so that it will notify you! The Trac report [Active Patches](http://open.silverstripe.com/report/10) will let you see
|
||||
so that it will notify you! The Trac reports [Core Patches](http://open.silverstripe.com/report/101) and [Module Patches](http://open.silverstripe.com/report/102) will let you see
|
||||
where all the patches are at.
|
||||
|
||||
You can create a patch file through the svn diff-command on the command-line.
|
||||
@ -155,7 +155,7 @@ If you have downloaded SilverStripe or a module, chances
|
||||
are that you already have the documentation files - they are kept alongside the source code.
|
||||
|
||||
The [doc.silverstripe.org](http://doc.silverstripe.org) website itself is powered by a
|
||||
SilverStripe project that uses the ["sapphiredocs" module](http://open.silverstripe.org/browser/modules/sapphiredocs/trunk)
|
||||
SilverStripe project that uses the ["sapphiredocs" module](https://github.com/silverstripe/silverstripe-sapphiredocs)
|
||||
to convert Markdown formatted files into searchable HTML pages with index lists.
|
||||
|
||||
### Repositories
|
||||
@ -166,11 +166,11 @@ to convert Markdown formatted files into searchable HTML pages with index lists.
|
||||
|
||||
### Source Control
|
||||
|
||||
In order to balance editorial control with effective colaboration, we keep
|
||||
In order to balance editorial control with effective collaboration, we keep
|
||||
documentation alongside the module source code, e.g. in `sapphire/docs/`,
|
||||
or as code comments within PHP code.
|
||||
Contributing documentation is the same process as providing any other patch
|
||||
(see [Patches and Bugfixes](#submiting-patches-bugfixes-and-enhancements)).
|
||||
(see [Patches and Bugfixes](contributing#submitting-patches-bugfixes-and-enhancements)).
|
||||
|
||||
### What to write
|
||||
|
||||
@ -179,7 +179,7 @@ Contributing documentation is the same process as providing any other patch
|
||||
Not suited for longer textual descriptions, due to the limited support of PHPDoc formatting for headlines.
|
||||
* **Tutorials**: The first contact for new users, guiding them step-by-step through achievable projects, in a book-like style.
|
||||
*Example: Building a basic site*
|
||||
* **Topics**: Provides an overview on how things fit togehter, the "conceptual glue" between APIs and features.
|
||||
* **Topics**: Provides an overview on how things fit together, the "conceptual glue" between APIs and features.
|
||||
This is where most documentation should live, and is the natural "second step" after finishing the tutorials.
|
||||
*Example: Templates, Testing, Datamodel*
|
||||
* **Howto**: Recipes that solve a specific task or problem, rather than describing a feature.
|
||||
@ -197,7 +197,7 @@ for good rules of thumb for documenting opensource software.
|
||||
* Don't duplicate: Search for existing places to put your documentation. Do you really require a new page, or just a new paragraph
|
||||
of text somewhere?
|
||||
* Use PHPDoc in source code: Leave lowlevel technical documentation to code comments within PHP, in [PHPDoc](http://en.wikipedia.org/wiki/PHPDoc) format.
|
||||
* Use Markdown in Developer Guides: We have a slightly customized version of Markdown called [SSMarkdown][ss-markdown]
|
||||
* Use Markdown in Developer Guides: We have a slightly customized version of Markdown called [SSMarkdown](ss-markdown)
|
||||
* API and Developer Guides complement each other: Both forms of documenting sourcecode (API and Developer Guides) are valueable ressources.
|
||||
* Provide context: Give API documentation the "bigger picture" by referring to Developer Guides inside your PHPDoc.
|
||||
* Make your documentation findable: Documentation lives by interlinking content, so please make sure your contribution doesn't become an
|
||||
@ -263,7 +263,7 @@ on placing HTML blocks inside Markdown.
|
||||
Documentation is kept alongside the source code, typically in a module subdirectory like `sapphire/docs/en/`.
|
||||
Each language has its own subfolder, which can duplicate parts or the whole body of documentation.
|
||||
German documentation would for example live in `sapphire/docs/de/`.
|
||||
The [sapphiredocs](http://open.silverstripe.org/browser/modules/sapphiredocs/trunk) module that drives
|
||||
The [sapphiredocs](https://github.com/silverstripe/silverstripe-sapphiredocs) module that drives
|
||||
[doc.silverstripe.org](http://doc.silverstripe.org) automatically resolves these subfolders into a language dropdown.
|
||||
|
||||
### Further reading
|
||||
|
||||
@ -8,6 +8,7 @@ sections.
|
||||
* [Module release process](module-release-process): Creating and looking after a module
|
||||
* [Release process](release-process): Describes the Sapphire and CMS release process
|
||||
* [SS markdown](ss-markdown): Markdown syntax for our technical documentation
|
||||
* [Subversion](subversion): Describes SilverStripe-specific information on how to handle subversion
|
||||
|
||||
## Feedback
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Module Maintenance and Release Procedures #
|
||||
# Module Maintenance and Release Procedures
|
||||
|
||||
## Creating a module
|
||||
|
||||
@ -45,7 +45,7 @@ your modules page on silverstripe.org
|
||||
* Be involved in our community
|
||||
* Subscripe to our developer mailing list and be available to answer questions on the forum.
|
||||
* Attend [irc:our weekly core discussions on IRC](irc/our weekly core discussions on IRC) as regularly as you can.
|
||||
* Create an **issue tracker** so your users can file bugs and feature requests (see ["Feedback and Bugtracking"](#feedback-and-bugtracking) below)
|
||||
* Create an **issue tracker** so your users can file bugs and feature requests (see ["Feedback and Bugtracking"](module-release-process#feedback-and-bugtracking) below)
|
||||
* Create a **roadmap** and **milestones** outlining future release planning
|
||||
|
||||
### Feedback and Bugtracking
|
||||
@ -188,10 +188,10 @@ export to a tar.gz.
|
||||
### Announcing a Release or Release Candidate
|
||||
|
||||
* See [Producing OSS: "Announcing Releases"](http://producingoss.com/en/testing-and-releasing.html#release-announcement)
|
||||
* Update your [documentation](#documentation) in the sourcecode, wiki and README
|
||||
* Update your [documentation](module-release-process#documentation) in the sourcecode, wiki and README
|
||||
* Add your release to the [silverstripe.org/modules](http://silverstripe.org/modules) listing
|
||||
* Announce the release on [silverstripe-announce](http://groups.google.com/group/silverstripe-announce). Include a
|
||||
[changelog](#changelogs), the download link and instructions for filing bug reports.
|
||||
[changelog](module-release-process#changelogs), the download link and instructions for filing bug reports.
|
||||
* If this release is a major release, our [marketing guys](http://silverstripe.com/contact/) will strive to announce it
|
||||
on the main [silverstripe.com blog](http://silverstripe.com/blog) as well
|
||||
|
||||
@ -235,8 +235,8 @@ trunk.
|
||||
|
||||
## See Also
|
||||
|
||||
[Module Development](/topics/module-development)
|
||||
[Documentation Guide](contributing#writing-documentation)
|
||||
[Contributing to SilverStripe](http://silverstripe.org/contributing-to-silverstripe/)
|
||||
[Submit your Module](http://silverstripe.org/modules/manage/add)
|
||||
[subversion](subversion)
|
||||
* [Module Development](/topics/module-development)
|
||||
* [Documentation Guide](contributing#writing-documentation)
|
||||
* [Contributing to SilverStripe](http://silverstripe.org/contributing-to-silverstripe/)
|
||||
* [Submit your Module](http://silverstripe.org/modules/manage/add)
|
||||
* [subversion](subversion)
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Release Process #
|
||||
# Release Process
|
||||
|
||||
Describes the process followed for "core" releases (mainly the `sapphire` and `cms` modules).
|
||||
For other modules, we've compiled a helpful guide for a good [module release process](module-release-process).
|
||||
|
||||
@ -17,9 +17,9 @@ and HTML output should still be readable with our custom markup unparsed.
|
||||
While most of the Markdown syntax is parseable by all common implementations,
|
||||
the special syntax is relying on a custom SilverStripe project that powers `http://doc.silverstripe.org`.
|
||||
|
||||
The website a standard SilverStripe installation with the [sapphiredocs](http://open.silverstripe.org/browser/modules/sapphiredocs/trunk)
|
||||
module installed (see module [README](http://open.silverstripe.org/browser/modules/sapphiredocs/trunk/README.md) and
|
||||
[documentation](http://open.silverstripe.org/browser/modules/sapphiredocs/trunk/docs/en)).
|
||||
The website a standard SilverStripe installation with the [sapphiredocs](https://github.com/silverstripe/silverstripe-sapphiredocs/)
|
||||
module installed (see module [README](https://github.com/silverstripe/silverstripe-sapphiredocs/blob/master/README.md) and
|
||||
[documentation](https://github.com/silverstripe/silverstripe-sapphiredocs/tree/master/docs/en)).
|
||||
|
||||
## Syntax
|
||||
|
||||
@ -40,8 +40,10 @@ not the webroot of the renderer project or the filesystem root.
|
||||
Don't forget the trailing slash for directory links,
|
||||
it is important to distinguish files from directories.
|
||||
|
||||
Note: It is recommended to use absolute links over relative links
|
||||
<div class="notice" markdown='1'>
|
||||
It is recommended to use absolute links over relative links
|
||||
to make files easier to move around without changing all links.
|
||||
</div>
|
||||
|
||||
### API Links
|
||||
|
||||
|
||||
@ -138,7 +138,7 @@ SVN:externals (also add your own general modules here, etc... etc... this should
|
||||
SVN checkout http://sunny.SVNrepository.com/SVN/myaccountname/myfirstsite.com .
|
||||
|
||||
<div class="hint" markdown="1">
|
||||
DOT at the end to check out files to current directory
|
||||
Add a DOT at the end to check out files to current directory
|
||||
</div>
|
||||
|
||||
* You should now have all your files on your webserver
|
||||
|
||||
Loading…
Reference in New Issue
Block a user