forked from johnsimons/docs.geteventstore.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Event Store documentation
brentjanderson/docs.geteventstore.com
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<link rel="dns-prefetch" href="//geteventstore.com">
<link rel="dns-prefetch" href="//fonts.googleapis.com">
<link rel="dns-prefetch" href="//code.jquery.com">
<link rel="dns-prefetch" href="//www.google-analytics.com">
<title>Event Store Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Event Store Documentation ">
<meta name="generator" content="docfx 2.32.2.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link rel="stylesheet" href="../styles/main12.css">
<link rel="stylesheet" href="../styles/print.css" media="print">
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=Roboto:400,400italic,500,500italic,700,700italic|Source+Code+Pro:400,700">
<style media="print">
pre {
white-space: pre-wrap;
}
.site-navigation-toggle, .docs-toc-toggle, .footer__menu {
display: none;
}
p, ul, ol {
max-width: 100% !important;
}
.version-dropdown__selected {
}
.version-dropdown__options {
}
</style>
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix">
<div id="wrapper">
<header class="site-banner">
<nav id="autocollapse" class="navbar navbar-green ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a> </div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
<!-- TODO: There must be a way to get this to work properly. -->
<ul class="nav level1 navbar-nav">
<li class="site-navigation__item"><a href="https://geteventstore.com/community">Community</a></li>
<li class="site-navigation__item"><a href="https://geteventstore.com/support">Commercial Support</a></li>
<li class="site-navigation__item"><a href="https://geteventstore.com/blog">Blog</a></li>
<li class="site-navigation__item"><a href="http://docs.geteventstore.com">Documentation</a></li>
<li class="site-navigation__item"><a href="https://geteventstore.com/downloads">Downloads</a></li>
</ul>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="">
<h1 id="event-store-documentation">Event Store Documentation</h1>
<p><strong>This documentation is available at <a href="http://docs.geteventstore.com">http://docs.geteventstore.com</a>.</strong> The website is hosted using <a href="https://pages.github.com">GitHub Pages</a> from the <code>gh-pages</code> branch of this repository. Pages are built with <a href="http://jekyllrb.com">Jekyll</a> using the <a href="https://github.com/vmg/redcarpet">Redcarpet</a> complier.</p>
<p>What follows is documentation for how to use the Event Store documentation. If you’re planning to make updates or contributions then read on. Otherwise, head on over to the <a href="http://docs.geteventstore.com">website</a>.</p>
<h2 id="versioning">Versioning</h2>
<p>The Event Store documentation is available for many versions of Event Store and its APIs. By default the website shows documentation for the latest stable release of each component. Current sections and versions are:</p>
<table>
<thead>
<tr>
<th style="text-align:left">Section</th>
<th style="text-align:left">Versions</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">Introduction</td>
<td style="text-align:left">Always shows latest</td>
</tr>
<tr>
<td style="text-align:left">Server</td>
<td style="text-align:left">4.0.0 (latest), 3.3.0, 3.2.0, 3.1.0, 3.0.5, 3.0.3, 3.0.2, 3.0.1, 3.0.0</td>
</tr>
<tr>
<td style="text-align:left">.NET API</td>
<td style="text-align:left">4.0.0 (latest), 3.2.0, 3.1.0, 3.0.2, 3.0.1, 3.0.0</td>
</tr>
<tr>
<td style="text-align:left">HTTP API</td>
<td style="text-align:left">4.0.0 (latest), 3.2.0, 3.1.0, 3.0.3, 3.0.2, 3.0.1, 3.0.0</td>
</tr>
<tr>
<td style="text-align:left">Projections</td>
<td style="text-align:left">4.0.0 (latest)</td>
</tr>
</tbody>
</table>
<p>The Event Store server uses <a href="http://semver.org">semantic versioning</a>. API versions are based on the major server version they support.</p>
<h2 id="how-to-contribute">How to Contribute</h2>
<h3 id="running-jekyll-locally">Running Jekyll Locally</h3>
<p>GitHub Pages renders this documentation using Jekyll. You can generate the site locally and test your changes. Follow the instructions <a href="https://help.github.com/articles/using-jekyll-with-pages/#installing-jekyll">here</a> to get Ruby and Bundler installed.</p>
<p>Once installed, navigate to the root of the repository and run</p>
<p><code>bundle install</code>
followed by
<code>bundle exec jekyll serve</code></p>
<p>The compiled site builds into <code>/_site</code> and is hosted at <code>http://localhost:4000</code>.</p>
<h3 id="small-edits">Small Edits</h3>
<ol>
<li>Make changes (fix typos or grammar, improve wording etc).</li>
<li>Check to see if older versions need updating too.</li>
<li>Send a pull request!</li>
</ol>
<h3 id="new-pages-and-sections">New Pages and Sections</h3>
<ol>
<li>Create new pages and/or sections. Follow the <a href="#conventions">Conventions</a> below.</li>
<li>If you create a new section add an entry for it to the <code>top_level_sections</code> list in <code>_config.yml</code>. This list determines the order of sections in the navigation sidebar.</li>
<li>Add any new sections to the table at the top of this README.</li>
<li>Send a pull request!</li>
</ol>
<h3 id="creating-a-new-version">Creating a New Version</h3>
<ol>
<li><p>Duplicate the section’s latest version directory and rename it. For example, copy <code>/server/3.0.0/</code> to <code>/server/3.0.1/</code>.</p>
<blockquote><p>Pre-release documentation should have <code>-pre</code> after the version number, e.g. <code>/server/3.0.1-pre/</code>. Pre-release documentation will show up on the website but won’t be the default version. In pages’ front matter use <code>version: "3.0.1 (pre-release)"</code>.</p>
</blockquote>
</li>
<li>Update front matter in all <code>.md</code> files in the new directory to use the new version number.</li>
<li>Make edits to files in the new version as appropriate. You may create or delete pages as necessary.</li>
<li>Update the version table at the top of this README.</li>
<li>Send a pull request!</li>
</ol>
<h2 id="conventions">Conventions</h2>
<h3 id="file-names">File Names</h3>
<ul>
<li>File and directory names are all lowercase.</li>
<li>Replace spaces with dashes.</li>
<li>Markdown files take the <code>.md</code> extension.</li>
</ul>
<p>For example:</p>
<pre><code>/dotnet-api/3.0.0/writing-to-a-stream.md
</code></pre><p>For example:</p>
<pre><code>http://docs.geteventstore.com/dotnet-api/3.0.0/writing-to-a-stream/index.html
</code></pre><h3 id="front-matter">Front Matter</h3>
<p>Every page written for Jekyll in markdown has front matter. This is metadata for the page. We specify a title for the page, the section it belongs to, and the version for that section. Title and section should be <a href="http://en.wiktionary.org/wiki/title_case">title case</a>. The version number should be in the format <code>X.X.X</code>.</p>
<p>For example:</p>
<pre><code class="lang-markdown">---
title: "Writing to a Stream"
section: ".NET API"
version: "3.0.0"
---
Lorem ipsum dolor sit amet…
</code></pre><p>For <code>index.md</code> pages you should also include <code>pinned: true</code>.</p>
<h3 id="formatting-and-typesetting">Formatting and Typesetting</h3>
<p>The content of our documentation has many authors. These formatting guidelines will help maintain a consistent use of language throughout the docs.</p>
<ul>
<li><strong>Acronyms and abbreviations</strong> should always be set in uppercase (e.g. API, HTTP, JVM)</li>
<li><strong>Brand names</strong> should have correct typesetting (e.g. cURL, Event Store, JavaScript, .NET)</li>
<li><strong>Example code</strong> should not have a line length of more than 80 characters</li>
</ul>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/EventStore/docs.geteventstore.com/blob/swagger-docfx/README.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
About
Event Store documentation
Resources
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published
Languages
- CSS 64.7%
- JavaScript 35.3%