search

dataplat / docs

The documentation for dbatools module. Issues with command doc and bugs should be reported to dataplat/dbatools.
https://docs.dbatools.io
15 stars 12 forks source link

refactored UL / LI for Scantype #72

Closed fatherjack closed 1 year ago

fatherjack commented 2 years ago

changed each scantype to be outside the UL so allowed values are easily identified

niphlod commented 2 years ago

@fatherjack : these are automatically rebuilt from the inline docs, so the correct way is edit the inline help to match what you'd like. ask away if you need more details on how to do so.

fatherjack commented 2 years ago

yeah, going to need an assist with what's involved there please - having to change the layout of the inline help will break that, just to get this readable.... ?

niphlod commented 2 years ago

@fatherjack : the inline help is in markdown, and that generates the html used for the page. Markdown is human-readable so it's probably going to be more readable with your fix than the current state.

That being said if you have a local development folder with dbatools, edit the Find-DbaInstance inline help, then just import the psm1 so you can see the internal functions and as a final step

PS C:\> Get-DbaHelp Find-DbaInstance -OutputAs "MDString" | Out-File Find-DbaInstance.md
PS C:\> & code Get-DbaDatabase.md

Get-DbaHelp is the internal function that "translates" the inline help to markdown, and if you have VSCode it has the markdown viewer plugin installed, so opening the resultant .md file will display the html automatically.

niphlod commented 1 year ago

I'm closing this, ping if you need additional help