https://github.com/openlayers/workshop
https://github.com/openlayers/workshop
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/openlayers/workshop
- Owner: openlayers
- Created: 2013-10-30T12:12:42.000Z (about 12 years ago)
- Default Branch: main
- Last Pushed: 2024-12-05T02:08:38.000Z (about 1 year ago)
- Last Synced: 2025-04-04T10:58:53.500Z (9 months ago)
- Language: JavaScript
- Homepage: http://openlayers.org/workshop/
- Size: 58.9 MB
- Stars: 74
- Watchers: 16
- Forks: 78
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OpenLayers Workshop
This doc is for people developing the OpenLayers Workshop. Workshop participants work with archives downloaded from the [release pages](https://github.com/openlayers/workshop/releases).
## Building the workshop
Install Node 16+ and dependencies:
npm install
Start the development server:
npm start
The workshop content is divided into two directories. The `doc` directory contains the documentation sources. The `src` directory contains all of the sources that will be used by workshop participants (e.g. data, examples, etc.). The build process creates an archive with the build version of the docs together with the `src` files.
When adding new pages or restructuring things, update the `doc/SUMMARY.md` (this is used to generate the content tree in the navigation). Also update any of the nested `README.md` files (these provide the index page for each section).
## Creating a new release
Create a new tag and update the version in `package.json`. This can be done together with the following:
npm version v6.8.1-en.3
Choose a major, minor, and patch version that matches the `ol` release version. Increment the prerelease identifier to be higher than whatever was published last. Then push the changes to `package.json` and the new tag:
git push --tags origin main
This will results in a new `release` job in GitLab CI. The workshop archive will be built and attached to the new release.
On every push to the `main` branch, the `gh-pages` branch is updated with a `deploy` job in GitLab CI.
