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

Duplicate entries in list #64

Open
prasek opened this issue May 29, 2020 · 5 comments
Open

Duplicate entries in list #64

prasek opened this issue May 29, 2020 · 5 comments

Comments

@prasek
Copy link
Contributor

prasek commented May 29, 2020

image

@hasheddan
Copy link
Member

@prasek this is due to the CRD being present in the repo multiple times, which is fairly common unfortunately. It is impossible to make a generalization about which entry is the source of truth, but I have been thinking about adding the ability to have an optional doc.crds file in the root of a directory that lists the paths to include while parsing. Do you have any thoughts on this solution?

@mcristina422
Copy link

I don't think it makes sense to add a file to the src repos. It will just add clutter and add maintenance on the devs managing those repos. If a source of truth is needed I think that should be defined in the doc configuration when adding a new repo

@hasheddan
Copy link
Member

@mcristina422 that is unfortunately not a viable long term solution as the end goal is for repos not to be manually added, but automatically indexed when someone searches for them. In addition, the maintainers of a repo are much more knowledgeable about what the source of truth is rather than a 3rd party. Given that it would be optional and folks would only need to add it if they wanted a better experience for their users, I would not be too worried about it cluttering a repo.

@mcristina422
Copy link

Agreed, maybe a dot file then? .doc.crds

This was referenced Jul 2, 2020
@hasheddan
Copy link
Member

@prasek this has been fixed and is live on https://doc.crds.dev :)

I am going to keep this issue open because the fix does not account for choosing a specific entry as the source of truth, it simply uses the last parsed. In the case of Crossplane, this works out okay because all of the representations are the same 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants