Reference list of missing issues for use cases and capabilities #110

Malvoz · 2019-08-02T14:36:34Z

AmeliaBR · 2019-08-02T18:26:48Z

Yes, this is the intention. It has been on my To-do for a while to go through & find the missing cross-links. So thank you for the reference list! I will try to get to these this week.

- Introduces a standard example template, with a ToC and entries for every reference JS library. - Makes existing example pages match, and adds stub pages where they didn't exist. - Merges a few duplicate example pages from the merger of use cases. - Renames every example page to be shorter: don't include "use case" to start, match new section IDs, shorten some section IDs (note, some of the renames are showing up as delete/add, but oh well) - Make sure cross-references to example pages are correct. - Make sure cross-references to issues are correct. Also includes some new use case text, because I forgot to commit that before I got side-tracked working on the examples! Still to do: the same thing for the rest of the use cases! Related to #110 and #100

Malvoz · 2019-08-10T01:38:37Z

@AmeliaBR I've updated the lists above to reflect the changes made in 0071b30. And regarding the (new) examples that link back to use cases, many of the links are broken because they don't include some determiners while the ids for the use case sections do. For example:

The show-vector-data-overlay-map.html example links to #use-case-show-vector-data-overlay-map while the id for that section is use-case-show-a-vector-data-overlay-on-a-map. Would you rather change the ids in the spec, or the links from the examples in these cases?

AmeliaBR · 2019-08-10T01:48:07Z

Thanks for the updates @Malvoz. Yes, I'm still working on going through the rest of the links; that commit was just the first batch. But… it looks like I messed up in a few cases, by not including the use-case- prefix on the link back to the spec from the example page. I'll review that.

I've also been simplifying the IDs as I go (to make it less likely that these little discrepancies will slip through), so for your example, probably both of those will end up changed!

Once I've done a full pass, I'll run the whole thing through a link checker & make sure we get this all tidied up.

AmeliaBR · 2019-08-10T05:18:43Z

OK, I think I've fixed the broken links and filled in the missing discussion issues for all the use-case sections (as of ae59ecb).

