niphlod
commented
3 years ago thanks @MarkIannucci for spotting this. We're working to have an easier way to generate what the help will look like without spending too much time. If you're interested in the "current way" this is the crash course. Basically ....
- be in "developer mode", e.g. make sure there's a
.gitfolder where you're going to make the edits - edit the inline help of the function
- reload the module with
Import-Module dbatools -Force Find-DbaCommand -Rebuildspits out a newdbatools-index.jsonin thebinfolder- download sqlcollaborative/docs repo (master branch) and host it in some webserver (static hosting is all you need, so whatever works, from iis to caddy to ... everything). Overwrite
assets\dbatools-index.jsonwith the one generated in the previous step - open index.html. it'll do the same thing of docs.dbatools.io
done.
potatoqualitee
Report
Long powershell commands get truncated when rendered on the dbatools.io documentation website:
Example from Write-DbaDataTable:
In the code we're OK:
https://github.com/sqlcollaborative/dbatools/blob/1640c64014ec5546eaa10396d7d5149993557339/functions/Write-DbaDbTableData.ps1#L109-L115
I'm happy to submit a PR to add a line break, but I'm not sure how I can validate that my addition of a backtick and line feed on line 113 will be rendered by the utility which renders our powershell inline help.