Giter VIP home page Giter VIP logo

openlayers.github.io's Introduction

OpenLayers Website

This repository is the source for the https://openlayers.org website. Commits to the default branch (main) trigger a deploy. The contents of the dist directory will be published to the website.

openlayers.github.io's People

Contributors

ahocevar avatar d-koppenhagen avatar elemoine avatar fredj avatar klokan avatar marcjansen avatar mike-000 avatar petrsloup avatar thomasg77 avatar tschaub avatar twpayne avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

openlayers.github.io's Issues

Links to source code exact lines are broken from lowercase L

The links to the GitHub source code (exact lines) are broken. They have an anchor to the exact line, like "#l234", but this should be a capital L, like "L234".

To reproduce:
Go to http://openlayers.org/en/latest/apidoc/ol.source.Vector.html#clear
At the top right, click the link "line 382".
It goes to the right source code page, but it doesn't go to the anchor for the line number.
It goes to https://github.com/openlayers/ol3/blob/v3.17.1/src/ol/source/vectorsource.js#l382
If you change the URL to use a capital L, then it works:
https://github.com/openlayers/ol3/blob/v3.17.1/src/ol/source/vectorsource.js#L382

I don't know if the lowercase is a recent change, or if you have always had it lowercase and GitHub only recently removed support for case-insensitivity. GitHub uses a capital L for its own links, presumably to avoid ambiguity between l, 1, and I.

Build docs

Currently, the default task just checks out the master branch and calls build.py. Next (or instead depending on build dependencies), it should build the docs.

If the pake target is called build/jsdoc-master-timestamp then this would look like the following:

grunt buildpy:build/jsdoc-master-timestamp

In the same way, any pake targets can be called (multiple args to build.py are separated by ":" e.g. grunt buildpy:foo:bar).

Building the site for tag v4.1.1 error

It works when I built the site for latest version, however when i run the following script to build the site for tag v4.1.1 it didn't works.
treeish=v4.1.1 npm run deploy
And the output error is
Running "run:ol" (run) task npm ERR! missing script: build-legacy
so, i checkout Updating for v4.1.1 edition, then run above script,but it show the following error
Running "make:examples" (make) task info ol Parsing dependencies info ol Compiling 345 sources vents.js:183 throw er; // Unhandled 'error' event
My project already has used openlayers 4.1.1 for quite a long time, could anyone please show me the righ way to build v4.1.1 docs ?

Change to using Cloudflare as front-end?

I'm doing this with my own Github Pages site now, and it has several advantages. The main one is that they provide a basic form of SSL, so pages stored on Github pages can be served with https (Github itself only partly supports this). This is though not properly secure, and shouldn't be used for sensitive data, but I don't think this applies to what openlayers.org is serving anyway. They recently introduced a force https option, so all http requests are automatically served as https. This should fix #53, and also openlayers/openlayers#5276. There's also an option to use http/2 (I believe this is now the default), and this should speed up for example the loading of the 'raw' examples. There are various other useful options, such as caching, all available with the free plan.

Update website to point to v5.3.1

The website currently shows 5.3.0 as latest release, while we released 5.3.1 some days ago.

Would updating simply mean the following?

# in a clone of this repo
# on the deploy branch
$  treeish=v5.3.1 npm run deploy

Plugins

Moving an extract of this conversation to get help in next steps.

Well, actually, I'm a bit lost where to put things.

What I have in mind is:

But what about:
git add some-path/to/plugins.md
git commit ...
git push ...

Is this done with npm run deploy?

no link to v4 documentation?

Earlier this year I started a project on v4 and felt that the API docs were very useful and applicable to my usage. Today I went back to tweak how some touch interactions were handled in my project, and I found that the v4 API documentation was missing and all that I am able to see is v5 documentation... there's a link to v2 documentation, but why not a link to v4 documentation?

The v5 documentation seems much harder to navigate and find concrete descriptions of the interactions compared to the v4 documentation. Additionally, it looks like the API has changed, so it's not much use to me.

Can you continue to host the v4 API documentation the same as many other projects continue to host older versions of their API docs?

Access to API JS through https

I've tried to use a protocol-relative URL to OpenLayers.js in Django (https://code.djangoproject.com/ticket/25436), but it fails, because https://openlayers.org/api/2.13.1/OpenLayers.js cannot be accessed (times out).

When trying to use the github.io subdomain, it redirects:

% curl -I http://openlayers.github.io/api/2.13.1/OpenLayers.js
HTTP/1.1 301 Moved Permanently
[...]
Location: http://openlayers.org/api/2.13.1/OpenLayers.js

Can this be supported?
Should Django use cdnjs, or another similar service instead?

Generate list of builds and provide navigation

Prior to running the publish task, we can generate a script that includes the list of builds (subdirs in en). The task that does this can be configured with a default (e.g. r3.0.0-alpha.1) to be shown by default.

X-Content-Type-Options: nosniff

I recently built a site using the following tags in my HTML:

<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta charset="UTF-8" name="viewport" content="user-scalable=no, width=device-width, height=device-height, maximum-scale=1.0, minimum-scale=1.0, initial-scale=1.0">
        <title>OpenLayers example</title>
        <link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/openlayers/openlayers.github.io@master/en/v6.5.0/css/ol.css" type="text/css">
        <link rel="stylesheet" href="style.css" />
        <script src="https://cdn.jsdelivr.net/gh/openlayers/openlayers.github.io@master/en/v6.5.0/build/ol.js"></script>
        <script src="https://unpkg.com/[email protected]/dist/olms.js" type="text/javascript"></script>
        
    </head>

