search

oVirt / ovirt-engine-api-model

oVirt Engine API Model
19 stars 33 forks source link

Obsolete internal link format prevents migrating downstream API to Jupiter #27

Closed apinnick closed 2 years ago

apinnick commented 2 years ago

The REST API is published downstream as part of RHV docs.

In 2022 (Q3, Q4?), all downstream Red Hat documentation is migrating to a new platform called "Jupiter". Jupiter does not support the cross-references (internal links) that the REST API model uses (example: "See, for example, the <<types/cluster, Cluster>> reference for a complete list of attributes." in Quick Start Examples.

These internal links must be updated to this format: "xref:link/path[Link text]." Note that "empty" xrefs ("xref:link[]") are not supported. The xref must contain a link text. For details, see Jupiter source files readiness checklist.

There are over 4000 occurrences of these cross-references in the REST API model, so updating them cannot be done manually by the RHV technical writers.

apinnick commented 2 years ago

Closing this issue because I can do it myself.