Comments (5)
@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.
from doc.
@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?
from doc.
Agreed, maybe a dot file then? .doc.crds
from doc.
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
from doc.
@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
from doc.
Related Issues (20)
- Title bar has incorrect GVK format on CRD pages
- CRD fields are not selectable HOT 6
- Add ability to link with query on repo pages
- Most used repos on home page
- frontend: TypeError: can't convert null to object
- gateway-api seems to be misdetected HOT 1
- Improve Yaml Parsing & CRD Selection HOT 5
- Build crossplane configuration package
- Update README with project information HOT 3
- Add opentelemetry instrumentation
- upbound/platform-ref-aws broken HOT 2
- CRD not found HOT 1
- Some valid CRDs are not rendered HOT 5
- actions-runner-controller detected but unable to render HOT 1
- Repos forever unindexed HOT 1
- Proposal improvement to UI
- Crds not rendered HOT 3
- The page is broken HOT 2
- Add version diffs
- The future of doc.crds.dev HOT 10
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from doc.