High-level technical documentation on napari hub features

[richaagarwal]

Currently, we don't have much documentation summarizing how or features/products work from a technical perspective. Adding documentation on this can help validate that we all have the same understanding of how features work, make it easier to suggest changes in the future, and make it easier for new engineers to onboard. Let's start by adding a high-level summary for each of the below areas.

Topics to cover

• Search (incl. filters / sort / relevance)
• CDN / CloudFront caching (if any)
• Preview page
• Plugin metadata
  • PyPI metadata
  • npe2-enabled metadata & Manifest files
  • Fetching new plugin data (cron job)
  • S3 data storage
• Frontend state management
• Internationlization (i18n)
• Server side rendering
• Search Engine Optimization (SEO)

Additional notes

• Let's add a wiki article for each of these topics
• In documenting this, please reach out to colleagues to gain an understanding of this if not already known. Useful information may also live in past tech specs, so reading through those might be a helpful resource.

[codemonkey800]

draft for search doc: https://czi.quip.com/y6E5AQyqIgYg/High-level-tech-documentation-Search

[codemonkey800]

draft doc for CDN: https://czi.quip.com/JwTbAaza07bx/High-level-tech-documentation-CDN

[codemonkey800]

draft doc for preview page: https://czi.quip.com/dd5jAS3Jy6q9/High-level-tech-documentation-Preview-Page

[klai95]

draft doc for plugin metadata: https://czi.quip.com/AZNzAZGxfLcP/High-level-tech-documentation-Plugin-Metadata

[klai95]

@DragaDoncila will review https://czi.quip.com/AZNzAZGxfLcP/High-level-tech-documentation-Plugin-Metadata and the backend portion of https://czi.quip.com/dd5jAS3Jy6q9/High-level-tech-documentation-Preview-Page to provide feedback and/or fill in gaps where they make sense.

[codemonkey800]

draft doc for state management:
https://czi.quip.com/gWOnAToYBrYP/High-level-tech-documentation-State-Management

[richaagarwal]

@klai95 @codemonkey800 I've reviewed all quip articles linked to from this ticket, and things look great! I left a few comments - after those are addressed, let's start moving these into the GitHub wiki.

@codemonkey800 For the remaining topics (i8n, SSR, SEO) - do you think we should open up follow-up tickets for them for the future? Or did it not make sense to cover them?

[klai95]

@richaagarwal I have reflected the change and updated https://czi.quip.com/AZNzAZGxfLcP/High-level-tech-documentation-Plugin-Metadata. This doc should be good to go! What do you have in mind for the structure of the wiki so I know where to place it? I can also add https://czi.quip.com/dd5jAS3Jy6q9/High-level-tech-documentation-Preview-Page to the GitHub wiki once the frontend changes are updated!

[richaagarwal]

@klai95 Sounds good! I would work with @codemonkey800 to figure out a wiki structure that makes sense - I think he might have some ideas since he's got other documentation already there.

[codemonkey800]

Created the following wiki pages for frontend tech documentation. I think we can organize things by prefixing it with Tech:, but open to a different naming format

• Tech: CDN
• Tech: Frontend State Management
• Tech: Preview Page
• Tech: Search

[codemonkey800]

For the remaining topics (i8n, SSR, SEO) - do you think we should open up follow-up tickets for them for the future? Or did it not make sense to cover them?

yeah that makes sense, I can open up separate follow up tickets for these

[codemonkey800]

Created the following issues:

• High-level technical documentation: Internationalization (i18n) #676
• High-level technical documentation: Server Side Rendering (SSR) #677
• SEO documentation #678

[klai95]

Created the wiki page for Tech: Plugin Metadata. @richaagarwal @codemonkey800