Skip to content
Event Store documentation
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates Sep 14, 2018
assets Add query tab details (#311) Jan 8, 2019
code-examples Fix pinned strategy formatting and miss-leading stream metadata docs (#… Jun 19, 2019
dotnet-api Fix pinned strategy formatting and miss-leading stream metadata docs (#… Jun 19, 2019
event-sourcing-basics Fix typo (#348) Jun 15, 2019
getting-started Updated Step count (#350) Jun 18, 2019
http-api Fix pinned strategy formatting and miss-leading stream metadata docs (#… Jun 19, 2019
images Add new scavenge features (#276) Dec 11, 2018
partials Add K8 GKE instructions (#344) May 31, 2019
projections Add Write amplification warning (#343) May 30, 2019
reference Fixing typo (#323) Feb 5, 2019
server docs: correct TruncateBefore example (#345) Jun 5, 2019
.gitignore Switch to swagger json Dec 20, 2018
404.html Revert "Temporary docs preview" Apr 10, 2018
CNAME Revert "Temporary docs preview" Apr 10, 2018
LICENSE Create LICENSE Sep 14, 2018
README.md Update read me Apr 18, 2018
docfx.json Add K8 GKE instructions (#344) May 31, 2019
filterConfig.yml
index.md Adding new getting started guide Jul 20, 2018
prepend.sh Switch to DocFX (squashed) Apr 10, 2018
rename.sh
toc.yml Add K8 GKE instructions (#344) May 31, 2019

README.md

Event Store Documentation

This documentation is available at https://eventstore.org/docs. Pages are built with DocFX.

What follows is documentation for how to use and contribute to the Event Store documentation. If you’re planning to make updates or contributions then read on. Otherwise, head on over to the website.

Contributing to Event Store Documentation

The Event Store documentation consists of different components, and the documentation reflects this. Depending on what you want to contribute to, the process is different.

Conceptual Documentation

This is the bulk of documentation, and where you mostly likely want to contribute. It uses 'DocFX flavored Markdown'. It is similar to standard or GitHub Flavored Markdown, but adds features useful for documentation you can find details of here.

HTTP API Spec

In additions to conceptual docs on the HTTP API, the documentation includes an OpenAPI spec file that DocFX renders to HTML when building the site. Any contributions to that file are welcome, read the OpenAPI spec for more details on the format of that file.

Code Documentation

When DocFX builds the documentation it parses XML code comments and renders them as HTML. If you want to contribute to that documentation, then find instructions in the code base repository.

Documentation Theme

Finally, if you would like to improve the theme for the documentation site, then you can find its repository here.

Running DocFX Locally

You can generate the site locally and test your changes. Follow the instructions here to install DocFX and dependencies, then run:

docfx build docfx.json --serve

This builds the site to the /_site folder and serves it at http://localhost:8080.

Small Edits

  1. Make changes (fix typos or grammar, improve wording etc).
  2. Send a pull request!

New Pages and Sections

  1. Create new pages and/or sections. Follow the Conventions below.
  2. If you create a new section add an entry for it to the toc.md file. This file determines the order of sections in the navigation sidebar and helps DocFX build internal navigation.
  3. Send a pull request!

Conventions

File Names

  • File and directory names are all lowercase.
  • Replace spaces with dashes.
  • Markdown files take the .md extension.

Formatting and Typesetting

The content of our documentation has multiple authors. Formatting and style guidelines help maintain a consistent use of language throughout the docs.

  • Acronyms and abbreviations: Use uppercase (e.g. API, HTTP, JVM)
  • Brand names: Use correct typesetting (e.g. cURL, Event Store, JavaScript, .NET)
  • Example code should not have a line length of more than 80 characters
You can’t perform that action at this time.