Skip to content
This repository was archived by the owner on Jul 11, 2023. It is now read-only.

Conversation

@ihadeed
Copy link

@ihadeed ihadeed commented Nov 16, 2020

This is more of a proposal than a PR that's ready for merge

I copied some of the functionality used to render docs to create a dedicated community plugins registry.

The other piece of the puzzle here would be a CI/CD pipeline to collect metadata from each plugin's package.json (or custom json) and generate a list of PluginInfo objects.

  1. query capacitor-community org via Github API
  2. download package.json file from the repo (using the raw file URL)
  3. parse json and extract/compute the info above
  4. send that info to prismic, or save it as a static .json file in this repo
  5. generate markdown docs using capacitor-docgen and add it to pages/community/<plugin slug>.md in this repo

Change summary

  • community-component component renders the docs (diff)
  • community-menu displays a different logo, filtering options in sidebar, displays plugins based on their category, and indexes them by tags for search (diff)
  • added a temporary card in the current community page as a way to navigate to the registry (diff)

Screenshots

Community plugins group replaces "Community plugins" under "Getting started" and introduces a registry link

Added this while testing a few things initially and I left it there. It's not a major part of this proposal.

image


Main registry page to view plugins organized as cards with ability to search/filter. Thought this might look/function like Terraform Registry or Drone Plugin Registry.

image


Example of what a plugin docs page looks like

image

@vercel
Copy link

vercel bot commented Nov 16, 2020

@ihadeed is attempting to deploy a commit to the Ionic Team on Vercel.

A member of the Team first needs to authorize it.

@perrygovier
Copy link
Contributor

Thank you!!!
@bensperry has some UI updates he wants me to make. I should be able to get those in and this merged in the first week of December.

@perrygovier perrygovier self-assigned this Nov 16, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants