Edit and update documentation for more clarity #367

crisner · 2020-01-28T12:25:00Z

Fixes #354 (<=== Add issue number here)

Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!

PR is descriptively titled 📑 and links the original issue above 🔗
tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR
code is in uniquely-named feature branch and has no merge conflicts 📁
screenshots/GIFs are attached 📎 in case of UI updation
ask @publiclab/reviewers for help, in a comment below

We're happy to help you get this ready -- don't be afraid to ask for help, and don't be discouraged if your tests fail at first!

If tests do fail, click on the red X to learn why by reading the logs.

Please be sure you've reviewed our contribution guidelines at https://publiclab.org/contributing-to-public-lab-software

Thanks!

crisner · 2020-01-28T12:33:20Z

@jywarren, @sagarpreet-chadha I would like some feedback on the readme file. Thanks!

Also, I was not sure what details to provide under 'Reach out to maintainers' section. Should I put a link to the Public Lab maintainers team, https://github.com/orgs/publiclab/teams/maintainers?

crisner · 2020-01-28T12:36:26Z

@nstjean, I would like your suggestions on this as well. I would like to know if there are sections that may not be clear to the reader. Would you take a look at this when you have the time? Thanks!

crisner · 2020-01-28T12:38:05Z

README.md


 | Layer Name                  | Color   |
 | --------------------------- | ------- |
 | wisconsin                   | N/A     |
 | fracTrackerMobile           | N/A     |
 | purpleLayer                 | #8b0000 |
 | purpleairmarker             | #800080 |
-| skyTruth                    | #ff0000 |
+| skytruth                    | #ff0000 |


Had somehow missed changing this last time. Fixed it to be consistent with the layer names used in the hash.

So, one thing here could be linking to the info.json file for the layer, which would include the description text that gives the layer more context. That way also we wouldn't have to write out such text 2x -- what do you think?

Oh I like that idea. Link right to the lines with the info, that way we don't have to keep updating the readme.

I think that's a great idea! 😃

So, let me get this straight. We would be linking each layer name here to its information in the info.json file?

That's what I would do, yes! 😃

We do not have all the layers listed in info.json whereas layersData.json has information for all layers. Because there is a lot of overlap between the two layers I am thinking it is best to combine them than repeat information for all layers again in the info.json file and also that it is best to do it now than later. I recall there were concerns regarding the overlap in the information before. I will attempt this in a separate PR as I may have to refactor some code in the layersBrowser.js util. Once that is done I'll link the layer names here to their respective section in the info.json file.

Sounds great. Thank you!

crisner · 2020-01-28T12:44:32Z

Also, I think a link to the post that explains the new features in detail would help? I could make a post on publiclab.org about the new features with images and link them here or would it be better to add screenshots of the features under the respective sections? @jywarren, what do you think?

jywarren · 2020-01-28T15:50:57Z

That would be super! Thank you @crisner !!

nstjean · 2020-01-28T18:24:58Z

So this part was confusing because it did not show the baselayer1 object being created:
https://github.com/publiclab/leaflet-environmental-layers#add-the-layers-browser-menu-from-the-demo-page
I feel like the baselayer should be in a different section, not under "Add the layers browser menu from the demo page", especially now that we have a hardcoded default base map.

The rest of it seems pretty good!

crisner · 2020-01-29T13:14:27Z

I feel like the baselayer should be in a different section, not under "Add the layers browser menu from the demo page", especially now that we have a hardcoded default base map.

Thanks for taking a look @nstjean! I've added the baselayer code instead. I have also attached a link to the section in Leaflet's docs where this is documented.

crisner · 2020-01-30T06:10:20Z

This is now ready for review and merge. Combining metadata into a single file will be continued in #371 and the layer names will be linked to the relevant sections once that's done. Thanks!

cesswairimu

This is great. Kindly resolve the conflict so that we can have this merged. Thanks

…splay option

