Add documentation

Author: habarthierry-hue

README.md

@@ -5,6 +5,14 @@
 
 EFCore.Cassandra is an Entity Framework Core provider built on top of [CassandraCSharpDriver](https://github.com/datastax/csharp-driver). It allows you to use EF Core O/RM with cassandra.
 
+For project documentation, please visit [readthedocs](https://efcorecassandra.readthedocs.io/en/latest/).
+
+## Packages
+
+|                         			 						|      																															  																					|																																					|																																					|
+| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `EFCore.Cassandra` 			 						    | [![MyGet (dev)](https://img.shields.io/myget/advance-ict/v/EFCore.Cassandra.svg)](https://www.myget.org/feed/advance-ict/package/nuget/EFCore.Cassandra)												            | [![NuGet](https://img.shields.io/nuget/v/EFCore.Cassandra.svg)](https://nuget.org/packages/EFCore.Cassandra) 						            	| [![NuGet](https://img.shields.io/nuget/dt/EFCore.Cassandra.svg)](https://nuget.org/packages/EFCore.Cassandra) 	           						|
+
 ## Contributing
 
 Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

appveyor.yml

@@ -24,7 +24,7 @@ deploy:
 - provider: NuGet
   name: production
   api_key:
-    secure: sCWC9q0qyTq//EuhS9kjMCqRDWaH5iF//mQrkraUiYoEjbVIWc/YQ3z3cB+wsbce
+    secure: Uigh51VjtY/sVniNFhkSvZ60/FvI9DyJ/g2feCm/WNdzeN9x5FSiqQwF9Y8qQ6nj
   on:
     branch: master
     appveyor_repo_tag: true

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,174 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = u'SimpleIdServer'
+copyright = u'2019, SimpleIdServer'
+author = u'SimpleIdServer'
+
+# The short X.Y version
+version = u''
+# The full version, including alpha/beta/rc tags
+release = u''
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx_rtd_theme"
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'SimpleIdServerdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'SimpleIdServer.tex', u'SimpleIdServer Documentation',
+     u'SimpleIdServer', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'simpleidserver', u'SimpleIdServer Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'SimpleIdServer', u'SimpleIdServer Documentation',
+     author, 'SimpleIdServer', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']

docs/index.rst

@@ -0,0 +1,17 @@
+Welcome to EFCore.Cassandra
+===========================
+
+EFCore.Cassandra is an Entity Framework Core provider built on top of CassandraCSharpDriver_. It allows you to use EF Core O/RM with cassandra.
+
+Github: https://github.com/simpleidserver/EFCore.Cassandra
+
+Nuget feed: https://www.myget.org/F/advance-ict/api/v3/index.json 
+
+.. toctree::
+   :maxdepth: 3
+   :hidden:
+   :caption: Getting started
+
+   intro/getting-started-with-efcorecassandra
+
+.. _CassandraCSharpDriver: https://github.com/datastax/csharp-driver

docs/intro/getting-started-with-efcorecassandra.rst

@@ -0,0 +1,82 @@
+Getting started with Entity Framework Core provider for Cassandra
+=================================================================
+
+.. note:: Sample project can be found on this url_.
+
+Install the nuget package
+-------------------------
+
+Create an empty DOTNET CORE project and install the nuget package ``EFCore.Cassandra``.
+Similarly to any EFCore project, create a class which inherits ``DbContext`` and add models.
+
+Configure DbContext
+-------------------
+
+Open the ``DbContext`` implementation, override the ``OnConfiguring`` method and configure database access::
+
+    optionsBuilder.UseCassandra("Contact Points=127.0.0.1;", opt =>
+    {
+      opt.MigrationsHistoryTable(HistoryRepository.DefaultTableName, "<schema name>");
+    });
+
+Configure keyspaces
+^^^^^^^^^^^^^^^^^^^
+
+**Definition** : A keyspace in Cassandra is a namespace that defines data replication on nodes. A cluster contains one keyspace per node.
+
+In order to configure a keyspace, open the ``DbContext`` implementation and insert the following line in the ``OnModelCreating`` method::
+
+    modelBuilder.ForCassandraAddKeyspace("<keyspace name>", KeyspaceReplicationSimpleStrategyClass());
+
+This method contains two parameters:
+
+- Keyspace name.
+- Replication strategy.
+
+There are two replication strategies:
+
+- **KeyspaceReplicationSimpleStrategyClass** : Use only for a single datacenter and one rack.
+- **KeyspaceReplicationNetworkTopologyStrategyClass** : Use when you have your cluster deployed across multiple datacenters.
+
+Configure tables
+^^^^^^^^^^^^^^^^
+
+**Definition** : data is stored in tables containing rows of columns, similar to SQL definitions.
+
+In order to configure one table, open the ``DbContext`` implementation and insert the following line in the ``OnModelCreating`` method::
+
+    modelBuilder.Entity<Applicant>()
+      .ToTable("applicants", "cv")
+      .HasKey(p => new { p.Id, p.LastName });
+    modelBuilder.Entity<Applicant>()
+      .ForCassandraSetClusterColumns(s => new { s.LastName });
+
+The method ``ToTable`` contains two parameters::
+
+- Table name.
+- Keyspace name.
+
+Add migrations
+--------------
+
+Once the ``DbContext`` implementation is configured, run the command ``dotnet ef migrations add InitialCreate`` to add migration scripts.
+Run the command ``dotnet ef database update`` to deploy the migration scripts.
+
+With the TablePlus_ tool  you should see something like this:
+
+.. image:: images/tables.png
+   :align: center
+
+CRUD operations
+---------------
+
+Once everything is set up, you can start playing with the ``DbContext``, use LINQ to run operations like ``Create``, ``Delete``, ``Update`` or ``Select``::
+
+    using (var dbContext = new FakeDbContext())
+    {
+      dbContext.Applicants.Add(BuildApplicant());
+      dbContext.SaveChanges();
+    }
+
+.. _url: https://github.com/simpleidserver/EFCore.Cassandra/tree/master/samples/EFCore.Cassandra.Samples
+.. _TablePlus: https://tableplus.com/

docs/intro/images/tables.png

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd