From 04bab7e4369ec6c82c0559cfbecb3c3db25c3107 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Thu, 27 Jun 2013 15:56:11 -0600 Subject: [PATCH 1/3] The examples and docs are deployed from the openlayers.github.io repo To deploy the latest docs and examples, see https://github.com/openlayers/openlayers.github.io/blob/build/README.md tl;dr git clone -b build https://github.com/openlayers/openlayers.github.io.git cd openlayers.github.io npm install npm run deploy Subsequent deploys are simply: `npm run deploy` This publishes the examples (http://ol3js.org/en/master/examples/) and docs (http://ol3js.org/en/master/apidoc/). The `build.py gh-pages` target published under different paths (http://ol3js.org/ol3/master/examples/ and http://ol3js.org/ol3/master/apidoc/). Having two (not always up to date) copies of this content hosted on the same domain is A Bad Idea. --- build.py | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/build.py b/build.py index 8077cb40a8..1da19aaf49 100755 --- a/build.py +++ b/build.py @@ -574,20 +574,6 @@ def plovr_jar(t): t.info('downloaded %r', t.name) -@target('gh-pages', 'host-examples', 'doc', phony=True) -def gh_pages(t): - with t.tempdir() as tempdir: - t.run('%(GIT)s', 'clone', '--branch', 'gh-pages', - 'git@github.com:openlayers/ol3.git', tempdir) - with t.chdir(tempdir): - t.rm_rf('%(BRANCH)s') - t.cp_r('build/gh-pages/%(BRANCH)s', tempdir + '/%(BRANCH)s') - with t.chdir(tempdir): - t.run('%(GIT)s', 'add', '--all', '%(BRANCH)s') - t.run('%(GIT)s', 'commit', '--message', 'Updated') - t.run('%(GIT)s', 'push', 'origin', 'gh-pages') - - virtual('doc', 'build/jsdoc-%(BRANCH)s-timestamp' % vars(variables)) From dc246cd45bdb8722e9fecaf0c778c1122f4cc3b1 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Thu, 27 Jun 2013 15:59:52 -0600 Subject: [PATCH 2/3] Correct links to hosted examples (and docs) --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1e12091079..aeee69e227 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ [![Travis CI Status](https://secure.travis-ci.org/openlayers/ol3.png)](http://travis-ci.org/#!/openlayers/ol3) -Welcome to OpenLayers 3! +Welcome to [OpenLayers 3](http://ol3js.org/)! -To see OpenLayers 3 in action you can look at the live examples on -http://openlayers.github.io/ol3/master/examples/. If you want to contribute -to OpenLayers 3 please read the [CONTRIBUTING](CONTRIBUTING.md) page. +Check out the [hosted examples](http://ol3js.org/en/master/examples/) or poke around the evolving [API docs](http://ol3js.org/en/master/apidoc/). + +Please see our guide on [contributing](CONTRIBUTING.md) if you're interested in getting involved. From e1a2c725876ea9c9058099d5f5ea9318fbbc9f69 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Thu, 27 Jun 2013 16:01:22 -0600 Subject: [PATCH 3/3] Adjective -> adverb --- doc/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/index.md b/doc/index.md index 1fb377193a..e7fa1d4d02 100644 --- a/doc/index.md +++ b/doc/index.md @@ -1,5 +1,5 @@ -Finding your way round ----------------------- +Finding your way around +----------------------- See the class list to the right and especially take a look at {@link ol.Map} and {@link ol.layer.Layer} because those are the central objects. In general every use of OpenLayers starts by initializing a map, then adding the required layers. Controls and interactions can be added to change the behavior of the map.