Showcase Public Lab projects dependencies among themselves

[grvsachdeva]

@jywarren I think there should be a dedicated documentation page for Public Lab projects too which can contain the flowcharts showing which PL libraries are utilised at which project like Leaflet, Editor, etc used at plots2 and so on. This will give the clarity to new-comers and they may be interested in contributing/improving the library too. What do you think?
Thanks!

@jywarren: Ah that's a great idea @gauravano! We have some diagramming issues and a Google presentation we could build off of!

Let's discuss here about how to achieve this goal. Also, @jywarren please drop/tag diagramming issues or PPTs here.

Should we make a page a HTML page at community-toolbox regarding this or a Readme?

[grvsachdeva]

@publiclab/community-reps @publiclab/is-reviewers @publiclab/plots2-reviewers @publiclab/connectors @publiclab/guides @publiclab/leaflet-environmental-layers-guides

[harshkhandeparkar]

How about a README since it will be available in github itself. We can maybe link to the README or somehow display it in the community toolbox.

[Yugandhartripathi]

I think a HTML page at community-toolbox would be better that way newcomers can get a basic understanding of where and how different projects are used before taking the deep dive.
Regarding the idea of placing it in the Readme, just to be clear we are talking about a central Readme in a particular repo covering all projects or a section for the proposed flowcharts etc in every project's readme?

[harshkhandeparkar]

How about (this is a bit complex) getting a picture through a GET request from community toolbox? The same picture can be requested by all README files and also by the toolbox website. The picture can be updated and the concerned README and HTML page will automatically change. How does this sound??

[Yugandhartripathi]

@harshkhandeparkar I don't think a single image can explain relationship for all the projects, we would need more or less a separate image(if we are going the image way) for every project and then to display all those on community toolbox page is more like going with the HTML page approach.

[harshithpabbati]

My Opinion : It's best to have a html page so that we can display much about it and we can style it as we like.

[harshkhandeparkar]

@Yugandhartripathi we can create separate images for all repos and request them since we are using GET requests

[grvsachdeva]

This dependency chart will show the dependency of PL repo's on one-another so there would be a single page sufficient for showing this. I think an HTML page at community-toolbox will be good as we point new-contributors there only.

[harshkhandeparkar]

@gauravano do you think this dependency chart can be made using an image? If yes then we can store the image on the toolbox website and display it on README files in each repo as well(as well as show on the website). What do you think?

[jywarren]

Yes, i think it could be an image!

…

On Tue, Feb 26, 2019 at 11:37 PM Harsh Khandeparkar < ***@***.***> wrote: @gauravano <https://github.com/gauravano> do you think this dependency chart can be made using an image? If yes then we can store the image on the toolbox website and display it on README files in each repo as well(as well as show on the website). What do you think? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#4880 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABfJy0NoY3ysUCjlu0XKcOjc51QLZh3ks5vRgtwgaJpZM4bP4MU> .

[jywarren]

I guess we could put it in a number of places, but let's start compiling it roughly:

• plots2
  • PublicLab.Editor
  • inline-markdown-editor
    • PublicLab.Editor
  • Leaflet.BlurredLocation
    • blurred-location
  • leaflet-blurred-location-display
    • blurred-location
  • leaflet-environmental-layers
• image-sequencer
• mapknitter
  • leaflet-environmental-layers
  • image-sequencer
• spectral-workbench
  • spectral-workbench.js
• leaflet-tile-filter
  • image-sequencer
• leaflet-multispectral
  • image-sequencer
• infragram
• pi-builder
• webjack

And more... here: https://github.com/publiclab/

But that's already a lot!

[jywarren]

Circling back here after I gave a diagram a try!

https://publiclab.org/notes/warren/05-22-2019/draft-of-a-public-lab-software-roadmap-comments-welcome

It's not comprehensive. But it's designed to help people get an "at a glance" view of the majority of our active projects. I left out some that are more like utilities, demos, or things that don't require active maintenance as much. And it's still super complex!

[namangupta01]

Yayy! simple data grapher is on the way! @jywarren @IshaGupta18 🎉

[stale]

Hi 😄, this issue has been automatically marked as stale because it has not had recent activity. Don't worry you can continue to work on this and ask @publiclab/reviewers to add "work in progress" label 🎉 . Otherwise, it will be closed if no further activity occurs in 5 days -- but you can always re-open it if you like! 💯 Thank you for your contributions 🙌 🎈.

[ebarry]

Hi all, this has been marked as 'stale', but perhaps with this diagram we can consider this 'solved' and worthy of closing on that account? @gauravano what do you think?

[grvsachdeva]

Hi @ebarry, just saw the awesome diagram. I think that serves the purpose so opened a follow-up issue at publiclab/community-toolbox#395.

Thanks for highlighting this issue :)

Also, please chip-in at publiclab/community-toolbox#395

[ebarry]

Great, thanks @gauravano ! It's so great to hear from you. I commented over there as well.

[grvsachdeva]

Same here Liz. Feeling good to be able to spend time here.