V4 Documentation Updates and Reorganization (#1882)

* first cut at reorganizing docs * organization in place * worked over AddMarten() a bit. Closes GH-1881 * doc updates on the /guide/configuration topics * cleaned up the entry document db page and the identity page * cleaned up the storage docs * Remove sample name from all #endregion * Update readme relating to v4 docs samples * Update readme [skip ci] * Add Algolia search integration for v4 docs * Upgraded Weasel. Fixed the tests that were failing because of bi-directional dependencies. Closes GH-1841 * Bump up version to rc.6 * Update Algolia config [skip ci] * Update Algolia config [skip ci] * Update readme to add v3 and v4 docs link at start [skip ci] * Move build related project and files under build folder * Remove build folder from .gitignore [skip ci] * Update GH actions to use build.sh * Tweaked the GH actions * Update to inline the children objects in sidebar rather than having seperate methods * updated docs on document sessions * updates to storing documents docs * updates to deleting documents * Fix for GH-1888 to ensure the passed logger gets used * Using ctid instead of id for querying through child collections. Closes GH-1884 * Preliminary work before refactoring Statement * WIP: optimizing collection queries by moving them to the top * Optimization for querying within subqueries by moving filters to the top level CTE as possible. Closes GH-1864 * Unit test demonstrating bug #1886. * Compiled query parameters can be used more than once now. Closes GH-1886 * Fix run_specification for Inline_Aggregation_by_Stream.md (#1889) * Update IdExamples.cs (#1892) Invoide -> Invoice misspelling fix. * update identity related docs * Attempt to fix a merge conflict * Remove tenancy/basic-operations.md added to resolve merge conflict * Fix merge conflict (remove tenancy folder after merge of PR) Co-authored-by: mysticmind <[email protected]> Co-authored-by: Jeremy D. Miller <[email protected]> Co-authored-by: Oskar Dudycz <[email protected]> Co-authored-by: Raif Atef <[email protected]> Co-authored-by: Cédric Luthi <[email protected]> Co-authored-by: Khalid Abuhakmeh <[email protected]>
JasperFx · Sep 20, 2021 · 134968b · 134968b
1 parent 683a8d6
commit 134968b
Show file tree

Hide file tree

Showing 107 changed files with 5,860 additions and 29,405 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,70 +0,0 @@
-# Contributing to Marten 
-
-We take Pull Requests!
-
-## Before you send Pull Request
-
-
-1. Contact the contributors via the [Gitter channel](https://gitter.im/JasperFx/marten) or the [Github Issue](https://github.com/JasperFx/marten/issues/new) to make sure that this is issue or bug should be handled with proposed way. Send details of your case and explain the details of the proposed solution.
-2. Once you get approval from one of the maintainers, you can start to work on your code change.
-3. After your changes are ready, make sure that you covered your case with automated tests and verify that you have limited the number of breaking changes to a bare minimum.
-4. We also highly appreciate any relevant updates to the documentation.
-5. Make sure that your code is compiling and all automated tests are passing.
-
-## After you have sent Pull Request
-
-1. Make sure that you applied or answered all the feedback from the maintainers.
-2. We're trying to be as much responsive as we can, but if we didn't respond to you, feel free to ping us on the [Gitter channel](https://gitter.im/JasperFx/marten).
-3. Pull request will be merged when you get approvals from at least 2 of the maintainers (and no rejection from others). Pull request will be tagged with the target Marten version in which it will be released. We also label the Pull Requests with information about the type of change.
-
-## Setup your work environment
-
-We try to limit the number of necessary setup to a minimum, but few steps are still needed:
-
-**1. Install .NET Core SDK 2.1 (or higher)**
-
-Available [here](https://www.microsoft.com/net/download/core)
-
-**2. Install .NET Framework 4.6.1 Developer Pack**
-
-Available [here](https://dotnet.microsoft.com/download/thank-you/net461-developer-pack)
-
-**3. Use PostgreSQL 9.5 or above database with PLV8**
-
-You need to enable the PLV8 extension inside of PostgreSQL for running JavaScript stored procedures for the nascent projection support.
-
-Ensure the following:
-
-- The login you are using to connect to your database is a member of the `postgres` role
-- An environment variable of `marten_testing_database` is set to the connection string for the database you want to use as a testbed. (See the [Npgsql documentation](http://www.npgsql.org/doc/connection-string-parameters.html) for more information about PostgreSQL connection strings ).
-
-_Help with PSQL/PLV8_
-
-- On Windows, see [this link](http://www.postgresonline.com/journal/archives/360-PLV8-binaries-for-PostgreSQL-9.5-windows-both-32-bit-and-64-bit.html) for pre-built binaries of PLV8
-- On *nix, check [marten-local-db](https://github.com/eouw0o83hf/marten-local-db) for a Docker based PostgreSQL instance including PLV8.
-
-Once you have the codebase and the connection string file, run the build script or use the dotnet CLI to restore and build the solution.
-
-You are now ready to contribute to Marten.
-
-## Working with the Git
-
-1. Fork the repository.
-2. Create a feature branch from the `master` branch.
-3. We're not squashing the changes and using rebase strategy for our branches (see more in [Git documentation](https://git-scm.com/book/en/v2/Git-Branching-Rebasing)). Having that, we highly recommend using clear commit messages. Commits should also represent the unit of change.
-4. Before sending PR to make sure that you rebased the latest `master` branch from the main Marten repository.
-5. When you're ready to create the [Pull Request on GitHub](https://github.com/JasperFx/marten/compare).
-
-## Code style
-
-Coding rules are set up in the [.editorconfig file](.editorconfig). This file is supported by all popular IDE (eg. Microsoft Visual Studio, Rider, Visual Studio Code) so if you didn't disabled it manually they should be automatically applied after opening the solution. We also recommend turning automatic formatting on saving to have all the rules applied.
-
-## Licensing and legal rights
-
-By contributing to Marten:
-
-1. You assert that contribution is your original work.
-2. You assert that you have the right to assign the copyright for the work.
-3. You are accepting the [License](LICENSE).
-
-

diff --git a/README.md b/README.md
diff --git a/benchmarks/1.3/DocumentActions-report-github.md b/benchmarks/1.3/DocumentActions-report-github.md
@@ -1,14 +0,0 @@
-``` ini
-
-BenchmarkDotNet=v0.10.1, OS=Microsoft Windows NT 6.1.7601 Service Pack 1
-Processor=Intel(R) Core(TM) i7-4980HQ CPU 2.80GHz, ProcessorCount=4
-Frequency=10000000 Hz, Resolution=100.0000 ns, Timer=UNKNOWN
-  [Host]     : Clr 4.0.30319.42000, 64bit RyuJIT-v4.6.1076.0
-  Job-DNINOD : Clr 4.0.30319.42000, 64bit RyuJIT-v4.6.1076.0
-
-WarmupCount=2  Gen 0=287.5000  Allocated=4.62 MB  
-
-```
-          Method |       Mean |    StdDev |
----------------- |----------- |---------- |
- InsertDocuments | 43.7957 ms | 2.6786 ms |

diff --git a/benchmarks/1.3/LinqActions-report-github.md b/benchmarks/1.3/LinqActions-report-github.md
@@ -1,16 +0,0 @@
-``` ini
-
-BenchmarkDotNet=v0.10.1, OS=Microsoft Windows NT 6.1.7601 Service Pack 1
-Processor=Intel(R) Core(TM) i7-4980HQ CPU 2.80GHz, ProcessorCount=4
-Frequency=10000000 Hz, Resolution=100.0000 ns, Timer=UNKNOWN
-  [Host]     : Clr 4.0.30319.42000, 64bit RyuJIT-v4.6.1076.0
-  Job-DNINOD : Clr 4.0.30319.42000, 64bit RyuJIT-v4.6.1076.0
-
-WarmupCount=2  
-
-```
-            Method |            Mean |        StdDev |     Gen 0 |   Gen 1 | Allocated |
------------------- |---------------- |-------------- |---------- |-------- |---------- |
- CreateLinqCommand |     179.9882 us |     6.0692 us |    2.6693 |       - |  45.11 kB |
-      RunLinqQuery | 112,916.1908 us | 2,069.6093 us | 4925.0000 |       - |  34.03 MB |
-   CompiledQueries |  27,084.0787 us |   210.1911 us |  941.6667 | 66.6667 |    8.7 MB |

diff --git a/benchmarks/2.0.baseline/results/DocumentActions-report-default.md b/benchmarks/2.0.baseline/results/DocumentActions-report-default.md
@@ -1,12 +0,0 @@
-
-BenchmarkDotNet=v0.10.1, OS=Microsoft Windows NT 6.1.7601 Service Pack 1
-Processor=Intel(R) Core(TM) i7-4980HQ CPU 2.80GHz, ProcessorCount=4
-Frequency=10000000 Hz, Resolution=100.0000 ns, Timer=UNKNOWN
-  [Host]     : Clr 4.0.30319.42000, 64bit RyuJIT-v4.6.1076.0
-  Job-DNINOD : Clr 4.0.30319.42000, 64bit RyuJIT-v4.6.1076.0
-
-WarmupCount=2  Gen 0=415.7609  Allocated=4.46 MB  
-
-          Method |       Mean |    StdDev |
----------------- |----------- |---------- |
- InsertDocuments | 43.0381 ms | 1.5788 ms |

diff --git a/benchmarks/2.0.fastexpressioncompiler/results/BulkLoading-report-default.md b/benchmarks/2.0.fastexpressioncompiler/results/BulkLoading-report-default.md
@@ -1,12 +0,0 @@
-
-BenchmarkDotNet=v0.10.1, OS=Microsoft Windows NT 6.1.7601 Service Pack 1
-Processor=Intel(R) Core(TM) i7-4980HQ CPU 2.80GHz, ProcessorCount=4
-Frequency=10000000 Hz, Resolution=100.0000 ns, Timer=UNKNOWN
-  [Host]     : Clr 4.0.30319.42000, 64bit RyuJIT-v4.6.1076.0
-  Job-DNINOD : Clr 4.0.30319.42000, 64bit RyuJIT-v4.6.1076.0
-
-WarmupCount=2  Gen 0=1014.4231  Allocated=7.74 MB  
-
-              Method |        Mean |    StdDev |
--------------------- |------------ |---------- |
- BulkInsertDocuments | 188.1269 ms | 8.5848 ms |