Ticket #6 : Add Documentation

Author: habarthierry-hue

README.md

@@ -4,4 +4,10 @@
 
 FaasNet makes it easy to deploy functions and API to Kubernetes without repetitive, boiler-plate coding.
 
-For project documentation, please visit [docs](https://simpleidserver.github.io/FaasNet/).
+For project documentation, please visit [docs](https://simpleidserver.github.io/FaasNet/).
+
+## Command Line
+
+| Command                     | Description                             |
+| --------------------------  | --------------------------------------- |
+| psake publishHelmAndWebsite | Publish Helm Charts and the website     |

default.ps1

@@ -23,7 +23,7 @@ task publish {
 	exec { dotnet publish $source_dir\FaasNet.Runtime.Transform\FaasNet.Runtime.Transform.csproj -c $config -o $result_dir\services\RuntimeTransform }
 	exec { dotnet publish $source_dir\FaasNet.Kubernetes\FaasNet.Kubernetes.csproj -c $config -o $result_dir\services\Kubernetes }
 	exec { dotnet publish $source_dir\FaasNet.Gateway.Startup\FaasNet.Gateway.Startup.csproj -c $config -o $result_dir\services\Gateway }
-	exec { dotnet publish $source_dir\FaasNet.CLI\FaasNet.CLI.csproj -c $config $result_dir\cli }
+	exec { dotnet publish $source_dir\FaasNet.CLI\FaasNet.CLI.csproj -c $config -o $result_dir\cli }
 }
 
 task clean {
@@ -48,10 +48,27 @@ task compile -depends clean {
     exec { dotnet build .\FaasNet.sln -c $config --version-suffix=$buildSuffix }
 }
 
-task publishWebsite {
+task publishHelmAndWebsite {
+	exec { git checkout gh-pages }
+	exec { Get-ChildItem -Path . -Include *.* -File -Recurse | foreach { $_.Delete()} }
+	exec { git add . }
+	exec { git commit -m "Remove" }
+	exec { git checkout master }
 	exec { docfx ./docs/docfx.json }
+	rd "$base_dir\docs\charts" -recurse -force  -ErrorAction SilentlyContinue | out-null
+	exec { helm package ./helm -d ./docs/charts }
+	exec { Copy-item "./helm/Chart.yaml" -Destination "./docs/charts" }
+	exec { helm repo index ./docs/charts }
+	exec { Remove-Item "./docs/charts/Chart.yaml" }
+	exec { Copy-item -Force -Recurse -Verbose "./docs/_site/*" -Destination "." }
+	exec { git checkout gh-pages --merge }
+	exec { git add . }
+	exec { git commit -m "Update Documentation" }
+	exec { git rebase -i HEAD~2 }
+	exec { git push origin gh-pages }
+	exec { git checkout master }
 }
- 
+
 task pack -depends release, compile {
 }
 

docs/charts/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

docs/charts/Chart.yaml

@@ -3,9 +3,9 @@ entries:
   faasnet:
   - apiVersion: v1
     appVersion: 0.0.1
-    created: "2021-09-21T21:11:54.9950703+02:00"
+    created: "2021-09-22T14:03:40.2331969+02:00"
     description: A helm chart to install faasnet
-    digest: c1e3723fd8a8c8ab49465d3b485ee795641cde4075055455370d0242201620ce
+    digest: f026cd42897393607222fdb81cb1cd1c115ddb2f2a70099142d5f3266d23b678
     home: https://github.com/simpleidserver/FaasNet
     maintainers:
     - email: [email protected]
@@ -14,4 +14,4 @@ entries:
     urls:
     - faasnet-0.0.1.tgz
     version: 0.0.1
-generated: "2021-09-21T21:11:54.9940938+02:00"
+generated: "2021-09-22T14:03:40.2331969+02:00"