Added editing link

maester365 · Mar 15, 2024 · fa72b72 · fa72b72
1 parent cd4f2b4
commit fa72b72
Show file tree

Hide file tree

Showing 27 changed files with 68 additions and 5 deletions.
diff --git a/build/Build-CommandReference.ps1 b/build/Build-CommandReference.ps1
@@ -10,5 +10,5 @@ if (-not (Get-Module Alt3.Docusaurus.Powershell -ListAvailable)) {
 }
 Import-Module Alt3.Docusaurus.Powershell
 Import-Module PlatyPS
-New-DocusaurusHelp -Module ./src/Maester.psm1 -DocsFolder ./docs/docs -NoPlaceHolderExamples
+New-DocusaurusHelp -Module ./src/Maester.psm1 -DocsFolder ./docs/docs -NoPlaceHolderExamples -EditUrl https://github.com/maester365/maester/blob/main/src/public/
 Copy-Item ./docs/docs-templates/commands-index.md ./docs/docs/commands/index.md
diff --git a/docs/docs-templates/commands-index.md b/docs/docs-templates/commands-index.md
@@ -1,6 +1,6 @@
 ---
 id: commands
-title: Maester - Command Reference
+title: Command Reference
 sidebar_label: Command Reference
 ---
 

diff --git a/docs/docs/commands/Clear-MtGraphCache.mdx b/docs/docs/commands/Clear-MtGraphCache.mdx
@@ -3,6 +3,7 @@ id: Clear-MtGraphCache
 title: Clear-MtGraphCache
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Clear-MtGraphCache.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Export-MtHtmlReport.mdx b/docs/docs/commands/Export-MtHtmlReport.mdx
@@ -3,6 +3,7 @@ id: Export-MtHtmlReport
 title: Export-MtHtmlReport
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Export-MtHtmlReport.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Get-MtConditionalAccessPolicies.mdx b/docs/docs/commands/Get-MtConditionalAccessPolicies.mdx
@@ -3,6 +3,7 @@ id: Get-MtConditionalAccessPolicies
 title: Get-MtConditionalAccessPolicies
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Get-MtConditionalAccessPolicies.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Invoke-MtGraphRequest.mdx b/docs/docs/commands/Invoke-MtGraphRequest.mdx
@@ -3,6 +3,7 @@ id: Invoke-MtGraphRequest
 title: Invoke-MtGraphRequest
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Invoke-MtGraphRequest.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtAppManagementPolicyEnabled.mdx b/docs/docs/commands/Test-MtAppManagementPolicyEnabled.mdx
@@ -3,6 +3,7 @@ id: Test-MtAppManagementPolicyEnabled
 title: Test-MtAppManagementPolicyEnabled
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtAppManagementPolicyEnabled.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaAllAppsExists.mdx b/docs/docs/commands/Test-MtCaAllAppsExists.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaAllAppsExists
 title: Test-MtCaAllAppsExists
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaAllAppsExists.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaApplicationEnforcedRestrictions.mdx b/docs/docs/commands/Test-MtCaApplicationEnforcedRestrictions.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaApplicationEnforcedRestrictions
 title: Test-MtCaApplicationEnforcedRestrictions
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaApplicationEnforcedRestrictions.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaBlockLegacyExchangeActiveSyncAuthentication.mdx b/docs/docs/commands/Test-MtCaBlockLegacyExchangeActiveSyncAuthentication.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaBlockLegacyExchangeActiveSyncAuthentication
 title: Test-MtCaBlockLegacyExchangeActiveSyncAuthentication
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaBlockLegacyExchangeActiveSyncAuthentication.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaBlockLegacyOtherAuthentication.mdx b/docs/docs/commands/Test-MtCaBlockLegacyOtherAuthentication.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaBlockLegacyOtherAuthentication
 title: Test-MtCaBlockLegacyOtherAuthentication
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaBlockLegacyOtherAuthentication.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaBlockUnknownOrUnsupportedDevicePlatforms.mdx b/docs/docs/commands/Test-MtCaBlockUnknownOrUnsupportedDevicePlatforms.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaBlockUnknownOrUnsupportedDevicePlatforms
 title: Test-MtCaBlockUnknownOrUnsupportedDevicePlatforms
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaBlockUnknownOrUnsupportedDevicePlatforms.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaDeviceComplianceAdminsExists.mdx b/docs/docs/commands/Test-MtCaDeviceComplianceAdminsExists.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaDeviceComplianceAdminsExists
 title: Test-MtCaDeviceComplianceAdminsExists
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaDeviceComplianceAdminsExists.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaDeviceComplianceExists.mdx b/docs/docs/commands/Test-MtCaDeviceComplianceExists.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaDeviceComplianceExists
 title: Test-MtCaDeviceComplianceExists
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaDeviceComplianceExists.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaEmergencyAccessExists.mdx b/docs/docs/commands/Test-MtCaEmergencyAccessExists.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaEmergencyAccessExists
 title: Test-MtCaEmergencyAccessExists
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaEmergencyAccessExists.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaEnforceNonPersistentBrowserSession.mdx b/docs/docs/commands/Test-MtCaEnforceNonPersistentBrowserSession.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaEnforceNonPersistentBrowserSession
 title: Test-MtCaEnforceNonPersistentBrowserSession
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaEnforceNonPersistentBrowserSession.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaEnforceSignInFrequency.mdx b/docs/docs/commands/Test-MtCaEnforceSignInFrequency.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaEnforceSignInFrequency
 title: Test-MtCaEnforceSignInFrequency
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaEnforceSignInFrequency.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaExclusionForDirectorySyncAccounts.mdx b/docs/docs/commands/Test-MtCaExclusionForDirectorySyncAccounts.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaExclusionForDirectorySyncAccounts
 title: Test-MtCaExclusionForDirectorySyncAccounts
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaExclusionForDirectorySyncAccounts.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaMfaForAdminManagement.mdx b/docs/docs/commands/Test-MtCaMfaForAdminManagement.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaMfaForAdminManagement
 title: Test-MtCaMfaForAdminManagement
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaMfaForAdminManagement.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaMfaForAdmins.mdx b/docs/docs/commands/Test-MtCaMfaForAdmins.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaMfaForAdmins
 title: Test-MtCaMfaForAdmins
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaMfaForAdmins.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaMfaForAllUsers.mdx b/docs/docs/commands/Test-MtCaMfaForAllUsers.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaMfaForAllUsers
 title: Test-MtCaMfaForAllUsers
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaMfaForAllUsers.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaMfaForGuests.mdx b/docs/docs/commands/Test-MtCaMfaForGuests.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaMfaForGuests
 title: Test-MtCaMfaForGuests
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaMfaForGuests.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaMfaForRiskySignIns.mdx b/docs/docs/commands/Test-MtCaMfaForRiskySignIns.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaMfaForRiskySignIns
 title: Test-MtCaMfaForRiskySignIns
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaMfaForRiskySignIns.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaRequirePasswordChangeForHighUserRisk.mdx b/docs/docs/commands/Test-MtCaRequirePasswordChangeForHighUserRisk.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaRequirePasswordChangeForHighUserRisk
 title: Test-MtCaRequirePasswordChangeForHighUserRisk
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaRequirePasswordChangeForHighUserRisk.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/Test-MtCaSecureSecurityInfoRegistration.mdx b/docs/docs/commands/Test-MtCaSecureSecurityInfoRegistration.mdx
@@ -3,6 +3,7 @@ id: Test-MtCaSecureSecurityInfoRegistration
 title: Test-MtCaSecureSecurityInfoRegistration
 hide_title: false
 hide_table_of_contents: false
