Skip to content
This repository has been archived by the owner on Sep 7, 2023. It is now read-only.

Updates to improve discoverability of examples #12

Open
leggetter opened this issue May 13, 2023 · 0 comments
Open

Updates to improve discoverability of examples #12

leggetter opened this issue May 13, 2023 · 0 comments
Labels
enhancement New feature or request question Further information is requested

Comments

@leggetter
Copy link
Contributor

This repo is mainly used by create-tigris-app, which is fine. However, it does have a bit more potential than that. In this issue, I'd like to propose some changes that:

  1. Make the repo more useful standalone
  2. Can facilitate improvements in:
    i. create-tigris-app
    ii. the Web Console

General idea (suggestion)

  1. Update each example to be an example that doesn't specifically stand out as having to be used with create-tigris-app e.g. rename README-template.md to README.md so the contents is automatically shown when you're in the directory in github.com. And standardize the READMEs a bit more.
  2. Utilize package.json to provide more details that can then be used later e.g. description, keywords, human-readable name. We may want to add a new section to allow us to provide more metadata for facet search e.g. Tigris product, framework, use case the example demonstrates, priority (if we feel more are important than others e.g. key frameworks)
  3. Upon merging into main, we can have a GitHub action that looks through all the examples and updates a Tigris Search index with all the examples.
  4. create-tigris-app and the web console can be updated to query the search index (potentially via a very simple API).

With this approach, we can roll out new examples without the need to update any applications.

@leggetter leggetter added enhancement New feature or request question Further information is requested labels May 13, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant