Skip to content

Commit 667b167

Browse files
authored
Recommend crd-ref-docs
1 parent b591789 commit 667b167

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ API Reference Docs [like this][ar] this tool is for you.
55

66
[ar]: https://knative.dev/docs/reference/api/serving-api/
77

8+
9+
> [!WARNING]
10+
> **This project is not super actively maintained.**
11+
> Consider using the [**crd-ref-docs** by Elastic](https://github.com/elastic/crd-ref-docs) project
12+
instead.
13+
814
## Alternatives
915

1016
This project has inspired creation of the following projects:
@@ -15,11 +21,11 @@ This project has inspired creation of the following projects:
1521
- [**crd-ref-docs** by Elastic](https://github.com/elastic/crd-ref-docs): A fresh implementation
1622
of this project.
1723

18-
Nowadays, I don't have a lot of time to maintain this tool. So consider
19-
using one of the above in case this repo does not work for you.
24+
- If you're an open source project, consider exposing your
25+
CRD API Reference via https://doc.crds.dev/ without much effort.
26+
27+
2028

21-
If you're an open source project, consider exposing your
22-
CRD API Reference via https://doc.crds.dev/ without much effort.
2329

2430

2531
## Current Users

0 commit comments

Comments
 (0)