diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..732ed42d97 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,7 @@ +This issue tracker is for reporting bugs or feature requests, not for asking questions. For usage questions, refer to the (documentation)[http://openlayers.org/en/latest/doc/]. + +Ready to submit your bug or feature request? Make sure these boxes are checked before submitting your issue. Thank you! + +- [ ] I have searched GitHub to see if a similar bug or feature request has already been reported. +- [ ] If reporting a bug, I have tried with the latest version of OpenLayers (see 'LATEST' on https://openlayers.org/) +- [ ] If reporting a bug, I have created a [CodePen](https://codepen.io) or prepared a stack trace (using the latest version and unminified code, so e.g. `ol-debug.js`, not `ol.js`) that shows the issue. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..6849bfa0f8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,5 @@ +Make sure these boxes are checked before submitting your pull request. Thank you! + +- [ ] This pull request addresses an issue that has been marked with the 'Pull request accepted' label. +- [ ] It contains one or more small, incremental, logically separate commits, with no merge commits. +- [ ] I have used clear commit messages. diff --git a/README.md b/README.md index ee87fd8952..70d4bb5318 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,13 @@ ## Getting Started +Use one of the following methods to use OpenLayers in your project: + +- For use with mainstream bundlers and minifiers, install the [ol](https://www.npmjs.com/package/ol) npm package: `npm install ol` +- Use `ol.js` and `ol.css` from (cdnjs)[https://cdnjs.com/libraries/openlayers] - Download the [latest release](https://openlayers.org/download/) -- Install with npm: `npm install openlayers` - Clone the repo: `git clone git@github.com:openlayers/openlayers.git` +- For use with Closure Library, install the [openlayers](https://npmjs.com/package/openlayers) npm package and read the [tutorial](http://openlayers.org/en/latest/doc/tutorials/closure.html). ## Supported Browsers @@ -33,4 +37,3 @@ Please see our guide on [contributing](CONTRIBUTING.md) if you're interested in - Need help? Find it on [Stack Overflow using the tag 'openlayers'](http://stackoverflow.com/questions/tagged/openlayers) - Follow [@openlayers](https://twitter.com/openlayers) on Twitter -- Discuss with openlayers users on IRC in `#openlayers` at `chat.freenode` diff --git a/doc/index.hbs b/doc/index.hbs index 8a170878bb..ba62116e51 100644 --- a/doc/index.hbs +++ b/doc/index.hbs @@ -11,7 +11,7 @@ For a more in-depth overview of OpenLayers core concepts, check out the [tutoria Make sure to also check out the [OpenLayers workshop](/workshop/). -Find additional reference material in the [API docs](../apidoc). +Find additional reference material in the [API docs](../apidoc) and [examples](../examples). # Frequently Asked Questions (FAQ) @@ -19,4 +19,4 @@ We have put together a document that lists [Frequently Asked Questions (FAQ)](fa # More questions? -If you cannot find an answer in the documentation or the FAQ, you can ask your question on [Stack Overflow using the tag 'openlayers'](http://stackoverflow.com/questions/tagged/openlayers). +If you cannot find an answer in the documentation or the FAQ, you can search [Stack Overflow](http://stackoverflow.com/questions/tagged/openlayers). If you cannot find an answer there, ask a new question there, using the tag 'openlayers'. diff --git a/doc/tutorials/browserify.md b/doc/tutorials/browserify.md index f33387b13d..a405178004 100644 --- a/doc/tutorials/browserify.md +++ b/doc/tutorials/browserify.md @@ -5,57 +5,56 @@ layout: doc.hbs # Introduction -When going beyond modifying existing examples you might be looking for a -way to setup your own code with dependency management together with external -dependencies like OpenLayers. +When going beyond modifying existing examples you might be looking for a way to setup your own code with dependency management together with external dependencies like OpenLayers. -This tutorial serves as a suggested project setup using NPM and Browserify -for the most basic needs. There are several other options and in particular -you might be interested in -[compiling your own code together with OpenLayers](closure.html). +This tutorial serves as a suggested project setup using NPM and Browserify for the most basic needs. There are several other options, and in particular you might be interested in a more modern one (ES2015) [using Webpack with OpenLayers](https://gist.github.com/tschaub/79025aef325cd2837364400a105405b8). ## Initial steps -Create a new empty directory for your project and navigate to it by running -`mkdir new-project && cd new-project`. Initialize your project using `npm init` -and answer the questions asked. +Create a new empty directory for your project and navigate to it by running `mkdir new-project && cd new-project`. Initialize your project using `npm init` and answer the questions asked. -At this point you can ask NPM to add required dependencies by running -`npm install --save-dev openlayers browserify watchify uglify-js`. Watchify and -Uglify will be used to monitor for changes and to build into a minified -bundle. +Add OpenLayers as dependency to your application with `npm install --save ol`. + +At this point you can ask NPM to add required development dependencies by running +``` +npm install --save-dev cssify browserify cssify http-server uglify-js watchify +npm install --save-dev babelify babel-plugin-transform-es2015-modules-commonjs +``` +We will be using `cssify` to include the css definitions required by OpenLayers in our bundle. `watchify`, `http-server` and `uglify-js` are used to monitor for changes and to build into a minified bundle. `babelify` and `babel-plugin-transform-es2015-modules-commonjs` are used to make the `ol` package, which was created using ES2015 modules, work with CommonJS. ## Application code and index.html Place your application code in `index.js`. Here is a simple starting point: ```js -var ol = require('openlayers'); - -var map = new ol.Map({ +require('ol/ol.css'); +var ol_Map = require('ol/map').default; +var ol_layer_Tile = require('ol/layer/tile').default; +var ol_source_OSM = require('ol/source/osm').default; +var ol_View = require('ol/view').default; + +var map = new ol_Map({ target: 'map', layers: [ - new ol.layer.Tile({ - source: new ol.source.OSM() + new ol_layer_Tile({ + source: new ol_source_OSM() }) ], - view: new ol.View({ + view: new ol_View({ center: [0, 0], zoom: 0 }) }); ``` -You will also need an `ìndex.html` file that will use your bundle. Here is a simple -example: +You will also need an `ìndex.html` file that will use your bundle. Here is a simple example: ```html - +