So, this can also be implemented as a list of refs to not resolve; Any unresolved ref is included in the objects list.
So, depending on how a package is implemented, it might directly include/import some object definition, such as PodTemplate. As a result, the API reference documentation will include this, but actually it's already available elsewhere. And it's huge.
Instead, with an alias, it should be possible to link to the alias, sort of like a symlink. This will make the documentation actually readable for some of the APIs, such as for Prometheus objects.
While this can possibly be done globally, there's some risk that not every project uses the same property name for the same child object, so it needs to be defined in the configuration on a per-API basis for safety.
This is a moderate effort epic.
So, this can also be implemented as a list of refs to not resolve; Any unresolved ref is included in the objects list.
So, depending on how a package is implemented, it might directly include/import some object definition, such as
PodTemplate. As a result, the API reference documentation will include this, but actually it's already available elsewhere. And it's huge.Instead, with an alias, it should be possible to link to the alias, sort of like a symlink. This will make the documentation actually readable for some of the APIs, such as for Prometheus objects.
While this can possibly be done globally, there's some risk that not every project uses the same property name for the same child object, so it needs to be defined in the configuration on a per-API basis for safety.
This is a moderate effort epic.