Skip to content

Commit 94e3ee0

Browse files
rebelinuxrebelinux
committed
Update module version to 1.5.0 and enhance README with multi-language support details
1 parent aef423b commit 94e3ee0

File tree

3 files changed

+57
-37
lines changed

3 files changed

+57
-37
lines changed

‎AsBuiltReport.System.Resources.psd1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
RequiredModules = @(
5656
@{
5757
ModuleName = 'AsBuiltReport.Core';
58-
ModuleVersion = '1.4.3'
58+
ModuleVersion = '1.5.0'
5959
}
6060
)
6161

‎CHANGELOG.md‎

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,9 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [0.1.1] - 2025-09-??
8+
## [0.1.1] - 2025-10-11
99

1010
### Added
1111

12-
- Introduced English and Spanish translations for date-related messages.
13-
- Updated System Resources report to include language and status fields.
14-
- Enhanced date collection messages for clarity and consistency.
15-
- Removed outdated translation files for Get-AbrDate.
16-
- Created a new Todo.md file for future enhancements.
17-
18-
### Changed
19-
20-
### Fixed
21-
22-
### Removed
23-
24-
12+
- Introduce multi-language support.
13+
- Add sections for Date, TimeZone, Uptime, PowerShell Host, and Process.

‎README.md‎

Lines changed: 53 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ The System Resources As Built Report supports the following Resources versions;
5151
This report is compatible with the following PowerShell versions;
5252

5353
<!-- ********** Update supported PowerShell versions ********** -->
54-
| Windows PowerShell 5.1 | PowerShell 7 |
55-
|:----------------------:|:--------------------:|
54+
| Windows PowerShell 5.1 | PowerShell 7 |
55+
| :--------------------: | :----------------: |
5656
| :white_check_mark: | :white_check_mark: |
5757

