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

Prevent circular references in included documentation structures #94

Closed
g-pavlov opened this issue Nov 7, 2020 · 0 comments · Fixed by #108
Closed

Prevent circular references in included documentation structures #94

g-pavlov opened this issue Nov 7, 2020 · 0 comments · Fixed by #108
Assignees
Labels
effort/2m Effort for issue is around 2 months kind/enhancement Enhancement, improvement, extension priority/3 Priority (lower number equals higher priority)

Comments

@g-pavlov
Copy link
Contributor

g-pavlov commented Nov 7, 2020

What would you like to be added:
#87 adds support for including a documentation structure into another documentations structure. Moreover, this can go on recursively. However, it is necessary to address a situation with possible circular inclusions and yield error an error.

Why is this needed / describe a real-world scenario:

Manifest A declares:

nodesSelector:
  path: manifestB

Manifest B declares:

nodesSelector:
  path: manifestA

and this cannot be resolved into a meaningful structure.

How to categorize this?:
/kind enhancement
/priority normal

@g-pavlov g-pavlov added the kind/enhancement Enhancement, improvement, extension label Nov 7, 2020
@swilen-iwanow swilen-iwanow added the size/l Size of pull request is large (see gardener-robot robot/bots/size.py) label Nov 16, 2020
@swilen-iwanow swilen-iwanow linked a pull request Nov 17, 2020 that will close this issue
@gardener-robot gardener-robot added priority/3 Priority (lower number equals higher priority) effort/2m Effort for issue is around 2 months and removed priority/normal size/l Size of pull request is large (see gardener-robot robot/bots/size.py) labels Mar 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort/2m Effort for issue is around 2 months kind/enhancement Enhancement, improvement, extension priority/3 Priority (lower number equals higher priority)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants