The future of doc.crds.dev

[hasheddan]

Hey folks! I built doc.crds.dev on a weekend a few years ago and it turned out to be fairly useful to a number of folks, particularly in the @crossplane community. Much of the Crossplane community has now moved to using https://marketplace.upbound.io, as it offers features that are more tailored to Crossplane packages, while doc.crds.dev focuses on just serving documentation for Custom Resource Definitions. That being said, as can be observed from analytics, there are still folks that use the site outside of the Crossplane community.

There have been a number of feature requests for this project that have been largely neglected -- namely private repo support, "do not index" files, schema diffs, and more. There have also been "quality of life" improvements that I have failed to address (e.g. contribution guidelines, runbooks, better deployment manifests, etc), and the general architecture of the project reflects that it was, well, built on a weekend 😅.

All of that being said, I am going to need to make some infrastructure changes to the site in the coming days / weeks, which is causing me to consider the future of the project. If folks are still finding it useful, I would like to take steps to refine the project, implement some of the requested features, and make it possible for folks to run themselves. If not, I will likely spin down the project and others can continue working on their own forks.

Ask

My ask for this (albeit small) community is to weigh in on how useful this project is for you and your organization. You may do so on this issue with the following emojis (you may add multiple if appropriate). If you would like to provide more context, please feel free to add a comment.

👍🏻 : I find this project useful. 👎🏻 : I do not find this project useful. 💾 : I run this on my own infrastructure. ☁️ : I depend on the hosted instance (doc.crds.dev) 💰 : I or my organization are willing to sponsor work on this project via donations or infrastructure.

Ultimately, the direction of this project will depend on my bandwidth, but I would love to get some feedback from folks to get a sense of if it is worth my time compared to many other competing priorities.

[haarchri]

btw we running a fork because of private gitlab repo support ;) https://github.com/dkb-bank/sopdocs we are happy to bring this in as a contribution here

[duizabojul]

Is it possible to run this project in a cluster and "discover" crds?

[hasheddan]

@duizabojul not currently, but that would be an awesome feature to add!

[rashedkvm]

This is a great gift from you to the community @hasheddan. Love it man. I use the hosted version doc.crds.dev. I would like to learn if there is a way to self-host it. Thank you again 🙏.

🙌

[mtougeron]

fwiw, I love doc.crds.dev. I use it frequently (many times a week) for CRDs totally unrelated to crossplane.

[erikgb]

I second all the positive comments above (👍) and would love to see this project continued! We currently depend on the hosted instance (☁️) in https://github.com/statnett/image-scanner-operator, and would probably attempt to spin up a self-hosted instance to serve docs for our internal operators. ❤️‍🔥 There are some missing features we would like to see, and we could be interested in contributing them 😃

[fabriziopandini]

We are linking crd.dev from the Cluster API book and we find it pretty useful! kudos to everyone working on this project

[sbueringer]

100% agree with all of the above. Super useful tool!!

[intelfx]

I just found this tool and immediately fell in love with it :-) Whatever is the decision, thank you.

I wonder, is there something like it but for built-in Kubernetes resources?

[Sijoma]

I would also love to see a continuation of the tool. Especially with private git support or static files.

[Duologic]

https://github.com/jsonnet-libs/k8s has been depending on this project for a while, we regularly see 'No CRDs discovered' and 502 errors on the /raw/.