Ran the main document through the W3C link checker, so at least I am sure that the links out of the report are OK. (Well, except for links to GitHub, since the link checker is blocked by robots.txt! But it's more likely that those are valid links but to the wrong issue rather than dead links, anyway!)

I still need to do another pass for editorial/content clean-up and standardizing the examples, so I'll double check the back-references (from the example files to the report) at that time.

Next step: missing issues for the capabilities section.
Also: avoid breaking things again as we fill in additional sections!

Malvoz · 2019-08-10T16:45:10Z

Thanks, I've updated all the lists! :)

I resorted to removing things in the checklists that have been finished instead of checking the boxes, for an easier overview of what needs TBD.

Malvoz · 2019-08-26T13:19:15Z

The list has been updated per changes in #124.

Malvoz · 2019-09-06T16:35:44Z

These use cases and capabilities are currently not linking to a corresponding github issue (perhaps because no such issue exist yet):

@AmeliaBR

I'd like to open issues for all the cases where there is none yet, and also cross reference them from the spec afterwards. Is that okay with you?

I'm not permitted to label issues - so I could add a follow-up comment on which labels for you to set to save you time, then I'd delete those comments at any time you've set the corresponding label(s).

AmeliaBR · 2019-09-08T22:02:55Z

Hi @Malvoz, If you want to go ahead and make the rest of the missing discussion pages, I would be grateful. I haven't had nearly as much time & energy for this project as I'd like this past month, and your contributions are definitely appreciated.

I've granted you Triage permissions for the repo, so you should be able to add any labels as required. But if you're not sure about any of the details, just ping me in a comment.

nchan0154 · 2019-09-09T00:11:01Z

Seconding the gratitude, @Malvoz! I have been meaning to go through these but I'm dealing with a bad case of RSI at the moment and repetitive clicking actions like making issues en-masse are difficult. Your assistance here would be much appreciated!

Malvoz · 2019-09-09T18:44:02Z

@AmeliaBR "Take my energy ༼ つ ◕_◕ ༽つ" 😄

Thanks for allowing me to do this!

And thank you @nchan0154 for the kind words, too!

AmeliaBR · 2019-09-09T18:51:43Z

Whoosh!

I admit, I had one moment of panic when I saw the 30+ notification emails. Then I realized what they all were & “Hooray!”

Thanks again. It is very great to have those links ready before the big TPAC meeting, when we'll be trying to get new people looking at the report & starting discussions.

Malvoz · 2019-09-10T15:43:49Z

@AmeliaBR, @prushforth, @nchan0154, @NickFitz
When you find that you have some time... (although this shouldn't take very long)

I think it's important (particularly for newcomers) that the issues for discussion properly link to their respective section in the report. Since refactoring some time ago, quite a few of the URLs have changed for certain sections of the report, thus they'll need to be updated - in some cases there is no link at all.

But this is all done below, so as issue owners you'll just have to edit your initial comment in each of those issues and copy & paste to include at the top:

@AmeliaBR's

Done!

Issue #12:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#mapbox">the reference tool "Mapbox GL JS API and Mapbox Studio embed"</a>.
<hr>

Issue #13:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#d3-geo">the reference tool "D3 Geographies APIs"</a>.
<hr>

Issue #26:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#openstreetmap">the reference tool "OpenStreetMap embeds"</a>.
<hr>

Issue #27:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#bing-maps">the reference tool "Bing Maps embeds and Bing Maps Control API"</a>.
<hr>

Issue #28:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#mapkit-js">the reference tool "MapKit JS (Apple Maps) API"</a>.
<hr>

Issue #29:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#leaflet-js">the reference tool "Leaflet.js API"</a>.
<hr>

Issue #30:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#openlayers">the reference tool "OpenLayers API"</a>.
<hr>

@prushforth's

Done!

Issue #3:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#capability-reproject-maps">the map viewer capability "Reproject map tile data into a new projection or globe view"</a>.
<hr>
<!-- 
Please also change the title of this issue to:
"Capability: Reproject map tile data into a new projection or globe view"
-->

Issue #9:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#google-maps">the reference tool "Google Maps embeds and Google Maps Platform API"</a>.
<hr>

Issue #14:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#capability-tile-coordinate-systems">the map viewer capability "Display map tiles defined in various common coordinate systems"</a>.
<hr>
<!--
Please also change the title of this issue to:
"Capability: Display map tiles defined in various common coordinate systems"
-->

Issue #15:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#capability-styled-features">the map viewer capability "Apply custom styling to map markers and vector features"</a>.
<hr>
<!--
Please also change the title of this issue to:
"Capability: Apply custom styling to map markers and vector features"
-->

Issue #16:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#capability-custom-controls">the map viewer capability "Toggle whether default controls are displayed"</a>.
<hr>
<!--
Please also change the title of this issue to:
"Capability: Toggle whether default controls are displayed"
-->

Issue #21:

Please change the title of this issue to:
"Access additional information about a point on the map".

@NickFitz's

Done!

Issue #50:

This issue is for general discussions of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#client-apis">the "Client-side Mapping API Capabilities"</a>.
<hr>

Issue #55:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#capability-create-initialise-and-display-a-map">the API capability "Create, initialise, and display a map"</a>.
<hr>

Issue #57:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#capability-implement-a-custom-control">the API capability "Implement a custom control"</a>.
<hr>

Issue #74:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#capability-define-data-source-tile-layer">the required API capability "Define a data source for a tile layer"</a>.
<hr>

Issue #81:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#use-case-alternative-layers">the use case "Provide alternative map layers which the user can select"</a>.
<hr>

@nchan0154's

Done!

Issue #49:

This issue is for discussion of <a href="https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#tomtom">the reference tool "TomTom Maps SDK for Web"</a>.
<hr>

NickFitz · 2019-09-10T16:10:09Z

@Malvoz I've just done mine, including editing the title for a couple of them to match the section they refer to where the wording of that's changed.

Thanks for your work on this!

Malvoz · 2019-09-10T16:37:20Z

@NickFitz

Thanks!

I had actually missed updating the link for #74, I've updated it now, could you redo that one?

NickFitz · 2019-09-10T16:42:50Z

@Malvoz No problem, done :-)

nchan0154 · 2019-09-11T00:00:55Z

Done, thank you @Malvoz!

prushforth · 2019-09-13T16:23:48Z

Thank you Robert, you are a great collaborator! Done.

prushforth · 2019-09-13T16:35:04Z

I did @AmeliaBR's too, cause she's either busy or asleep. I hope that's not bad github etiquette? I was on a roll in an airport lounge...

Malvoz · 2019-09-13T16:54:50Z

Thanks Peter!

Regarding issue #21 - I had missed to include "Use Case:" in its title, it should rather be:
"Use case: Access additional information about a point on the map".

And in #9 you can remove the outdated reference:

Relevant section: https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/#google-maps-embeds-and-google-maps-platform-api

now that you've added the new reference.

Again, thanks, for doing both yours and Amelia's. This is great! Safe travels! 😄

AmeliaBR · 2019-09-14T08:10:21Z

Thanks Peter & Robert!

When I came up with this idea of using GitHub issues for section-by-section discussion, I did not think about all the extra work of keeping them in sync as the document gets re-written and re-organized!

Malvoz · 2019-10-07T14:29:48Z

The example pages have been revamped some time ago, and will need more work but I no longer consider them (or them not linking properly to the spec) "broken", closing this. Thanks for all your help! :)

