Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix GenerateDocs Issue for Pwsh Cmdlets #169

Merged
merged 1 commit into from
Jan 13, 2025

Conversation

lokirubrik
Copy link
Contributor

Summary:

Initial Generated markdown

Note: It includes 13 spaces in the
beginning of the codeblock and
includes tab
image

Markdown Format Issues

  • PlatyPS don't allow tabs in
    markdown, also mentioned here
    • Replacing tab with 4 or 6 spaces is
      working fine but giving issue with
      2 spaces.
  • More than 12 leading spaces in a line is creating issue
    • Original Code includes 13 spaces in the beginning.
    • Tried with 12 and less (succeeding)
    • Tried With 13 and 14 (failing)

Fix Done:

Replaced tabs with 4 spaces and removed
the first leading space from each line.

Generated markdown post fix

image

Test Plan:

DotNet Build succeeded with successful
docs generation.
image

JIRA Issues:

SPARK-410830

Revert Plan:

NA

Summary:
Fixed GenerateDocs by replacing tab with 4
spaces and keeping removing the leading space
character.

Seems like it's only accepting spaces (not tab)
and that too in multiple of 4, since with extra
leading space, it was failing.

Test Plan:
Ran the `GenerateDocs.ps1` script and
verified that the issue is fixed.

JIRA Issues:
SPARK-410830

Revert Plan:
NA
@guirava guirava merged commit 072996d into rubrikinc:devel Jan 13, 2025
1 check passed
guirava added a commit that referenced this pull request Jan 17, 2025
Schema Update:

See [API Changelog](https://rubrikinc.github.io/rubrik-api-documentation/changelog/changes/)
for API additions, deprecations and breaking changes.

New Features:

- `Get-RscType` now has auto-completion for `-Name` parameter.

Fixes:

- E2E test fixes
  [#171](#171)
  [#170](#170)
- Generated documentation fixes
  [#169](#169)
- Fix `Get-RscSla` when using `-id`
  [#168](#168)
- Fix `Get-RscMssqlInstance` fields to account for API changes
  [#167](#167)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants