Skip to content

Commit

Permalink
Capitalize list items and fix RequiredModules GA (#119) [release]
Browse files Browse the repository at this point in the history
* Capitalize list items

* Fix GA path to RequiredModules.psd1

* Use backslashes as GA path separator

* Fix GA artificact upload for RequiredModules.psd1
  • Loading branch information
bravo-kernel authored Jun 25, 2022
1 parent 1be258b commit 4626205
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 27 deletions.
9 changes: 7 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ jobs:

- name: Install-RequiredModules
uses: PoshCode/Actions/install-requiredmodules@v1
with:
requiredModules-path: ${{github.workspace}}/Dev/RequiredModules.psd1

- name: Build Module
id: build
Expand All @@ -57,7 +59,7 @@ jobs:
uses: actions/upload-artifact@v2
with:
name: RequiredModules
path: ${{github.workspace}}/RequiredModules.psd1
path: ${{github.workspace}}/Dev/RequiredModules.psd1

- name: Upload PSScriptAnalyzerSettings.psd1
uses: actions/upload-artifact@v2
Expand Down Expand Up @@ -91,7 +93,10 @@ jobs:
- name: Download Build Output
uses: actions/download-artifact@v2

- uses: PoshCode/Actions/install-requiredmodules@v1
- name: Install-RequiredModules
uses: PoshCode/Actions/install-requiredmodules@v1
with:
requiredModules-path: ${{github.workspace}}/Dev/RequiredModules.psd1

- uses: PoshCode/Actions/pester@v1
with:
Expand Down
4 changes: 2 additions & 2 deletions website/docs/faq/monolithic-modules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ title: Monolithic Modules

PowerShell Modules come in two forms:

- **monolithic**, where a single `.psm1` source file contains all module functions
- **non-monolithic**, where each module function is contained in a dedicated `.ps1` source file
- **Monolithic**, where a single `.psm1` source file contains all module functions
- **Non-monolithic**, where each module function is contained in a dedicated `.ps1` source file

By default, Docusaurus.PowerShell assumes that you are documenting a non-monolithic module and
will therefore generate `Edit this page` URLs pointing to individual `.ps1` source files.
Expand Down
14 changes: 7 additions & 7 deletions website/docs/faq/multi-line-examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ sidebar_label: Multi-Line Examples

PowerShell's Comment Based Help was originally designed for `.EXAMPLE` nodes containing:

- (only) a **single-line command**
- followed by the command's output and/or a description
- Only a **single-line** example
- Followed by the command's output and/or a description

```
.EXAMPLE
Expand Down Expand Up @@ -75,8 +75,8 @@ it only supports a single use-case as can be seen in this example:
You could consider using PS7 multi-lines instead of Code Fence Detection if:
- you will (only) use PowerShell 7 to generate your documentation
- your example code does not contain any empty lines
- You will (only) use PowerShell 7 to generate your documentation
- Your example code does not contain any empty lines
> Do not use native PS7 multi-lines if you intend to generate/test documentation using other PowerShell versions!
Expand All @@ -87,9 +87,9 @@ if code fencing is not detected.
This is intentional behavior and is done because:
- it would be impossible to "guess" where the code ends and the description begins
- we can redirect (and fix) bugs in the right place (PlatyPS repository)
- it will automatically support the multi-line examples that ships with PowerShell 7
- It would be impossible to "guess" where the code ends and the description begins
- We can redirect (and fix) bugs in the right place (PlatyPS repository)
- It will automatically support the multi-line examples that ships with PowerShell 7
## Unexpected Results
Expand Down
4 changes: 2 additions & 2 deletions website/docs/faq/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ However, by default, the Docusaurus searchbar will not be available for your web

To enable search:

1. [apply for the Algolia DocSearch service](https://community.algolia.com/docsearch/)
2. [update your Docusaurus configuration file](https://docusaurus.io/docs/search/#connecting-algolia)
1. [Apply for the Algolia DocSearch service](https://community.algolia.com/docsearch/)
2. [Update your Docusaurus configuration file](https://docusaurus.io/docs/search/#connecting-algolia)
14 changes: 7 additions & 7 deletions website/docs/faq/vendor-agnostic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ description: If you do not want to use Docusaurus, the Alt.Docusaurus.PowerShell

No matter how much we :heart: Docusaurus, we realize it will not be the right solution for everyone as users might:

- prefer different (non-javascript) languages
- need to maintain an existing solution
- simply not like the green lizard
- Prefer different (non-javascript) languages
- Need to maintain an existing solution
- Simply not like the green lizard

## TL;DR

Expand All @@ -23,16 +23,16 @@ New-DocusaurusHelp -Module "YourModule" -VendorAgnostic
By passing the `-VendorAgnostic` switch parameter this module will generate the exact same
markdown as always but will skip two Docusaurs-specific steps during the process:

1. front matter
1. Front matter
2. Docusaurus sidebar file

### Front Matter

The PlatyPS generated markdown front matter:

- will not be touched
- will need to updated/replaced (by you) to fit your needs
- will look similar to the example below
- Will not be touched
- Will need to updated/replaced (by you) to fit your needs
- Will look similar to the example below

```yml
---
Expand Down
14 changes: 7 additions & 7 deletions website/docs/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ to worry about frontend development and maintenance, all handled by the Docusaur

Some of the features you will get:

- a website for promoting your module
- auto-generated Get-Help documentation
- support for complex multi-line Get-Help code examples
- authoring pages in both Markdown and PowerShell source files
- localization, versioning and fully indexed (Algolia) search
- simplified publishing (Netlify, Github Pages)
- dark mode
- Website for promoting your module
- Auto-generated Get-Help documentation
- Support for complex multi-line Get-Help code examples
- Authoring pages in both Markdown and PowerShell source files
- Localization, versioning and fully indexed (Algolia) search
- Simplified publishing (Netlify, Github Pages, etc.)
- Dark mode

## :fire: Vendor Agnostic

Expand Down

0 comments on commit 4626205

Please sign in to comment.