Fix incorrect markdown parsing in API references (#8063)

Browse Source

In the upstream code base, there are cases where the field description
string contain substrings like '*', 'pods/*', '*/scale' and '*/*'.
When generating reference docs out of these Go comments, the Node.js
module used was incorrectly passing the asterisks as '<em>', i.e. a
mark for emphasize. This behavior has rendered the output documentation
very misleading. For example, in the definition for RuleWithOperations,
users can specify '*' as a wildcard for matching all apiGroups, all
resources. However, the generated docs is showing that an empty string
'' is used to match all apiGroups or resources. This is a serious bug
fixed by this PR.

Doc generator patch is included in PR to
kubernetes-incubator/reference-docs.

pull/8121/head

Qiming 2018-04-18 04:52:00 +08:00 committed by k8s-ci-robot

parent ce74fdefe3

commit ab1fbb2414

1 changed files with 328 additions and 328 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Show Stats Download Patch File Download Diff File Expand all files Collapse all files

656

docs/reference/generated/kubernetes-api/v1.10/index.html

View File

File diff suppressed because it is too large Load Diff