Shortcode for openstreetmap

[imranakram]

I wanted to add a map view on the about page and managed to do this via openstreetmap. Thought it would be fun to push a PR so it benefits more people. This is my first PR for a Hugo theme.

Changes / fixes

• Added a new shortcode for adding map using openstreetmap
• Updated readme
• Spelling fixed on exampleSite/content/post/notices.md

Screenshots (if applicable)

Checklist

Ensure you have checked off the following before submitting your PR.

• [x] tested locally with the latest release of Hugo. This requirement is a standard
• [x] added new dependencies
• [x] updated the [docs]() ⚠️

[onweru]

Thanks @imranakram for contributing, will review this PR asap.

[rootwork]

Four thoughts:

1. This doesn't just add support for embedding OpenStreetMaps, which is a little unintuitive, but possible directly from OSM. It's adding support for uMap, which is a tool to create maps using OSM, and embed those creations -- in addition to a regular OSM map -- on a site. That seems fine; it definitely looks easier than OSM and obviously has more functionality, but we might want to be clear about what we're adding, and/or change the shortcode if we think we'd want to add direct OSM embedding at some point.
2. The maps uMap creates seem to (sometimes?) pull in French-language OSM data even when the uMap path includes en. e.g. just clicking to create a sample map took me here which at least for me is showing a map of Europe with French names (Londres, Bruxelles, etc.). That might just be a bug with uMap.
3. Embedded iframes don't scale great at smaller screens i.e. smartphones. This would be a problem with any embedded map but I don't know if we'd want to add some CSS to try to adjust things. Right now the map just gets cut off; it could also create horizontal scrolling in some environments.
4. There's one spelling correction that's out of scope, but I don't know how strongly @onweru @chipzoller feel about that.

[chipzoller]

@imranakram can you address and resolve conflicts?

[chipzoller]

@onweru and @rootwork please review and approve or suggest feedback

[rootwork]

It doesn't look like anything has changed, it looks like the branch was just updated with the latest master. Or am I missing something?

[chipzoller]

@imranakram it doesn't appear maintainer comments have been attended to. Can you address or respond?

[imranakram]

Four thoughts:

1. This doesn't just add support for embedding OpenStreetMaps, which is a little unintuitive, but possible directly from OSM. It's adding support for uMap, which is a tool to create maps using OSM, and embed those creations -- in addition to a regular OSM map -- on a site. That seems fine; it definitely looks easier than OSM and obviously has more functionality, but we might want to be clear about what we're adding, and/or change the shortcode if we think we'd want to add direct OSM embedding at some point.

Yes that is correct!

2. The maps uMap creates seem to (sometimes?) pull in French-language OSM data even when the uMap path includes en. e.g. just clicking to create a sample map took me here which at least for me is showing a map of Europe with French names (Londres, Bruxelles, etc.). That might just be a bug with uMap.

This seems like a bug on uMaps part as you mentioned.

3. Embedded iframes don't scale great at smaller screens i.e. smartphones. This would be a problem with any embedded map but I don't know if we'd want to add some CSS to try to adjust things. Right now the map just gets cut off; it could also create horizontal scrolling in some environments.

I agree, I'm not a huge fan of iFrames either, would be nice to have some implementation that avoids it but that's not my forte` 😊

4. There's one spelling correction that's out of scope, but I don't know how strongly @onweru @chipzoller feel about that.

I basically resolved conflicts in the latest commit

[rootwork]

OK, so then I think it's just a question of how @chipzoller @onweru feel about the first item above; if we should be clear about or change the shortcode name for what's being embedded.

[onweru]

I think this PR looks good. 1) Documentation is good 2) It's a shortcode, anyone who wants to use it will decide if or not they mind the iframe. Merge 👍🏼. Thanks again @imranakram for contributing.

[chipzoller]

Conflicts in README.md to be resolved.

[chipzoller]

@imranakram there are changes requested here

[chipzoller]

Still looking for some updates here.

[imranakram]

hi @chipzoller @rootwork I'm back to this, sorry I had to be away for sometime.

[imranakram]

@chipzoller I've merged with the latest, resolved conflicts and pushed fixes to address the comments. Please have a look :)

[chipzoller]

Ivan has requested changes still and there are comments yet unresolved.