Skip to content

Commit

Permalink
Version Updates
Browse files Browse the repository at this point in the history
version updates and built documentation.
  • Loading branch information
RobK410 committed May 3, 2023
1 parent 293d393 commit 15755d0
Show file tree
Hide file tree
Showing 9 changed files with 42 additions and 32 deletions.
6 changes: 6 additions & 0 deletions docs/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ <h2 id="why">Why</h2>
<p>.NET's <a href="https://docs.microsoft.com/en-us/dotnet/api/system.io.directory">Directory</a> and <a href="https://docs.microsoft.com/en-us/dotnet/api/system.io.file">File</a> classes are great abstractions over lower-level disk IO interactions, but they work with the local disk only. What if we could write a storage abstraction with similar simple methods, that allows you to do similar directory and file interactions but with a cloud provider like Azure, or an in-memory implementation for diskless unit testing?</p>
<p>There are plenty of storage abstraction libraries out on GitHub, but none of them took the approach of a very simplistic storage service implementation. In most cases, we can write the underlying implementation code for the simple directory and file methods found in System.IO.</p>
<p>We set out to create a library that does the minimum to get the common jobs we need to get done, and to this point, <strong>Talegen.Storage.Net</strong> was born.</p>
<h2 id="download">Download</h2>
<p>Libraries can be downloaded via nuget.org at the following:</p>
<ul>
<li><a href="https://www.nuget.org/packages/Talegen.Storage.Net.Core/">Talegen.Storage.Net.Core</a> - Core interface classes, local disk and memory storage implementations.</li>
<li><a href="https://www.nuget.org/packages/Talegen.Storage.Net.AzureBlobs/">Talegen.Storage.Net.AzureBlobs</a> - Azure Blob Storage File Share implementation.</li>
</ul>
<h2 id="documentation">Documentation</h2>
<p>For a general overview of the library, please visit the <a href="https://talegen.github.io/Talegen.Storage.Net/">Talegen.Storage.Net documentation online</a>.</p>
<h2 id="contributing">Contributing</h2>
Expand Down
48 changes: 23 additions & 25 deletions docs/manifest.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"homepages": [],
"source_base_path": "D:/Projects/Talegen/GitHub/Talegen.Storage.Net/src/Talegen.Storage.Net.Core",
"source_base_path": "c:/Projects/Talegen/Talegen.Storage.Net/src/Talegen.Storage.Net.Core",
"xrefmap": "xrefmap.yml",
"files": [
{
Expand All @@ -12,7 +12,7 @@
"hash": "30uAcWnzjtgS6OhIx8+/QmKD25KvvTCuevEvd+s/mfw="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand All @@ -21,10 +21,10 @@
"output": {
".html": {
"relative_path": "README.html",
"hash": "qm3tUVa8Atja/tta3PfhOhpnA4eWyDwBqnJS1m199mw="
"hash": "f1FP+Z7ysrI7LPFoglcfY4YpWq7Hv9f5lLl1QfrI6vI="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand Down Expand Up @@ -58,7 +58,7 @@
"hash": "n1Usif6mmqY45eEqd3DmX+vMRQXE9X2OtLZlOq1rgm4="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand Down Expand Up @@ -106,7 +106,7 @@
"hash": "IUj1qx8A9NX75vH9o53/Ry1vL0DkJmoC/loXrZUkvLQ="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand All @@ -118,7 +118,7 @@
"hash": "OFjbgxz/O2lcJ5jLpWbHlioZTvwEmr1vP42FY+uxhJ8="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand All @@ -130,7 +130,7 @@
"hash": "Wbw8VSzZvnUGeYCWIoGpHUn+8DPG55vcB+jnf5vSt4Y="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand All @@ -142,7 +142,7 @@
"hash": "klC64MicFe2jc2KNhNO3cdG8z7m8YAayjpp123/zpcM="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand All @@ -154,7 +154,7 @@
"hash": "Tbcikz7Mv+oA7Vf782bQnt1zkeIrPC/KgsK7AIbrZ14="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand All @@ -166,7 +166,7 @@
"hash": "qCoZFlmFrU2krrJ4WSQvq3UgDR8xZ1T1JYcZi+1dXJ4="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand All @@ -178,7 +178,7 @@
"hash": "y8Yh81sMRxE53xMMWciEGEW5+BY3jndfe1ZKlbI1jKg="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand All @@ -190,7 +190,7 @@
"hash": "dbzwWcERa8+WBTwVho9U2e7ioT7AuZpS6i5ktiiPEI8="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand All @@ -202,7 +202,7 @@
"hash": "lXDt8oUQ/UiAXjImWp1w+hyo0EgcXPhsBQTq9DzF2TA="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand All @@ -214,7 +214,7 @@
"hash": "lIxAgAUOBpt8u6KtQHOxDkBRGGPOHt7WmCjUna4igQ0="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand All @@ -226,7 +226,7 @@
"hash": "xQ+awB9kVVzQNphU6LeW2xgaL3IrOEDbanizwcw93bE="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand All @@ -238,7 +238,7 @@
"hash": "8q4iIakybjOUvlrtT1x7xK3/iXgKIqwyvPOmcmVoKyA="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
Expand Down Expand Up @@ -332,25 +332,23 @@
"incremental_info": [
{
"status": {
"can_incremental": false,
"details": "Cannot build incrementally because docfx version changed from 2.58.0.0 to 2.59.4.0.",
"can_incremental": true,
"incrementalPhase": "build",
"total_file_count": 0,
"skipped_file_count": 0,
"full_build_reason_code": "DocfxVersionChanged"
"skipped_file_count": 0
},
"processors": {
"ConceptualDocumentProcessor": {
"can_incremental": false,
"can_incremental": true,
"incrementalPhase": "build",
"total_file_count": 3,
"skipped_file_count": 0
"skipped_file_count": 3
},
"ManagedReferenceDocumentProcessor": {
"can_incremental": false,
"can_incremental": true,
"incrementalPhase": "build",
"total_file_count": 20,
"skipped_file_count": 0
"skipped_file_count": 15
},
"ResourceDocumentProcessor": {
"can_incremental": false,
Expand Down
1 change: 1 addition & 0 deletions ref/Talegen.Storage.Net.Core.Disk.LocalStorageContext.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ items:
content: 'public class LocalStorageContext : IStorageContext'
content.vb: >-
Public Class LocalStorageContext
Implements IStorageContext
inheritance:
- System.Object
Expand Down
1 change: 1 addition & 0 deletions ref/Talegen.Storage.Net.Core.Disk.LocalStorageService.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ items:
content: 'public class LocalStorageService : IStorageService'
content.vb: >-
Public Class LocalStorageService
Implements IStorageService
inheritance:
- System.Object
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ items:
content: 'public class MemoryStorageContext : IStorageContext'
content.vb: >-
Public Class MemoryStorageContext
Implements IStorageContext
inheritance:
- System.Object
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ items:
content: 'public class MemoryStorageService : IStorageService'
content.vb: >-
Public Class MemoryStorageService
Implements IStorageService
seealso:
- linkId: Talegen.Storage.Net.Core.IStorageService
Expand Down
2 changes: 2 additions & 0 deletions ref/Talegen.Storage.Net.Core.StorageException.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ items:
content: 'public class StorageException : Exception, ISerializable'
content.vb: >-
Public Class StorageException
Inherits Exception
Implements ISerializable
seealso:
- linkId: System.Exception
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@
<NeutralLanguage>en</NeutralLanguage>
<ApplicationIcon />
<EnableNETAnalyzers>true</EnableNETAnalyzers>
<Version>1.0.4</Version>
<AssemblyVersion>1.0.4.0</AssemblyVersion>
<FileVersion>1.0.4.0</FileVersion>
<Version>1.0.5</Version>
<AssemblyVersion>1.0.5.0</AssemblyVersion>
<FileVersion>1.0.5.0</FileVersion>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<DocumentationFile>.\Talegen.Storage.Net.AzureBlobs.xml</DocumentationFile>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Azure.Storage.Blobs" Version="12.14.1" />
<PackageReference Include="Azure.Storage.Files.Shares" Version="12.12.0" />
<PackageReference Include="Azure.Storage.Blobs" Version="12.16.0" />
<PackageReference Include="Azure.Storage.Files.Shares" Version="12.14.0" />
<PackageReference Include="docfx.console" Version="2.59.4">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.2" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
<PackageReference Include="xunit" Version="2.4.2" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="coverlet.collector" Version="3.1.2">
<PackageReference Include="coverlet.collector" Version="3.2.0">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
Expand Down

0 comments on commit 15755d0

Please sign in to comment.