+custom_edit_url: https://github.com/maester365/maester/blob/main/src/public/Test-MtCaSecureSecurityInfoRegistration.ps1
 ---
 
 ## SYNOPSIS

diff --git a/docs/docs/commands/index.md b/docs/docs/commands/index.md
@@ -1,6 +1,6 @@
 ---
 id: commands
-title: Maester - Command Reference
+title: Command Reference
 sidebar_label: Command Reference
 ---
 
@@ -12,7 +12,7 @@ import DocCardList from '@theme/DocCardList';
 ## Overview
 This page lists the commands available in the Maester module and provides a reference of the helper methods that have been created to help you define and run tests on your Microsoft 365 cloud configuration.
 
-See the [writing Maester tests](../writing-tests.md) guide for more information on how to write your own tests using these commands.
+See the [`Writing Maester tests`](../writing-tests) guide for more information on how to write your own tests using these commands.
 
 ## Maester Commands
 <DocCardList />

diff --git a/docs/docs/contributing.md b/docs/docs/contributing.md
@@ -5,7 +5,47 @@ title: Contributing
 
 # Contributing
 
-## Developer Guide
+## Contributing to docs
+
+Simple edits can be made in the GitHub UI by clicking the 'Edit this page' at the bottom of each page or you can browse to the [docs](https://github.com/maester365/maester/tree/main/docs/docs) folder on GitHub.
+
+For more complex changes, you can fork the repository and submit a pull request.
+
+### Running documentation locally
+
+The [Maester.dev](https://maester.dev) website is built using [Docusaurus](https://docusaurus.io/).
+
+Follow the guide if you want to run the documentation locally and view changes in real-time.
+
+#### Pre-requisites
+
+[Node.js](https://nodejs.org/en/download/) version 18.0 or above (which can be checked by running node -v). When installing Node.js, you are recommended to check all checkboxes related to dependencies.
+
+#### Installation
+
+When running the documentation for the first time, you will need to install the dependencies. This can be done by running the following command in ./docs folder.
+
+```
+npm install
+```
+
+#### Starting the site
+
+While in the ./docs folder run the following command to start the site locally. This will start a local server and open the site in your default browser to http://localhost:3000/
+
+```
+npm start
+```
+
+#### Editing content
+
+You will now be able to edit add and edit markdown files in the ./docs/docs folder and see the changes in real-time in your browser.
+
+- Read the [markdown documentation](https://docusaurus.io/docs/markdown-features) for more information on some of the custom markdown features available.
+- You can search for icons at [Iconify](https://icon-sets.iconify.design/) and include them in the markdown. See the [Daily Automation](https://measter.dev/docs/automation/) page for examples.
+- The `Command Reference` section is auto-generated. To update the documentation for this, the .ps1 file for the command needs to be updated with comment-based documentation.
+
+## Maester Developer Guide
 
 ### Simple debugging