Netlify-cms: Add community widgets section to docs

[erquhart]

In the long term we'll likely put a lot of work into creating a place for discovering community extensions. This is not that.

This ticket covers the immediate need to surface community contributed widgets for maximum visibility and with minimal effort.

I propose we add a "Community Widgets" section to the Widgets page in the docs. It would be identical to the "Widgets" section, with a cloud of widget names and individual markdown files for each widget. We'd generally expect widget authors to submit a PR with documentation for their widget.

Thoughts?

[tech4him1]

(Our long-term issue is at https://github.com/netlify/netlify-cms/issues/919.)

I think that's reasonable for now, as long as it is clear that we do not maintain them directly.

Also, what should a review for a widget addition cover? Does the PR reviewer need to run the widget or just check the documentation (maybe I'm just trying to get out of extra work here 😛)?

[erquhart]

Hahaha yeah agreed, we should probably check to ensure the widget is working and has a generally acceptable UI, plus documentation and naming conformity. Shouldn't take way too much effort in most cases.

[tech4him1]

It might be worth writing up some sort of basic standard for widget authors to be approved.

[erquhart]

Agreed, it should be documented.

_{Sent with GitHawk}

[erquhart]

If anyone wants to help move this forward, next step is design.

@zebapy I know we still need to get your Gatsby PR merged, but any chance you're interested in putting something together for this (on top of your Gatsby work but separate PR)?

[zebapy]

@erquhart I could give it a shot after the gatsby merge. I'll be trying to get the blog back into the main gatsby PR this week.

[erquhart]

Awesome! Definitely reach out in Gitter if you need a hand with the Git stuff on your current PR.

[erquhart]

Starting to think we should have a general community extensions page similar to what Gatsby has (we can also borrow from their approach since we're moving to Gatsby). So instead of widgets specifically, we could have a single page using the gatsby npm source plugin to display the readme for any package that matches a list of prefixes, e.g. netlify-cms-widget, netlify-cms-backend, etc.

[zebapy]

@erquhart do you want some more formal planning or I could take a stab at creating what you stated/based on gatsby's plugins page

[gil--]

https://curated.vuejs.org/ is another nice reference site. Similar to gatsby with category filter if you wanted to combine everything but still allow sorting between widgets, etc.

[erquhart]

@zebapy that'd be awesome - considering our timeline, I'm cool with you going for it.

@gil-- hadn't seen the Vue curation page, thanks for linking it! For right now, I'd still say Gatsby is closer - super clean and straightforward, and just showing readmes (so probably faster to develop).

[zebapy]

FYI I've started work on this and borrowing heavily from Gatsby's plugins section (using gatsby-source-npm-package-search) as mentioned in https://github.com/netlify/netlify-cms/issues/1286#issuecomment-397080570

[mittalyashu]

@erquhart I have few design idea regarding the community widget. What we can do is create a separate widget search page _(not sure how many total widget are yet)_.

Like this:

[zebapy]

I believe that is already the goal unless there are other specifics you had in mind for this design. I will rough it out for review in a PR and we can go from there. Before I'm doing this, I'm trying to clean up css a bit so it's saner to work with and make this addition (also fix some mobile issues).

[mittalyashu]

I will rough it out for review in a PR and we can go from there. Before I'm doing this, I'm trying to clean up css a bit so it's saner to work with and make this addition (also fix some mobile issues).

Can you share the link of your repo where you are working?

[erquhart]

@zebapy awesome 👍🏼👍🏼

@mittalyashu this is already claimed, but feel free to comment here with any specific thoughts. The Gatsby plugin page you referenced is already being consulted for design inspiration per Zeb's comment above.

_{Sent with GitHawk}

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.