New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrote sections on ADO .NET and MemoryStorage providers #3100

Merged
merged 1 commit into from Jun 7, 2017

Conversation

Projects
None yet
4 participants
@dandago
Copy link
Contributor

dandago commented Jun 7, 2017

I have rewritten the ADO .NET and MemoryStorage provider sections in the Grain Persistence documentation page. The samples and tables are mainly taken from my ADO .NET Grain Persistence and Introduction to Grain persistence articles.

Some things worth noting:

  • I have added samples for both XML configuration and code configuration.
  • I have added tables listing all the properties you can set.
  • I have removed references to PostgreSQL since this is not actually supported (partly addresses #3085).
  • I have removed examples of SQL Server specific connection strings as well as a code block showing programmatic configuration that was impossible to read.
  • I have added info on the AdoInvariants you need to set (partly addresses #3070). While this is not necessary for SQL Server, I want to get people in the habit of setting it anyway so as not to miss it when setting things up for other vendors (which happened to me).
  • I am recommending the use of JSON format over binary.
  • I have changed the instructions regarding the StorageProviders sample which were incomplete.
@dnfclas

This comment has been minimized.

Copy link

dnfclas commented Jun 7, 2017

@dandago,
Thanks for your contribution.
To ensure that the project team has proper rights to use your work, please complete the Contribution License Agreement at https://cla2.dotnetfoundation.org.

It will cover your contributions to all .NET Foundation-managed open source projects.
Thanks,
.NET Foundation Pull Request Bot

@dnfclas dnfclas added the cla-required label Jun 7, 2017

@dnfclas

This comment has been minimized.

Copy link

dnfclas commented Jun 7, 2017

@dandago, thanks for signing the contribution license agreement. We will now validate the agreement and then the pull request.

Thanks, .NET Foundation Pull Request Bot

@dnfclas dnfclas added cla-signed and removed cla-required labels Jun 7, 2017

@veikkoeeva

This comment has been minimized.

Copy link
Contributor

veikkoeeva commented Jun 7, 2017

@dandago It's perhaps too much to omit PostgreSQL completely. The membership and reminder parts are implemented and hence PostgreSQL is a reasonable choice for a deployment.

@dandago

This comment has been minimized.

Copy link
Contributor

dandago commented Jun 7, 2017

@veikkoeeva The documentation page is about Grain Persistence. Including PostgreSQL there gave the false impression that it could be used for storage, which is not implemented.

If it can be used for cluster membership, then I suggest that it gets included in the relevant page.

@sergeybykov sergeybykov merged commit 2b46e29 into dotnet:gh-pages Jun 7, 2017

@sergeybykov

This comment has been minimized.

Copy link
Member

sergeybykov commented Jun 7, 2017

Thank you @dandago! Correcting the docs is such and important and often overlooked task.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment