search

zowe / zowe-cli

Zowe CLI
Eclipse Public License 2.0
114 stars 86 forks source link

Broken link in published webhelp for `zowe zos-files upload dir-to-uss` #2308

Open adam-wolfe opened 1 month ago

adam-wolfe commented 1 month ago

Describe the bug

https://docs.zowe.org/stable/web_help/index.html?p=zowe_zos-files_upload_dir-to-uss contains a link that should point to https://git-scm.com/docs/gitignore#_pattern_format, but is broken by a newline.

Expected and actual results

Describe your environment

Additional context

github-actions[bot] commented 1 month ago

Thank you for creating a bug report. We will investigate the bug and evaluate its impact on the product. If you haven't already, please ensure you have provided steps to reproduce the bug and as much context as possible.

t1m0thyj commented 1 month ago

This may be caused by an issue in the markdown-it dependency: https://github.com/markdown-it/markdown-it/issues/1058

sosadchuk commented 2 weeks ago

Hi, may I add a similar issue here, or should I create a standalone item?

We have our links containing dashes escaped by the web help handler in a way they both look incorrect, and lead to 404 when following them: https://docs.zowe.org/stable/web_help/?p=zowe_dbm-db2

Reproducible in Zowe CLI 8.8.0 image

t1m0thyj commented 2 weeks ago

@sosadchuk I believe this is the same issue caused by markdown-it not parsing MD-escaped URLs correctly. Thanks for reporting it 😋 Older versions of markdown-it stripped out the backslashes but we can't downgrade as they have a security vulnerability.