AmeliaBR added the meta/process An issue related to how the work or repo is managed. label Aug 2, 2019

Malvoz changed the title ~~[meta/process] Is the intention that all use cases and capabilities have their own issue?~~ Reference list of missing issues for use cases and capabilities Aug 4, 2019

This comment has been minimized.

Sign in to view

Malvoz mentioned this issue Sep 9, 2019

Cross-reference the recently opened issues #162

Merged

Malvoz closed this as completed Oct 7, 2019

Reference list of missing issues for use cases and capabilities #110

Reference list of missing issues for use cases and capabilities #110

Comments

Malvoz commented Aug 2, 2019 • edited Loading

AmeliaBR commented Aug 2, 2019

This comment has been minimized.

Malvoz commented Aug 10, 2019 • edited Loading

AmeliaBR commented Aug 10, 2019

AmeliaBR commented Aug 10, 2019

Malvoz commented Aug 10, 2019 • edited Loading

Malvoz commented Aug 26, 2019

Malvoz commented Sep 6, 2019

AmeliaBR commented Sep 8, 2019

nchan0154 commented Sep 9, 2019

Malvoz commented Sep 9, 2019

AmeliaBR commented Sep 9, 2019

Malvoz commented Sep 10, 2019 • edited Loading

@AmeliaBR's

Issue #12:

Issue #13:

Issue #26:

Issue #27:

Issue #28:

Issue #29:

Issue #30:

@prushforth's

Issue #3:

Issue #9:

Issue #14:

Issue #15:

Issue #16:

Issue #21:

@NickFitz's

Issue #50:

Issue #55:

Issue #57:

Issue #74:

Issue #81:

@nchan0154's

Issue #49:

NickFitz commented Sep 10, 2019

Malvoz commented Sep 10, 2019

NickFitz commented Sep 10, 2019

nchan0154 commented Sep 11, 2019

prushforth commented Sep 13, 2019

prushforth commented Sep 13, 2019

Malvoz commented Sep 13, 2019 • edited Loading

AmeliaBR commented Sep 14, 2019

Malvoz commented Oct 7, 2019 • edited Loading

Malvoz commented Aug 2, 2019 •

edited

Loading

Malvoz commented Aug 10, 2019 •

edited

Loading

Malvoz commented Aug 10, 2019 •

edited

Loading

Malvoz commented Sep 10, 2019 •

edited

Loading

Malvoz commented Sep 13, 2019 •

edited

Loading

Malvoz commented Oct 7, 2019 •

edited

Loading