Skip to content

Commit

Permalink
Merge branch 'release-10.2.3' into stable
Browse files Browse the repository at this point in the history
  • Loading branch information
DominicWatson committed Oct 19, 2015
2 parents 5d859d5 + 72ea336 commit 4a25a44
Show file tree
Hide file tree
Showing 435 changed files with 33,044 additions and 10,435 deletions.
3 changes: 2 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ env:
- PLATFORM=railo42 TARGET=build
global:
- ARTIFACTS_S3_BUCKET=downloads.presidecms.com

- secure: jvsE21m7x0RdzxWGdbcxoxiCdXnUfhb654tkfbuK67DJ5/Suk3P1QfPSFpWpanuzm+X1kNzcrKnz84iTG+Me0m+ypd3eeHWL6e4qFyoYunpFxCxx0GPlto+bcZ8mARNt6HmTwTpsbwMpJxiP5c2DqTu85go5blaITmgpFlT/bkU=
- secure: F6I7UIinztbSglyuvR1QxfNHmi3ZjsV9kqx0NeKm5zzAoYJWg5vF8/WMkn8NI80Q+89CRZwb56JPMedCLJndum6t7/NS1fpBW8/bP0FzRU+1/KvG0U99UiESnEAKcMGSgh5lq/74+sn0qApuTSVuSg9fsar/h3Gg5Xj0A+6Jias=
before_script:
- mysql -e 'create database preside_test;'

Expand Down
2 changes: 1 addition & 1 deletion support/build/build.properties
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ build.number.remote.url=http://downloads.presidecms.com/presidecms/build.number

##############################
# MANUALLY UPDATE EACH VERSION
preside.version=10.2.2
preside.version=10.2.3
##############################
8 changes: 7 additions & 1 deletion support/build/build.xml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
</path>
<taskdef resource="net/sf/antcontrib/antlib.xml" classpathref="cp" />

<target name="build" depends="setupartifactsdir,setupoutputdir,install-preside-deps,setupreleaselabel">
<target name="build" depends="setupartifactsdir,setupoutputdir,install-preside-deps,setupreleaselabel,builddocs">
<concat destfile="../../${build.label}">Built on ${start.TODAY}</concat>
<echo file="../../version.json">{ "version":"${preside.version}.${build.number}" }</echo>

Expand Down Expand Up @@ -233,4 +233,10 @@ Valid values are:
<property file="${build.number.file}" />
</target>

<target name="builddocs">
<exec executable="/bin/bash" failonerror="true">
<arg line="../docs/build.sh"/>
</exec>
</target>

</project>
1 change: 0 additions & 1 deletion support/docs/.gitignore

This file was deleted.

19 changes: 17 additions & 2 deletions support/docs/Application.cfc
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
component output=false {
this.mappings[ "/preside" ] = ExpandPath( "../../" );
component {
this.name = "presideDocumentationBuilder-" & Hash( GetCurrentTemplatePath() );

this.cwd = GetDirectoryFromPath( GetCurrentTemplatePath() )

this.mappings[ "/api" ] = this.cwd & "api";
this.mappings[ "/builders" ] = this.cwd & "builders";
this.mappings[ "/docs" ] = this.cwd & "docs";
this.mappings[ "/import" ] = this.cwd & "import";
this.mappings[ "/builds" ] = this.cwd & "builds";
this.mappings[ "/preside" ] = ExpandPath( this.cwd & "../../" );

public boolean function onRequest( required string requestedTemplate ) output=true {
include template=arguments.requestedTemplate;

return true;
}
}
177 changes: 0 additions & 177 deletions support/docs/Makefile

This file was deleted.

35 changes: 35 additions & 0 deletions support/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# PresideCMS documentation source and builder

[![Build Status](https://travis-ci.org/pixl8/preside-docs.svg?branch=master)](https://travis-ci.org/pixl8/preside-docs)

This directory contains the source and build scripts for creating Preside CMS's documentation. The website output of the docs can be found at [http://docs.presidecms.com](http://docs.presidecms.com).

## Build locally

### Prerequisites

The only dependency required is [CommandBox](http://www.ortussolutions.com/products/commandbox). Ensure that commandbox is installed and that the `box` command is in your path.

### Building the static documentation output

The purpose of the structure of the documentation is to allow a human readable and editable form of documentation that can be built into multiple output formats. At present, we have an "HTML" builder and a "Dash docs" builder, found at `./builders/html` and `./builders/dash` that will build the documentation website and dash docset respectively. The source of the documentation can be found in the `./docs` folder.

To run the build, execute the `build.sh` file found in the root of the project, i.e.

documentation>./build.sh

Once this has finished, you should find `./builds/html` and `./builds/dash` directories with the website content / dash docsets built.

### Running a server locally

We have provided a utility server who's purpose is to run locally to help while developing/writing the documentation. To start it up, execute the `serve.sh` file found in the root of the project, i.e.

documentation>./serve.sh

This will spin up a server using CommandBox on port 4040 and open it in your browser. You should also see a tray icon that will allow you to stop the server. Changes to the source docs should trigger an internal rebuild of the documentation tree which may take a little longer than regular requests to the documentation.

> Note: there is currently no batch file equivalent for Windows. If you are running on windows, it should be fairly trivial to copy and adapt what is found in the `.sh` file (please let us know if you get this working).
### License

The project is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-nc-sa/3.0/).

0 comments on commit 4a25a44

Please sign in to comment.