The Wayback Machine - https://web.archive.org/web/20201205075928/https://github.com/EventStore/documentation/issues/166
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide documentation and code samples for more advanced scenarios #166

Open
oskardudycz opened this issue Dec 4, 2020 · 3 comments
Open

Provide documentation and code samples for more advanced scenarios #166

oskardudycz opened this issue Dec 4, 2020 · 3 comments

Comments

@oskardudycz
Copy link
Contributor

@oskardudycz oskardudycz commented Dec 4, 2020

Based on @rmaziarka feedback - it would be good to add samples and how-to around:

  • optimistic/pessimistic locking,
  • idempotent consumer,
  • cross-stream operations.

@rmaziarka feel free to put more thoughts or suggestions 馃憤

@oskardudycz oskardudycz changed the title Provide more advanced code samples of more advanced scenarios Provide documentation and code samples for more advanced scenarios Dec 4, 2020
@alexeyzimarev
Copy link
Member

@alexeyzimarev alexeyzimarev commented Dec 4, 2020

We discussed it before. However, we aren't sure where it belongs. Remember that this is documentation about our product. It's not an Event Sourcing guide or tutorial. It doesn't mean we don't want to create something like that, the question is if it belongs to the docs.

@oskardudycz
Copy link
Contributor Author

@oskardudycz oskardudycz commented Dec 4, 2020

From my perspective, people thinking about using the event store solution usually don't have good knowledge around Event Sourcing. From my experience, they're learning both the tool and the pattern at the same time. Plus people before choosing a solution are looking for an answer if and how it supports such concepts. I think that we should provide guidance around that and step by step introduce those concepts together with teaching the product.

In Marten, we have a concept of "scenarios" (https://martendb.io/documentation/scenarios/) - they have a separate section. However, I have mixed feeling about that, as this section is not easily discoverable.

I think that we should have it somewhere in the documentation (we can discuss the exact place), as if we move it to blog posts then it would be harder to find and people will need to jump between one place and another.

@alexeyzimarev
Copy link
Member

@alexeyzimarev alexeyzimarev commented Dec 5, 2020

I totally get it and we know that the issue exists and we want to address it. But it is not a documentation. We have to elaborate more on the educational direction, make some decisions and do it after the documentation is in a decent shape for 20.6.1 (with clients).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
You can鈥檛 perform that action at this time.