Skip to content

Commit 8f2d1b7

Browse files
committed
full edit file share topics
1 parent 9e79995 commit 8f2d1b7

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

api/v4/fileshares/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Windows Network File Shares
22

3-
Steeltoe's `WindowsNetworkFileShare` class provides a simplified experience for interacting with SMB file shares by making [P/Invoke calls](https://learn.microsoft.com/cpp/dotnet/how-to-call-native-dlls-from-managed-code-using-pinvoke) to underlying Windows APIs, specifically to `mpr.dll`. For more background on SMB, see the [Microsoft SMB Protocol documentation](https://learn.microsoft.com/windows/win32/fileio/microsoft-smb-protocol-and-cifs-protocol-overview).
3+
The Steeltoe `WindowsNetworkFileShare` class provides a simplified experience for interacting with SMB file shares by making [P/Invoke calls](https://learn.microsoft.com/cpp/dotnet/how-to-call-native-dlls-from-managed-code-using-pinvoke) to underlying Windows APIs, specifically to `mpr.dll`. For more information about SMB, see the [Microsoft SMB Protocol documentation](https://learn.microsoft.com/windows/win32/fileio/microsoft-smb-protocol-and-cifs-protocol-overview).
44

5-
Network shares are not the most cloud-native way to deal with files. For new development, consider exploring message queues, caches, blob stores, and NoSQL stores. The alternatives offer greater resiliency and decoupling from backing services. That said, sometimes the alternatives are not viable. For .NET applications deployed to Microsoft Windows Servers, Steeltoe provides a stepping stone towards cloud-native in the form of the `WindowsNetworkFileShare`. For applications deployed to Linux hosts on the Tanzu Platform, [volume services](https://docs.vmware.com/en/VMware-Tanzu-Application-Service/6.0/tas-for-vms/enable-vol-services.html) are available.
5+
Network shares are not the most cloud-native way to deal with files. For new development, consider exploring message queues, caches, blob stores, and NoSQL stores. The alternatives offer greater resiliency and decoupling from backing services. That said, sometimes the alternatives are not viable. For .NET applications deployed to Microsoft Windows Servers, Steeltoe provides a stepping stone towards cloud-native deployment in the form of the `WindowsNetworkFileShare`. For applications deployed to Linux hosts on the Tanzu Platform, [volume services](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/tanzu-platform-for-cloud-foundry/10-0/tpcf/enable-vol-services.html) are available.

api/v4/fileshares/usage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Usage
1+
# Using Network File Share
22

33
Before starting with Steeltoe's Windows Network File Share library, you should already have a plan for interacting with the file system. Steeltoe only manages the connection to the file share.
44

55
## Add NuGet References
66

7-
To use the `WindowsNetworkFileShare` class, you need to add a reference to the `Steeltoe.Common.Net` NuGet package.
7+
To use the `WindowsNetworkFileShare` class, add a reference to the `Steeltoe.Common.Net` NuGet package.
88

99
## Managing the Connection
1010

@@ -36,9 +36,9 @@ using (new WindowsNetworkFileShare(@"\\server\path", new NetworkCredential("user
3636

3737
### Managing Credentials
3838

39-
Credentials are generally required for interacting with SMB shares. `WindowsNetworkFileShare` does not have an opinion on where those credentials are stored. However, as a general guideline, storing credentials with your application's code or standard configuration is not recommended. Consider using the [CredHub Service Broker](https://docs.vmware.com/en/VMware-Tanzu-Application-Service/6.0/tas-for-vms/credhub-index.html) for storing and retrieving your credentials.
39+
Credentials are generally required for interacting with SMB shares. `WindowsNetworkFileShare` does not have an opinion on where those credentials are stored. However, as a general guideline, storing credentials with your application's code or standard configuration is not recommended. Consider using the [CredHub Service Broker](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform-services/credhub-service-broker/services/credhub-sb/index.html) for storing and retrieving your credentials.
4040

41-
When used in conjunction with the Cloud Foundry Configuration Provider, you can access the values as follows:
41+
When used with the Cloud Foundry Configuration Provider, you can access the values as follows:
4242

4343
```shell
4444
dotnet add package Steeltoe.Configuration.CloudFoundry

0 commit comments

Comments
 (0)