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

Sample App: Online Bookstore #5880

Closed
Leo6Leo opened this issue Feb 26, 2024 · 1 comment · Fixed by #5948
Closed

Sample App: Online Bookstore #5880

Leo6Leo opened this issue Feb 26, 2024 · 1 comment · Fixed by #5948
Assignees
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.

Comments

@Leo6Leo
Copy link
Member

Leo6Leo commented Feb 26, 2024

Problem

On the Knative website, we offer a variety of code snippets and examples designed to showcase the interactions between different Knative components.

However, there's a noticeable gap in our documentation: a comprehensive end-to-end (E2E) sample that illustrates how these components integrate in a real-world scenario.

This gap was highlighted in a GitHub issue by @omerbensaadon on knative/ux#33, emphasizing the need for a detailed E2E Getting Started guide for Eventing, covering sources, sinks, channels, brokers, triggers, and more.

Istio has this nice sample app that demonstrates how to use it.
It would be nice to have a non-trivial example to demonstrate similar concepts in Knative. Not sure if there is any but for example for Eventing I didn't find anything beyond hello-wrold like samples..
I would suggest an app that is aligned with common Knative use cases eg. an IoT app that processes sensor readings using a microservices based approach. It could use a different language per microservice.

To address this, we're launching the Knative Online Bookstore Sample App project, aiming to provide a clear, complete example of Knative's capabilities.

Image

Persona:

Which persona is this feature for?
Administrators and developers

Exit Criteria

  • Code Repository: The bookstore's complete, functional, and well-organized code will be hosted in the Knative documentation repository, specifically within the code-samples directory.
  • Documentation: Comprehensive and user-friendly documentation will be provided, detailing step-by-step instructions on how to deploy and use the sample app, including explanations of each component's role and how they interact within the Knative ecosystem.
  • Testing Guidelines: Include instructions for testing the application to ensure users can verify its functionality in their environment.
  • Troubleshooting Guide: A section dedicated to common issues and their resolutions to aid users in solving potential problems.
  • Feedback Mechanism: Encourage users to provide feedback or contribute improvements to both the sample app and the documentation.
  • Version Compatibility: Clearly specify which versions of Knative (and any other dependencies) the sample app is compatible with, ensuring users can successfully deploy it.

Time Estimate (optional):
How many developer-days do you think this may take to resolve? 20+

Additional context (optional)

  • The design doc can be found here
@Leo6Leo Leo6Leo self-assigned this Feb 27, 2024
Copy link

This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

1 participant