chore: release preparation (#160)

- Updated `CHANGELOG.md` for release. - Updated docs for `PowerValidatedSolutions` version dependency for release. - Added `Makefile` for local testing. - Updated `.gitignore` to exclude the `.site` path and files from a local build test. - Removed banner and footer link.
vmware · Jul 25, 2023 · e6f074f · e6f074f
1 parent 57e19b8
commit e6f074f
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 21 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,7 @@
 # MacOS
 ## Ignore desktop services files.
 **/.DS_Store
+
+# MkDocs
+## Ignore site directory.
+**/.site/**
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,8 @@
 # Release History
 
-## v2.3.0 (Unreleased)
+## [v2.3.0](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/releases/tag/v2.3.0)
 
-> Release Date: Unreleased
+> Release Date: 2023-07-25
 
 Enhancement:
 

diff --git a/Makefile b/Makefile
@@ -0,0 +1,14 @@
+# 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.
+
+docs-install:
+	pip install mkdocs-material
+	pip install --requirement docs/requirements.txt
+docs-serve:
+	mkdocs serve
+docs-serve-live:
+	mkdocs serve --livereload -w ./
+docs-build:
+	mkdocs build
diff --git a/docs/index.md b/docs/index.md
@@ -48,8 +48,8 @@ PowerShell Module                                    | Version   | Publisher
 -----------------------------------------------------|-----------|--------------|---------------------------------------------------------------------------
 [VMware.PowerCLI][psgallery-module-powercli]         | >= 13.0.0 | VMware, Inc. | :fontawesome-solid-book: &nbsp; [Documentation][developer-module-powercli]
 [VMware.vSphere.SsoAdmin][psgallery-module-ssoadmin] | >= 1.3.9  | VMware, Inc. | :fontawesome-brands-github: &nbsp; [GitHub][github-module-ssoadmin]
-[PowerVCF][psgallery-module-powervcf]                | >= 2.3.0  | VMware, Inc. | :fontawesome-brands-github: &nbsp; [GitHub][github-module-powervcf]
-[PowerValidatedSolutions][psgallery-module-pvs]      | >= 2.4.0  | VMware, Inc. | :fontawesome-brands-github: &nbsp; [GitHub][github-module-pvs]
+[PowerVCF][psgallery-module-powervcf]                | >= 2.3.0  | VMware, Inc. | :fontawesome-solid-book: &nbsp; [Documentation][docs-module-powervcf]
+[PowerValidatedSolutions][psgallery-module-pvs]      | >= 2.5.0  | VMware, Inc. | :fontawesome-solid-book: &nbsp; [Documentation][docs-module-pvs]
 
 ### Browsers
 
@@ -62,6 +62,8 @@ Browser                                             | Download
 :fontawesome-brands-firefox: &nbsp; Mozilla Firefox | :fontawesome-solid-cloud-arrow-down: &nbsp; [Download][download-browser-firefox]
 
 [docs-vmware-cloud-foundation]: https://docs.vmware.com/en/VMware-Cloud-Foundation/index.html
+[docs-module-powervcf]: https://vmware.github.io/powershell-module-for-vmware-cloud-foundation
+[docs-module-pvs]: https://vmware-samples.github.io/power-validated-solutions-for-cloud-foundation
 [download-browser-edge]: https://www.microsoft.com/edge
 [download-browser-chrome]: https://www.google.com/chrome
 [download-browser-firefox]: https://www.mozilla.org/firefox/download
@@ -72,7 +74,5 @@ Browser                                             | Download
 [psgallery-module-ssoadmin]: https://www.powershellgallery.com/packages/VMware.vSphere.SsoAdmin
 [psgallery-module-pvs]: https://www.powershellgallery.com/packages/PowerValidatedSolutions
 [developer-module-powercli]: https://developer.vmware.com/tool/vmware-powercli
-[github-module-powervcf]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation
 [github-module-ssoadmin]: https://github.com/vmware/PowerCLI-Example-Scripts/tree/master/Modules/VMware.vSphere.SsoAdmin
-[github-module-pvs]: https://github.com/vmware-samples/power-validated-solutions-for-cloud-foundation
 [github-os-photon]: https://vmware.github.io/photon/
diff --git a/docs/snippets/install-module.ps1 b/docs/snippets/install-module.ps1
@@ -2,5 +2,5 @@ Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
 Install-Module -Name VMware.PowerCLI -MinimumVersion 13.0.0
 Install-Module -Name VMware.vSphere.SsoAdmin -MinimumVersion 1.3.9
 Install-Module -Name PowerVCF -MinimumVersion 2.3.0
-Install-Module -Name PowerValidatedSolutions -MinimumVersion 2.4.0
+Install-Module -Name PowerValidatedSolutions -MinimumVersion 2.5.0
 Install-Module -Name VMware.CloudFoundation.Reporting
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -12,9 +12,7 @@ repo_url: https://github.com/vmware/powershell-module-for-vmware-cloud-foundatio
 edit_uri: blob/main/docs/
 
 # Copyright
-copyright: >
-  Copyright &copy; 2023 - VMware, Inc. –
-  <a href="#__consent">Manage Settings</a>
+copyright: Copyright &copy; 2023 - VMware, Inc.
 
 # Configuration
 theme:
@@ -84,17 +82,6 @@ extra:
   config:
     repo_url: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting
     repo_url_raw: https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting
-  consent:
-    title: Cookie Consent
-    description: >- 
-      We use cookies to recognize your repeated visits and preferences, as well
-      as to measure the effectiveness of our documentation and whether users
-      find what they're searching for. With your consent, you're helping us to
-      make our documentation better.
-    actions:
-      - accept
-      - manage
-      - reject
   version:
     default: latest
     provider: mike