crisner · 2020-02-18T06:21:24Z

@cesswairimu, resolved merge conflicts. This is now ready for a merge. Thanks!

cesswairimu · 2020-02-18T06:46:09Z

Great. Thanks

* Remove use of hardcoded extents for displaying layers (#332) * Fix embed code with duplicated text (#340) * Fix duplication of text in embed code * Update build file * Update README.md (#335) * Update README.md * Update README.md * Add check that layers group is not undefined when creating layers-sub-list (#339) Fixes #333 * Display new items mark in layers menu (#341) * Create function to check for available layers * Display badge to show new items * Save map instance in a variable * Update readme * Add contribute button to open infra map * Add media queries for size 235x300 (#346) * Add default basemap when undefined (#351) * Add default basemap when undefined * Update version number indicating bug-fix * [WIP] Add layers in include to map by default (#352) * Add unearthing layer to demo * Fix bug with removing points from the map on removeLayer * Add all layers in include param upon map initialization * bump to v2.1.9 * Implement new menu * Add new menu dependancies * Fix styles from overriding default leaflet classes * Refactor code * Fix styles for layer group name and layer description * Add option to disable layer visibility when param.include is true * Add option to use default layer control * Fix errors when trying to display layer when out of bounds * Add missing viewport meta tag * Move styles to LeafletEnvironmentalLayers.css * Update documentation * Add missing dependencies and update build * Fix error from unearthing layer on page reload * Set addLayersToMap options from param * Update documentation * Update AllLayers.js (#366) Fixed: Prevent use of the same default tile layer for multiple maps * Add PLpeopleLayer (#361) * add PLpeopleLayer to maps * fix function name to PLpeopleLayer * fix capital in function name * make naming consistent for both map examples * change layer name to PLpeople * version 2.2.0 and bump LBL to 1.7.0 (#368) * Feature/minimal mode (#356) * Create toggle mode control * Add marker for minimal mode * Change markers on mode change * Add condition and marker styles for eonet fires layer * Add minimal mode content to layers in layercode * Add minimal mode content to aqicn layer * Add minimal mode option * Refactor minimalMode control * Add mode control to one liner code * Add documentation to readme * Fix duplication of layers control, set simple layer control for demo * Add basic tests * Update build * 2.2.0 * Change button names and title * Update tests for mode control * Update build * Add demo with multiple maps in a single page * Add a check for jQuery and update build * Bug/fix missing layers in layer menu on refresh (#375) * Fix 'moveend' event check to affect only when removing layers from map * Add a check when adding minimal markers to confirm this._map exists * Update build * fix conflict * add parameter display to turn on layers * check if layer exists before turning it on * Remove conditions and code responsible for jquery duplication * Update link to jquery 3.3.1 and remove references to older versions * Move info.json outside iife and update build * Install cypress * published * Bug/fix layers not removed from map when hash false (#380) * Add error handling on removing unearthing from map * Remove redundant code * Comment out unused baselayer instantiation and update build * Uncomment baselayers * Reformat init defaults (#396) * rewrite init defaults * remove console.log * use L.Util.setOptions to set defaults * Add Cypress * Add tests to check leaflet left controls * Add tests for embed prompt and layers menu * Add child window to prevent iframe conflict on hash change * Add test to check hash update on map movement * Move hash test to a seperate file and increase delay * Set up http server for localhost * Ignore cypress screenshot and video folders * Set up cypress in travis * Oneliner/basic implementation tests (#397) * testing all the specs * using babel * add layer name id to broswer menu * leaflet not fully loading * recent tests * testing error in multiple maps * rewrite init defaults * basic one liner tests work * test shorter transpile files * emove jquery from gruntfile browserify dist * use L.Util.setOptions to set defaults * turn on basic tests again * disable babel-plugin-transform-object-rest-spread * clean up * rebase * add wisconsin layer back in and fix error * remove text-table files * add css file back in * fix merge errors * Edit and update documentation for more clarity (#367) * Add dependencies to documentation * Add updated documentation to readme * Add more information * Edit usage example for layer menu * Added links to more information * Update minimal mode documentation * Add files via upload * added a layerData folder containing the json file for sea level rise data Co-authored-by: Renisha Christie. A <29401459+crisner@users.noreply.github.com> Co-authored-by: Suyash Choudhary <57896905+sssash18@users.noreply.github.com> Co-authored-by: llabake <lemboyelabake@gmail.com> Co-authored-by: crisner <christie.reni@gmail.com> Co-authored-by: Sagarpreet Chadha <chadha.sagarpreet97@gmail.com> Co-authored-by: jywarren <jeff@unterbahn.com> Co-authored-by: z-arnott <50159450+z-arnott@users.noreply.github.com> Co-authored-by: Natalie St Jean <49460529+nstjean@users.noreply.github.com> Co-authored-by: Natalie <natalie.stjean@gmail.com> Co-authored-by: Cess <cessmbuguar@gmail.com>

crisner added 3 commits January 27, 2020 21:00

Add dependencies to documentation

536209d

Add updated documentation to readme

571d5d1

Add more information

10ca0b4

crisner requested a review from sagarpreet-chadha January 28, 2020 12:25

crisner commented Jan 28, 2020

View reviewed changes

crisner changed the title ~~Edit and update documentation for more clarity~~ [WIP] Edit and update documentation for more clarity Jan 28, 2020

crisner mentioned this pull request Jan 28, 2020

Outreachy project planning publiclab/plots2#6887

Closed

Edit usage example for layer menu

674bf4d

crisner added 3 commits January 30, 2020 11:09

Added links to more information

2c8290a

Merge branch 'master' into edit-documentation-for-more-clarity

1d41d3c

Update minimal mode documentation

33e17b8

crisner changed the title ~~[WIP] Edit and update documentation for more clarity~~ Edit and update documentation for more clarity Jan 30, 2020

crisner mentioned this pull request Jan 30, 2020

Combine layer metadata into a single file #371

Closed

crisner mentioned this pull request Feb 4, 2020

Outreachy Project Recap: summary, planning & discussion publiclab/plots2#7432

Closed

cesswairimu approved these changes Feb 17, 2020

View reviewed changes

Merge commits from master and update README with documentation for di…

94d3dec

…splay option

cesswairimu merged commit 9b463c2 into publiclab:master Feb 18, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Edit and update documentation for more clarity #367

Edit and update documentation for more clarity #367

crisner commented Jan 28, 2020 •

edited

Loading

crisner commented Jan 28, 2020

crisner commented Jan 28, 2020

crisner Jan 28, 2020

jywarren Jan 28, 2020

nstjean Jan 28, 2020

crisner Jan 28, 2020

crisner Jan 28, 2020

nstjean Jan 28, 2020

crisner Jan 29, 2020

jywarren Jan 29, 2020

crisner commented Jan 28, 2020

jywarren commented Jan 28, 2020

nstjean commented Jan 28, 2020

crisner commented Jan 29, 2020

crisner commented Jan 30, 2020

cesswairimu left a comment

crisner commented Feb 18, 2020

cesswairimu commented Feb 18, 2020

Edit and update documentation for more clarity #367

Edit and update documentation for more clarity #367

Conversation

crisner commented Jan 28, 2020 • edited Loading

crisner commented Jan 28, 2020

crisner commented Jan 28, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crisner commented Jan 28, 2020

jywarren commented Jan 28, 2020

nstjean commented Jan 28, 2020

crisner commented Jan 29, 2020

crisner commented Jan 30, 2020

cesswairimu left a comment

Choose a reason for hiding this comment

crisner commented Feb 18, 2020

cesswairimu commented Feb 18, 2020

crisner commented Jan 28, 2020 •

edited

Loading