docs(docs): adds links to content related to drain cleaner and access operator

[PaulRMellor]

Documentation page

Adds links to the Documentation page for content related to the Drain Cleaner and Access Operator

• Typo/minor fix
• New blog post (see the README for the process)
• Other

[im-konge]

I think we have 0.1.1 released

[scholzj]

We do have 0.1.1 out. But the Operator 0.45 docs and installation file have 0.1.0 in them as this is something we update only with next Operator release. So I guess this is a bit confusing 🤔. Not sure what is the best approach here. Should we have the link without mentioning any exact version and have the exact version in downloads?

[im-konge]

Yeah sorry, I didn't realize that we have the 0.1.0 in the installation files 🙂
But as you mentioned, I would maybe keep it without the version. For Bridge, we have a separate section just for it, right? That's why it's okay to keep the version there, even if the version is not part of the Operators.

[katheris]

I understand that Bridge can run against any Kafka, so it makes sense to me that it would have it's own link. I would propose a different approach. What if instead of adding links to Drain Cleaner and Access Operator here, which are only useful if you are using the Cluster Operator, we made them more prominent in the Cluster Operator docs pages. So e.g. mention them specifically in the overview and look at how they can be more easily found in the deploying and upgrading page?

[ppatierno]

Yes, the bridge can run against any Kafka and it's not relegated to Kubernetes but also bare metal and VMs so it deserves its own link imho. Regarding drain cleaner and access operator, finding a way to highlight them in the doc is not that simple, because they could be easily lost but maybe it's a good approach.

[PaulRMellor]

Thanks. I do think we should say something on this page rather than expect the visitor to find the related content by accident scrolling through the docs (as was observed in the issue). But rather than providing the doc links for the Drain Cleaner and the Access Operator, we could add some context for using the docs generally. Something like this:

Strimzi provides operators to deploy and manage Kafka. Use the Cluster Operator for Kafka cluster lifecycle management, and the Topic Operator and User Operator to manage Kafka topics and users. If you're running the Cluster Operator, you can also use the Access Operator to configure client connections and the Drain Cleaner to assist with pod evictions. You'll find descriptions of the operators in the Overview and instructions on how to deploy and use the operators in the Deploying and Upgrading guide.

Strimzi also provides the Kafka Bridge, which offers a RESTful interface for producing and consuming messages in Kafka. You can learn more about the Bridge in the Overview and find deployment instructions in the Kafka Bridge documentation.

[ppatierno]

Where would you add this piece?

[PaulRMellor]

On the Documentation page. Above the guide links.

[PaulRMellor]

In the last commit, I added an introduction to the Documentation page that introduces the operators and describes where to find information on them. I've made a couple more changes too:

• Replaced the white text on blue background with dark text on white background for accessibility reasons.
• Updated the titles for the deploying guide from version 0.28, as it's been Deploying and Managing since then.
• Consolidated the content for the doc page into a single file
• Made the font colour for the doc headings consistent.

@katheris -- To support the new introduction, I'll look to make the available operators more obvious in the Overview too.

[katheris]

I like the new paragraph explaining about the different operators.

I think if we are going to add the drain cleaner and access operator as links here we should also include the topic and user operators.

Also the access operator docs seem to be under the "Managing TLS certificates" section, I think it should be a separate section

[PaulRMellor]

I like the new paragraph explaining about the different operators.

I think if we are going to add the drain cleaner and access operator as links here we should also include the topic and user operators.

Also the access operator docs seem to be under the "Managing TLS certificates" section, I think it should be a separate section

Thanks @katheris. The links weren't meant to be there. I didn't push up the cleaned-up version. So now we have the intro that describes the operators available and where to find information on them. If that's enough for this page, I'll update the Overview to have a specific section for each one. And we can move Access Operator section in Deploying guide to its own section

[scholzj]

You should not rename the documentation to different name than it has in the release. It should use the same name as the documentation has. The Deploying and Managing name is used only from Strimzi 0.34.0 on.

[PaulRMellor]

You should not rename the documentation to different name than it has in the release. It should use the same name as the documentation has. The Deploying and Managing name is used only from Strimzi 0.34.0 on.

I can change that. We dropped the Using Guide at 0.27.1. I thought it made sense to switch the name at 0.28

[scholzj]

You should not rename the documentation to different name than it has in the release. It should use the same name as the documentation has. The Deploying and Managing name is used only from Strimzi 0.34.0 on.

I can change that. We dropped the Using Guide at 0.27.1. I thought it made sense to switch the name at 0.28

I guess we called it Deploying and Upgrading in between. The docs are under that name in the release files as well. So I think we should keep the matching name to avoid any confusion.