5858
## 🗺️ Language Support
@@ -92,8 +92,11 @@ PowerShell 5.1 or PowerShell 7, and the following PowerShell modules are require
9292
- [AsBuiltReport.System.Resources Module](https://www.powershellgallery.com/packages/AsBuiltReport.System.Resources/)
9393

9494
### :closed_lock_with_key: Required Privileges
95-
<!-- ********** Define required privileges ********** -->
96-
<!-- ********** Try to follow best practices to define least privileges ********** -->
95+
96+
Local user privileges are required to run this report.
97+
98+
> [!IMPORTANT]
99+
> The intention of this report is to demonstrate the multi-language capabilities of the AsBuiltReport project. Therefore, this report does not require any special privileges to run.
97100
98101
## :package: Module Installation
99102

@@ -143,15 +146,16 @@ The following provides information of how to configure each schema within the re
143146
### Report
144147
The **Report** schema provides configuration of the System Resources report information.
145148

146-
| Sub-Schema | Setting | Default | Description |
147-
|---------------------|--------------|--------------------------------|--------------------------------------------------------------|
149+
| Sub-Schema | Setting | Default | Description |
150+
| ------------------- | ------------ | -------------------------------- | ------------------------------------------------------------ |
148151
| Name | User defined | System Resources As Built Report | The name of the As Built Report |
149-
| Version | User defined | 1.0 | The report version |
150-
| Status | User defined | Released | The report release status |
151-
| ShowCoverPageImage | true / false | true | Toggle to enable/disable the display of the cover page image |
152-
| ShowTableOfContents | true / false | true | Toggle to enable/disable table of contents |
153-
| ShowHeaderFooter | true / false | true | Toggle to enable/disable document headers & footers |
154-
| ShowTableCaptions | true / false | true | Toggle to enable/disable table captions/numbering |
152+
| Version | User defined | 1.0 | The report version |
153+
| Status | User defined | Released | The report release status |
154+
| Language | User defined | en-US | The language / locale of the report |
155+
| ShowCoverPageImage | true / false | true | Toggle to enable/disable the display of the cover page image |
156+
| ShowTableOfContents | true / false | true | Toggle to enable/disable table of contents |
157+
| ShowHeaderFooter | true / false | true | Toggle to enable/disable document headers & footers |
158+
| ShowTableCaptions | true / false | true | Toggle to enable/disable table captions/numbering |
155159

156160
### Options
157161
The **Options** schema allows certain options within the report to be toggled on or off.
@@ -160,19 +164,46 @@ The **Options** schema allows certain options within the report to be toggled on
160164
### InfoLevel
161165
The **InfoLevel** schema allows configuration of each section of the report at a granular level. The following sections can be set.
162166

163-
There are 6 levels (0-5) of detail granularity for each section as follows;
167+
There are 3 levels (0-2) of detail granularity for each section as follows;
168+
169+
| Setting | InfoLevel | Description |
170+
| :-----: | ----------------- | -------------------------------------------------------------------- |
171+
| 0 | Disabled | Does not collect or display any information |
172+
| 1 | Enabled / Summary | Provides summarised information for a collection of objects |
173+
| 2 | Adv Summary | Provides condensed, detailed information for a collection of objects |
164174

165-
| Setting | InfoLevel | Description |
166-
|:-------:|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
167-
| 0 | Disabled | Does not collect or display any information |
168-
| 1 | Enabled / Summary | Provides summarised information for a collection of objects |
169-
| 2 | Adv Summary | Provides condensed, detailed information for a collection of objects |
170-
| 3 | Detailed | Provides detailed information for individual objects |
171-
| 4 | Adv Detailed | Provides detailed information for individual objects, as well as information for associated objects |
172-
| 5 | Comprehensive | Provides comprehensive information for individual objects, such as advanced configuration settings |
175+
The table below outlines the default and maximum **InfoLevel** settings for each section.
176+
177+
| Sub-Schema | Default Setting | Maximum Setting |
178+
| ---------- | :-------------: | :-------------: |
179+
| Date | 1 | 2 |
180+
| TimeZone | 2 | 2 |
181+
| Uptime | 2 | 2 |
182+
| PSHost | 2 | 2 |
183+
| Process | 1 | 2 |
173184

174185
### Healthcheck
175186
The **Healthcheck** schema is used to toggle health checks on or off.
176187

188+
No health checks are currently available for this report.
189+
177190
## :computer: Examples
178-
<!-- ********** Add some examples. Use other AsBuiltReport modules as a guide. ********** -->
191+
192+
The following examples demonstrate how to generate a System Resources As Built Report.
193+
194+
Below are a few examples of running the AsBuiltReport script. Refer to the `README.md` file in the main AsBuiltReport project repository for more examples.
195+
196+
```powershell
197+
# Generate a System Resources As Built Report for 'localhost'. Export report to HTML & DOCX formats. Use default report style. Append timestamp to report filename. Save reports to 'C:\Users\Jon\Documents'
198+
PS C:\> New-AsBuiltReport -Report System.Resources -Target localhost -Username 'User' -Password 'P@ssw0rd' -Format Html,Word -OutputFolderPath 'C:\Users\Jon\Documents' -Timestamp
199+
200+
# Generate a System Resources As Built Report for 'localhost' using specified credentials and report configuration file. Export report to Text, HTML & DOCX formats. Use default report style. Save reports to 'C:\Users\Jon\Documents'. Display verbose messages to the console.
201+
PS C:\> New-AsBuiltReport -Report System.Resources -Target localhost -Username 'User' -Password 'P@ssw0rd' -Format Text,Html,Word -OutputFolderPath 'C:\Users\Jon\Documents' -ReportConfigFilePath 'C:\Users\Jon\AsBuiltReport\AsBuiltReport.System.Resources.json' -Verbose
202+
203+
# Generate a System Resources As Built Report for 'localhost' using stored credentials. Export report to HTML & Text formats. Use default report style. Highlight environment issues within the report. Save reports to 'C:\Users\Jon\Documents'.
204+
PS C:\> $Creds = Get-Credential
205+
PS C:\> New-AsBuiltReport -Report System.Resources -Target localhost -Credential $Creds -Format Html,Text -OutputFolderPath 'C:\Users\Jon\Documents' -EnableHealthCheck
206+
207+
# Generate a System Resources As Built Report for Backup Server localhost using stored credentials. Export report to HTML & DOCX formats. Use default report style. Reports are saved to the user profile folder by default. Attach and send reports via e-mail.
208+
PS C:\> New-AsBuiltReport -Report System.Resources -Target localhost -Username 'User' -Password 'P@ssw0rd' -Format Html,Word -OutputFolderPath 'C:\Users\Jon\Documents' -SendEmail
209+
```

0 commit comments

Comments
 (0)