Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add section on completeness/status to README #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,24 @@ The version of the open content data that Chorus provides has the following chan
* Data converted to JSON format.
* Products that don't have a 500x500 pixel image listed are removed.
* Prices extracted for ~19,000 products from the https://www.upcitemdb.com/ service using EAN codes to match.

# Production readiness / status

* "Chorus Electronics" store:
* Demo, you'll build your own
* Solr (with Querqy integration:
* solrconfig / Query setup: complete / production ready
* solrconfig / autosuggest: incomplete, demo
* schema / data model: demo - misses e.g. inventory, does not cover "variants", i18n / multi-language search; could be a good starting point
* SMUI:
* Complete setup, production ready
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was a rough guess, is that correct?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think so!

* Quepid:
* Complete setup, production ready
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was a rough guess, is that correct?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and yes, I agree...

* RRE:
* Complete setup, production ready
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was a rough guess, is that correct?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep. and I'll be doing some Katas specific to each of those tools as well to provide more support to users.

* Runtime / deployment:
* Demo (docker-compose) - it's up to you how to deploy/manage the components

## Typical building blocks not covered:
* Online analytics and extraction of search relevance information from the data
* Indexing / data preparation