Merge pull request #66 from geekwhocodes/dev

Docs website

Author: geekwhocodes

docs/index.md

@@ -0,0 +1,22 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+.vscode

website/.gitignore

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Ganesh Raskar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

website/LICENSE

@@ -0,0 +1,33 @@
+# Website
+
+This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+```
+$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

website/README.md

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

website/babel.config.js

@@ -0,0 +1,28 @@
+---
+id: release-v1.0.0
+title: SimplePSLogger V1.0.0
+author: Ganesh Raskar
+author_title: Azure Consultant @rapidcircle
+author_url: https://github.com/geekwhocodes
+author_image_url: https://avatars1.githubusercontent.com/u/10639200?s=460&u=37ca79e81c11cea6f3611f457570ab2976097c65&v=4
+tags: [intro]
+---
+
+### ``` Install-Module -Name SimplePSLogger```
+[SimplePSLogger](https://www.powershellgallery.com/packages/SimplePSLogger/1.0.0)
+
+
+**Added**
+- Added Azure Log Analytics logging provider ⭐
+- Added feature to register external providers. Bring your own logger 🔥
+- Added Tests 💜
+- Added documentation
+
+**Removed**
+- NA 
+
+**Bug Fixes**
+- Minor fixes
+
+**Known Issues**
+- https://spsl.geekwhocodes.me/known-issues

website/blog/2020-07-06-v1.0.0.md

@@ -0,0 +1,58 @@
+---
+title: Configurations
+id: configurations
+description: SimplePSLogger configutation
+keywords:
+  - logging
+  - SimplePSLogger 
+---
+
+Configure it your way 🤘
+
+SimplePSLogger support's multiple [**Logging Providers**](providers.md) and each provider has it's own configuration properties which you can configure. This gives provider writers an ability to create more powerful and robust providers. You can find configurable properties for each provider on provider's page under **```Configuration```** section. 
+
+
+### Sample Configuration Object
+
+```powershell
+$SimplePSLoggerConfig = @{
+    Name      = "Your-Logger-Name" # You can configure this name using -Name parameter too
+    Providers = @{
+        Console = @{
+            Enabled  = $true
+            LogLevel = "verbose"
+        }
+        File    = @{
+            LiteralFilePath = "literal\path\file.log"
+            LogLevel        = "information"
+            Enabled         = $true
+        }
+    }
+}
+```
+
+You can configure logger name in your configuration object using **Name** property.
+Configuration object has **```Providers```** section which contains provider specific configurations. 
+Example - in above example we have configured Console and File logging providers respectively. 
+
+:::tip
+Each provider has default **Enabled** and **LogLevel** properties. You can configure them as per your needs.
+:::
+
+
+The name of configuration section follows naming convention: if logging provider's name is **```SimplePSLogger.XYZ```** then you use **```XYZ```** name in configuration object. In above example, we used **```File```** name to configure **```SimplePSLogger.File```** provider. You can find more information on how to configure specific provider under it's own page under [Providers](providers.md) or Custome Providers documentation.
+
+### Log Message Format
+
+SimplePSLogger use following log message format -
+UTC-Timestamp[space]logger-name[space]loglevel[space]Log message
+:::info
+UTC Timestamp format : yyyy/MM/dd HH:mm:ss:ffff tt
+:::
+![sample-logs-image](/img/providers/simplepslogger.console.png)
+
+
+
+:::note
+*Each provider can have their own log message format*
+:::

website/docs/configurations.md

@@ -0,0 +1,6 @@
+---
+title: Contributing
+id: contributing
+---
+
+Comming soon

website/docs/contributing.md

@@ -0,0 +1,70 @@
+---
+title: Custom Provider Registration
+id: custom-provider-registration
+description: "Registering SimplePSLogger Custom Logging Provider"
+keywords:
+    - simple-ps-logger
+    - powershell core
+    - powershell logging
+    - pscore
+    - SimplePSLogger
+    - geekwhocodes
+---
+
+We assume that you have successfully create custom logging provider by following [writing custom provider](writing-custom-provider.md). Let's register it so that you can use it.
+
+### Steps 
+- Import SimplePSLogger module
+- Import your custom logging provider module
+- Create SimplePSLogger instance
+- Register your provider using .Register method
+
+
+### Registration
+
+```powershell {30}
+# 1. Import SimplePSLogger module
+Import-Module -Name SimplePSLogger
+# 2. Import your custom logging provider module
+Import-Module -Name CustomeLoggingProvider
+# Create SimplePSLogger configuration 
+$SimplePSLoggerConfig = @{
+    Name      = "config-example"
+    Providers = @{
+        Console       = @{
+            LogLevel = "verbose"
+            Enabled  = $false
+        }
+        File          = @{
+            LiteralFilePath = "G:\Git\simple-ps-logger\Examples\example-with-config-file\example-with-config.log"
+            LogLevel        = "information"
+            Enabled         = $false
+        }
+        AwesomeLogger = @{
+            Enabled  = $true
+            LogLevel = "information"
+            Authkey  = "key"
+        }
+    }
+}
+
+# 3. Create SimplePSLogger instance
+$MyLogger = New-SimplePSLogger -Name "ps-play"
+
+# 4. Register your provider using .Register method. MAKE SURE function named "ExtProvider" is imported
+$MyLogger.RegisterProvider("AwesomeLogger", "ExtProvider", $SimplePSLoggerConfig.Providers["AwesomeLogger"])
+
+
+$MyLogger.Log("test")
+```
+
+### Registration Paramters
+
+1. Customer Logging Provider Name
+2. Exported function name which implements [SimplePSLogger Provider Interface](writing-custom-provider.md#SimplePSLogger-Provider-Interface)
+3. Configuration object required/defined by custom provider
+
+
+<br/>
+
+If you are facing problems, tweet me at [@_ganesh_raskar](https://twitter.com/_ganesh_raskar)

website/docs/custom-provider-registration.md

@@ -0,0 +1,8 @@
+---
+id: custom-providers-intro
+title: Custom Providers Introduction
+---
+
+> #### Bring your own logger
+
+SimplePSLogger comes with few commonly used providers, however if you would like display or store logs in custom dimensions/schema or format then custom provider provides a way to register your provider.