Everything was working fine until a few hours ago. Now I am getting:

The resource from “https://cdn.jsdelivr.net/gh/openlayers/openlayers.github.io@master/en/v6.5.0/build/ol.js” was blocked due to MIME type (“text/plain”) mismatch (X-Content-Type-Options: nosniff).

Nothing has changed on my end for the last several days.

Did something change on the Openlayers side?

The issue seems to arise in Firefox, Chrome, and Chromium. Somehow, it is fine in Safari.

npm start raises error about rimraf module

I'm unable to solve this one, happens even on a clean checkout directory. Have run npm install followed by npm start:

Running "checkout" task
Cloning git://github.com/openlayers/ol3.git into .grunt/openlayers-website/repo
Fetching from origin
Fetching tags from origin
Cleaning
Checking out origin/master

Running "install" task

Running "buildpy:examples" (buildpy) task
>> 2014-10-10 16:38:55,477 build/ol-debug.js: node tasks/build.js config/ol-debug.json build/ol-debug.js
>> info
>> 
>> ol
>> Parsing dependencies
>> info
>> ol No compile options found.  Concatenating 333 sources
>> ERR!
>> Trouble concatenating sources.  EMFILE, open '/Users/bartvandeneijnden/opengeo/git/openlayers.github.io_bartvde/.grunt/openlayers-website/repo/src/ol/format/igcformat.js'
>> 
>> module.js:340
>> throw err;
>>           ^
>> Error: Cannot find module 'rimraf'
>>     at Function.Module._resolveFilename (module.js:338:15)
>>     at Function.Module._load (module.js:280:25)
>>     at Module.require (module.js:364:17)
>>     at require (module.js:380:17)
>>     at cleanupDirs (/Users/bartvandeneijnden/opengeo/git/openlayers.github.io_bartvde/.grunt/openlayers-website/repo/node_modules/temp/lib/temp.js:96:20)
>>     at process.cleanup (/Users/bartvandeneijnden/opengeo/git/openlayers.github.io_bartvde/.grunt/openlayers-website/repo/node_modules/temp/lib/temp.js:119:19)
>>     at process.EventEmitter.emit (events.js:95:17)
>>     at process.exit (node.js:707:17)
>>     at module.exports (/Users/bartvandeneijnden/opengeo/git/openlayers.github.io_bartvde/.grunt/openlayers-website/repo/tasks/build.js:266:15)
>>     at /Users/bartvandeneijnden/opengeo/git/openlayers.github.io_bartvde/.grunt/openlayers-website/repo/node_modules/async/lib/async.js:485:30
>> 2014-10-10 16:38:59,287 build/ol-debug.js: clean
>> 2014-10-10 16:38:59,288 pake: build/ol-debug.js: Command '['node', 'tasks/build.js', 'config/ol-debug.json', 'build/ol-debug.js']' returned non-zero exit status 8
Warning: build.py failure: 1 Use --force to continue.

Aborted due to warnings.
npm ERR! weird error 3
npm ERR! not ok code 0

Add index.html

We should start by adding a simple index file at the root. This will be made available at openlayers.github.io (and soon at ol3js.org).

Publicize The book of OpenLayers3

Hi,
Sorry if it is not the right way but I don't know how to contact with main developers so I decide to make through github.

For OpenLayers2 the web page contains links to some books. Is there a possibility to publicize the The Book of OpenLayers3 (https://leanpub.com/thebookofopenlayers3) in the OpenLayers3 main page?

Can I make a PR with the modifications?

Thanks in advance.

Codesandbox links not working for examples

The links to codesandbox in the examples do not work. They point to https://codesandbox.io/api/v1/sandboxes/define which only shows following error message:

{"error":"This endpoint requires the params `files` or `parameters` in order to work. See https://codesandbox.io/docs/importing#create-wizard for more details."}

Steps to reproduce:

  1. Open an OpenLayers Example (e.g. https://openlayers.org/en/latest/examples/vector-layer.html)
  2. Click on the Edit button in the upper right corner

CSS style mistake

Hi.
You have css style mistake on page concepts.html

<div id="map" style="width: 100%, height: 400px"></div>

should be

<div id="map" style="width: 100%; height: 400px"></div>

Move docs, examples, and built resources out of build dir

After building docs and other resources, artifacts should be moved out of the build dir into a folder at the root. Since our docs are in English, one sensible alternative would be to make a folder at the root called en. Then we'd end up with things like openlayers.github.io/en/master/doc, openlayers.github.io/en/r3.0.0-alpha.1/doc, etc.

Repository size exceeds 50 MB breaking jsDelivr

Today I got hit by surprise that URL for version 5.3.0 of ol.js mentioned in docs some time ago stopped working.

https://cdn.jsdelivr.net/gh/openlayers/openlayers.github.io@master/en/v5.3.0/build/ol.js
returns:

Package size exceeded the configured limit of 50 MB. Try https://github.com/openlayers/openlayers.github.io/tree/master/en/v5.3.0/build/ol.js instead.

I expected these URLs to last, but apparently due to lack of versioning, "master" branch of openlayers.github.io exceeded 50 MB limit imposed by jsDelivr, causing some files to be missing from CDN.

Please either contact jsDelivr to increase this limit or add some kind of tagging scheme where individual tag contains only a single version of library, staying within the limit.

Navigation hidden

When viewing the site in Chrome 34, I don't see the navigation links (docs, examples, code). Making the page narrow, clicking on the menu button, and then making the page wide again causes the navigation to reappear.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.