Skip to content

Commit 522c970

Browse files
committed
v1.3.0 release
- Final update to documentation
1 parent 3ee4dc2 commit 522c970

File tree

9 files changed

+20
-18
lines changed

9 files changed

+20
-18
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,9 @@ A clear and concise description of what you expected to happen.
2121
If applicable, add screenshots to help explain your problem.
2222

2323
**System (please provide the following information about the system from which you are trying to generate a report):**
24-
- OS: [e.g. Windows 10]
25-
- PowerShell version [Provide output from the following command: `$PSVersionTable.PSVersion`]
26-
- Vendor PowerShell Module name and version [e.g. VMware PowerCLI 11.2]
27-
- AsBuiltReport.Core module version [e.g. 1.0.0]
28-
- AsBuiltReport module name and version [e.g. AsBuiltReport.VMware.vSphere 1.0.0]
24+
- Operating System: [e.g. Windows 10, macOS 12, Ubuntu 20.04]
25+
- PowerShell version [Provide output from the following command: `$PSVersionTable`]
26+
- AsBuiltReport.Core module version [Provide output from the following command: `Get-Module -ListAvailable AsBuiltReport.Core`]
2927

3028
**Additional context**
3129
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ about: Suggest an idea for this project
55
---
66

77
**Is your feature request related to a problem? Please describe.**
8-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
8+
A clear and concise description of what the problem is. e.g. I'm always frustrated when [...]
99

1010
**Describe the solution you'd like**
1111
A clear and concise description of what you want to happen.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@
3131
- [ ] My code follows the code style of this project.
3232
- [ ] My change requires a change to the documentation.
3333
- [ ] I have updated the documentation accordingly.
34-
- [ ] I have read the [**CONTRIBUTING**](https://www.asbuiltreport.com/about/contributing/) page.
34+
- [ ] I have read the [**CONTRIBUTING**](/CONTRIBUTING.md) page.

AsBuiltReport.Core.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
# CompanyName = ''
2929

3030
# Copyright statement for this module
31-
Copyright = '(c) 2020 Tim Carman. All rights reserved.'
31+
Copyright = '(c) 2022 Tim Carman. All rights reserved.'
3232

3333
# Description of the functionality provided by this module
3434
Description = 'A PowerShell module which provides the core framework for generating As-Built documentation for many common datacentre systems.'

CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
### Changed
88
- Updated `RequiredModules` for PScribo 0.10.0
99
- Updated installation instructions in `README.md`
10-
- Updated `CONTRIBUTING.md`
10+
- Updated contributing guide in `CONTRIBUTING.md`
1111
- Updated PSScriptAnalyzer settings
12-
- Updated Pull Request and Bug Report templates
13-
- Updated comment based help
14-
- Improved functionality for PowerShell 7
12+
- Updated GitHub issue templates
13+
- Updated comment based help for AsBuiltReport cmdlets
14+
- Improved command functionality for macOS and Linux users
1515

1616
## [1.2.0] - 2022-02-11
1717
### Added

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Use [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) to check
157157
- Maintain a change log as per [these guidelines](https://keepachangelog.com/en/1.0.0/). The change log should be named `CHANGELOG.md`.
158158

159159
❌ DO NOT
160-
<!-- - Do not include code within report scripts to install or import PowerShell modules. Dependencies should be documented under the `System Requirements` and `Module Installation` sections of the `README`. -->
160+
- Do not include code within report scripts to install or import PowerShell modules. Dependencies should either be documented under the `System Requirements` and `Module Installation` sections of the `README`, or added to the `RequiredModules` section within the report module manifest.
161161
- Do not include functions within report scripts. Individual script files should be created as a private function and be stored in the `\Src\Private` folder.
162162

163163
### License

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -230,8 +230,8 @@ New-AsBuiltReport -Report 'Cisco.UCSManager' -Target '192.168.1.100' -Username '
230230
New-AsBuiltReport -Report 'Nutanix.PrismElement' -Target '192.168.1.100' -Username 'admin' -Password 'admin' -Format HTML -AsBuiltConfigFilePath 'C:\scripts\asbuilt.json' -OutputFolderPath 'H:\Documents\' -Filename 'My Nutanix Configuration'
231231
```
232232

233-
## :pencil: Notes
234-
- Table Of Contents (TOC) may be missing in Word formatted report
233+
## :x: Known Issues
234+
- **Table Of Contents (TOC) is missing in Word formatted report**
235235

236236
When opening a Microsoft Word (DOCX) report for the first time, you will be prompted with the following warning;
237237

@@ -243,4 +243,8 @@ New-AsBuiltReport -Report 'Nutanix.PrismElement' -Target '192.168.1.100' -Userna
243243

244244
Always reply Yes to this message when prompted by Microsoft Word to ensure the Table of Contents is updated.
245245

246-
Save the document to prevent future prompts when opening the document.
246+
Save the document to prevent future prompts when opening the document.
247+
248+
- **Images are missing from reports generated using Linux or macOS**
249+
250+
Unfortunately due to [breaking changes](https://learn.microsoft.com/en-gb/dotnet/core/compatibility/core-libraries/6.0/system-drawing-common-windows-only) in .NET 6, images are no longer supported for reports generated using Linux or macOS.

Samples/AsBuiltReport.Sample.Style-1.ps1

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

Samples/AsBuiltReport.Sample.Style-2.ps1

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)