Replies: 5 comments 6 replies
-
Thanks for providing the feedback, this is useful. My (personal) view -> I would avoid creating separate document for the reference guide. Already today, the books are IMHO confusing and even as a maintainer, I often struggle to know which document book to open for which content. So in my view, I would rather move the other content from the Configuration book into the Deploying book or integrate it directly into the reference guide. WDYT? As for the ToC => I guess you are using the docs version which is integrated into the website? I.e. https://strimzi.io/docs/operators/latest/configuring.html? Correct? The content there is generated by Javascript and I think at bigger depth, it is too much and it is causing issues. But maybe you can check the separate docs view (i.e. https://strimzi.io/docs/operators/latest/full/configuring.html) => you can get to it by clicking on the icon which is supposed to mean new window. That has a different format and deeper ToC. Would that help? |
Beta Was this translation helpful? Give feedback.
-
I understand your point. In my opinion, combining the contents into one document does not help the issue I guess. I would rather suggest a documentation structure like for Kubernetes itself:
Well, that would be the icing on the cake, from my point of view, this is best practice. But that would be a lot of work, so I initially suggested ideas with expectedly less work for now 😃 |
Beta Was this translation helpful? Give feedback.
-
Yes.
That's very good to know, it definetely helps a lot! Thank you 👍 |
Beta Was this translation helpful? Give feedback.
-
Could be foldable ToCs a solution? 🤔 |
Beta Was this translation helpful? Give feedback.
-
Thanks for this, actually I have similar opinion but I would not know how it would become better. It makes browsing much easier. |
Beta Was this translation helpful? Give feedback.
-
Hello folks,
I am working with Strimzi at work. When working with libraries/frameworks/etc., I am preferably using the reference documentation. In my opinion, the Strimzi CRD reference is pretty good regarding the content but I have issues/hickups while browsing through it.
I have two ideas how to improve things:
a. this improves the overwiew
a. this reduces the length of the site for visibility and improves navigation
3 votes ·
Beta Was this translation helpful? Give feedback.
All reactions