Lack of documentation, tutorials, videos or books - barrier to EventStore success?

To be clear there are multiple levels of settings here per process and per node are the two most important. Either is configurable.

On a side note if we did try to handle this automatically it would likely be viewed as a vulnerability by the security community as it could open possible attack vectors.

Because some of us donā€™t use .NET?
I appreciate HTTP examples.

There are http examples. Check out here every operation discussed includes a curl command to replicate it.

https://eventstore.org/docs/http-api/writing-to-a-stream/ as example

https://eventstore.org/docs/http-api/competing-consumers/ further.

To be fair Greg (siding with the people who complain), the old docs were better. In particular, this projection reference is amazing (I wish all docs were like this):
https://github.com/EventStore/EventStore/wiki/Projections
https://github.com/EventStore/EventStore/wiki/Projections-fromAll

https://github.com/EventStore/EventStore/wiki/Projections-fromStream

https://github.com/EventStore/EventStore/wiki/Projections-fromStreams

https://github.com/EventStore/EventStore/wiki/Projections-when

https://github.com/EventStore/EventStore/wiki/projections-highlevel

https://github.com/EventStore/EventStore/wiki/Projections-Theory

On the official site, there is ā€œprojectionā€ seriesā€¦ which has a lot of ā€œwordsā€ an very few examples, and it is also outdated:

https://eventstore.org/blog/20130212/projections-1-theory/

etcā€¦

In effect, the docs are in 3 different places now: the old wiki, the official docs, random series of blog-articles. I ordered them in order of best-to-worst.

I complain about many of the docs, there is an active effort improving them. The http ones though I find to be amongst the better of them.

Hello everyone!

I am the new(ish) docs person, after doing a platform overhaul, a sweep for some basic grammar, spelling etc and just ā€˜getting my head round thingsā€™, I am now embarking on a big update to the actual content.

This will be gradual, piece by piece and take some time (good docs take as long as good code, and are also ongoing), but Iā€™m starting with ā€˜getting startedā€™.

Iā€™ve read through all your inout and ideas and am forming some content ideas and mapping around them. Watch this space, or rather this space -> http://eventstore.org/docs/

Chris

Chris, I have a suggestion, although some people say that this is completely unnecessary and impossible to solve, to put some recommendations on how to configure Linux boxes in order to run EventStore production grade.

This is how RavenDb has done it, I think the first advise is directly applicable to EventStore: https://ravendb.net/docs/article-page/4.0/csharp/start/installation/system-configuration-recommendations

Can someone kill the ligatures setting on the font.

Capture.PNG

Capture2.PNG

Sounds great, since it is definitely needed.

If you want feedback / input, please say so - I donā€™t want to spend a lot of time on feedback if it is not used. Seems like the Documentation landing page just changed today? It is better, although strange, that the pages (first:Step 1 - Install, run, and write your first event) appearing when you click the Introduction is no way related to the pages under Introduction in the left column menu which is still quite confusing - all documents should be reachable from the left menu and the there should be a natural progression and the first document should not be about specific ā€œnon-introductoryā€ topic.

kr

Hoegge

Hey Hoegge,

So the new guide did go live today, but we hadnā€™t cleared CDN caches until after you sent this message, so I think you still saw the old one.

But now you should see a new guide at: http://eventstore.org/docs/

And I know of several issues and improvements that will be added soon, but would still love feedback, you can add them here, to GitHub, or just email me directly.

Chris

Hi

Sounds good. At my end the Introduction contents (menu on left) and the link do still not match:

image001.jpg

Med venlig hilsen

Morten HĆøgholm Pedersen

Mobile: +45 3054 5892
Email: [email protected]

LinkedIn: mhpedersen

Skype: m.h.pedersen

This is still the old docs, maybe you need to do a hard refresh, or just wait. When you see ā€˜Getting Startedā€™ instead of ā€˜Introductionā€™ you know you have the new docs :slight_smile:

Chris

Hi Chris W,

Just wondering if the overhaul of the docs is still ongoing?

If we find flaws then who should we report them to?

And can we trust that the docs will continue to get attention and not go stale?

Thanks,

Raith

They are being actively worked on.

In terms of going stale it should not happen often. We are very conscientious about breaking changes overall. We have had very few breaking changes in the history of eventstore. You can in fact on the latest version load up a 1.0 database :open_mouth:

Hey all.

Yes, they are still ongoing, but I am only part time, and was just on holiday. The Getting started guide took some time, and Iā€™ve been working on rewriting the HTTP API docs, and new docs for some commercial tools weā€™re about to release. They should both go live soon. Then after that Iā€™ll continue doing the same to other sections.

And please, do report issues if you find them, or submit a PR here - https://github.com/EventStore/docs.geteventstore.com

This will also help me decide which sections to work on next.

Thanks, Chris

Thanks both,

I wasnā€™t aware of the docs repo else Iā€™d have known you were still on the case from the commit log and issue tracker.

Thatā€™s great to know, and Iā€™ll contribute issues/PRs wherever I can help.

Thanks,

Raith

Ahhh, no worries, well glad to be of help :slight_smile:

And I tend to work in branches, so also look in there. PS, you can even create issues and PRs straight from the live docs, so easy to report if you find an issue :slight_smile:

Chris

If you mean the ā€œImprove this Docā€ links then I havenā€™t found one that works. They all seem to refer to the ā€œgetting-started-reworkā€ branch, which no longer exists.

It all makes sense to me now that I know the repo is alive and kicking. But as a frustrated newcomer to EventStore I had previously written those links off as another dead end!

Iā€™m sure you guys arenā€™t intentionally elitist, but there seems to be a form of (un)natural selection at work here - becoming an ES aficionado is a case of ā€œsurvival of the fittestā€. For those that fall, thereā€™s Kafkaā€¦