Skip to content

Commit

Permalink
Update docs and change version for release
Browse files Browse the repository at this point in the history
Summary:
- Major renaming of docs
- Updating XML comment sections (MySQL -> SingleStore)
- Change connector's logo
- Change version of connector for release (config.yml, README.md, VersionHistory.md)

Test Plan: https://app.circleci.com/pipelines/github/memsql/SingleStoreNETConnector/200/workflows/bafde189-d077-411e-8461-df7bc6f856a9

Reviewers: pmishchenko-ua

Reviewed By: pmishchenko-ua

Subscribers: engineering-list

JIRA Issues: PLAT-6101

Differential Revision: https://grizzly.internal.memcompute.com/D55789
  • Loading branch information
okramarenko committed Mar 28, 2022
1 parent bdbe6d5 commit c79ee0a
Show file tree
Hide file tree
Showing 1,043 changed files with 10,391 additions and 14,433 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: 2.1
parameters:
connector-version:
type: string
default: "0.1.1-beta"
default: "v0.1.2-beta"

orbs:
win: circleci/[email protected]
Expand Down
3 changes: 0 additions & 3 deletions .lgtm.yml

This file was deleted.

34 changes: 0 additions & 34 deletions CODE_OF_CONDUCT.md

This file was deleted.

6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Async SingleStore Connector for .NET and .NET Core V0.1.0 Preview
# Async SingleStore Connector for .NET and .NET Core v0.1.2-beta

This is an [ADO.NET](https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/) data
provider for [SingleStore](https://www.singlestore.com/). It provides implementations of
Expand All @@ -19,7 +19,7 @@ To build and run the tests, clone the repo and execute:

```
dotnet restore
dotnet test tests\MySqlConnector.Tests
dotnet test tests\SingleStoreConnector.Tests
```

To run the side-by-side tests, see [the instructions](tests/README.md).
Expand All @@ -36,7 +36,7 @@ The goals of this project are:
6. **Independent:** This is a clean-room reimplementation of the [MySQL Protocol](https://dev.mysql.com/doc/internals/en/client-server-protocol.html), not based on Connector/NET.

Cloning the full API of Connector/NET is not a goal of this project, although
it will try not to be gratuitously incompatible. For typical scenarios, [migrating to this package](https://mysqlconnector.net/tutorials/migrating-from-connector-net/) should
it will try not to be gratuitously incompatible. For typical scenarios, [migrating to this package](https://github.com/memsql/SingleStoreNETConnector/blob/master/docs/content/tutorials/migrating-from-connector-net.md) should
be easy.

## License
Expand Down
8 changes: 2 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
MySqlConnector Docs
SingleStoreConnector Docs
===================

Documentation from the `content` directory is built using the static site generator [Hugo](http://gohugo.io/)

To preview documentation changes locally, [Install Hugo](https://github.com/spf13/hugo/releases), then run `hugo serve` from this directory

All documentation pushed to the `master` branch will automatically be built and posted to https://mysqlconnector.net/
Documentation from the `content\api` directory is built using [XmlDocMarkdown](https://ejball.com/XmlDocMarkdown/)
8 changes: 4 additions & 4 deletions docs/UsingLog4netLogging.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
## How to Use

To integrate MySqlConnector with log4net, add the following line of code to your application startup routine (before any `MySqlConnector` objects have been used):
To integrate SingleStoreConnector with log4net, add the following line of code to your application startup routine (before any `SingleStoreConnector` objects have been used):

```csharp
MySqlConnectorLogManager.Provider = new Log4netLoggerProvider();
SingleStoreConnectorLogManager.Provider = new Log4netLoggerProvider();
```

To reduce the verbosity of MySqlConnector logging, add the following element to your log4net config:
To reduce the verbosity of SingleStoreConnector logging, add the following element to your log4net config:

```xml
<log4net>
...
<logger name="MySqlConnector">
<logger name="SingleStoreConnector">
<level value="WARN" />
</logger>
```
6 changes: 3 additions & 3 deletions docs/UsingMicrosoftExtensionsLogging.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
## How to Use

To integrate MySqlConnector with Microsoft.Extensions.Logging, add the following line of code to `Program.cs` method (before any `MySqlConnector` objects have been used):
To integrate SingleStoreConnector with Microsoft.Extensions.Logging, add the following line of code to `Program.cs` method (before any `SingleStoreConnector` objects have been used):

```csharp
app.Services.UseMySqlConnectorLogging();
app.Services.UseSingleStoreConnectorLogging();
```

Alternatively, obtain an `ILoggerFactory` through dependency injection and add:

```csharp
MySqlConnectorLogManager.Provider = new MicrosoftExtensionsLoggingLoggerProvider(loggerFactory);
SingleStoreConnectorLogManager.Provider = new MicrosoftExtensionsLoggingLoggerProvider(loggerFactory);
```
4 changes: 2 additions & 2 deletions docs/UsingNLogLogging.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## How to Use

To integrate MySqlConnector with [NLog](http://nlog-project.org/), add the following line of code to your application startup routine (before any `MySqlConnector` objects have been used):
To integrate SingleStoreConnector with [NLog](http://nlog-project.org/), add the following line of code to your application startup routine (before any `SingleStoreConnector` objects have been used):

```csharp
MySqlConnectorLogManager.Provider = new NLogLoggerProvider();
SingleStoreConnectorLogManager.Provider = new NLogLoggerProvider();
```
4 changes: 2 additions & 2 deletions docs/UsingSerilogLogging.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## How to Use

To integrate MySqlConnector with [Serilog](https://serilog.net/), add the following line of code to your application startup routine (before any `MySqlConnector` objects have been used):
To integrate SingleStoreConnector with [Serilog](https://serilog.net/), add the following line of code to your application startup routine (before any `SingleStoreConnector` objects have been used):

```csharp
MySqlConnectorLogManager.Provider = new SerilogLoggerProvider();
SingleStoreConnectorLogManager.Provider = new SerilogLoggerProvider();
```
10 changes: 4 additions & 6 deletions docs/VersionHistory.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# MySqlConnector Version History

## Known Issues

Known Issues have [moved here](https://mysqlconnector.net/overview/known-issues/).
# SingleStoreConnector Version History

## Release Notes

Release Notes have [moved here](https://mysqlconnector.net/overview/version-history/).
###v0.1.2-beta

*Initial beta release of SingleStore .NET connector
39 changes: 0 additions & 39 deletions docs/config.toml

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading

0 comments on commit c79ee0a

Please sign in to comment.