[GitHub] [pulsar] Anonymitaet commented on issue #17433: [Doc] Cluster-level failover shouldn't be part of Java client chapter

[GitBox <gi...@apache.org>]

Anonymitaet commented on issue #17433:
URL: https://github.com/apache/pulsar/issues/17433#issuecomment-1236508492

   @labuladong thanks for raising this up! That’s a good point!
   
   Just my two cents:
   
   ☘️☘️☘️ **1. Content mapping**
   
   [Pulsar doc IA](https://docs.google.com/spreadsheets/d/1Zl7OUlh4McGOgkeePWP46HqMDEyG5GF8k0B3C5D5T7w/edit#gid=958558547) in being redesigned. Specific guides are being created for different roles:
   
   - Beginners
   - Developers
   - Operators
   - Contributors
   
   Should the [existing content of cluster-level failover](https://pulsar.apache.org/docs/next/client-libraries-java/#cluster-level-failover) be split for operators and developers? See the table below.
   
   ☘️☘️☘️ **2. Content audit**
   
   2.1 Instead of consolidating all content into the Java client guide (current situation), consider:
   - Move `concept` and `reference` content to other places (make them independent topics + see 2.2)
   - Keep "task-Java-related" content in Java client docs
   
   Current content | Category| Changes to be made| Primary audience
   ---|---|---|---|
   [Concept of cluster-leve failover](https://pulsar.apache.org/docs/next/client-libraries-java/#concept-of-cluster-level-failover)l  | Concept | Move | Operator
   [Why use cluster-level failover?](https://pulsar.apache.org/docs/next/client-libraries-java/#why-use-cluster-level-failover)|Refrerence | Move | Operator
   [When to use cluster-level failover?](https://pulsar.apache.org/docs/next/client-libraries-java/#when-to-use-cluster-level-failover) | Reference | Move | Operator
   [When cluster-level failover is triggered?](https://pulsar.apache.org/docs/next/client-libraries-java/#when-cluster-level-failover-is-triggered) | Reference |Move | Operator
   [Why does cluster-level failover fail?](https://pulsar.apache.org/docs/next/client-libraries-java/#why-does-cluster-level-failover-fail) | Reference |Move | Operator
   [What are the limitations of cluster-level failover?](https://pulsar.apache.org/docs/next/client-libraries-java/#what-are-the-limitations-of-cluster-level-failover) | Reference |Move | Operator
   [What are the relationships between cluster-level failover and geo-replication?](https://pulsar.apache.org/docs/next/client-libraries-java/#what-are-the-limitations-of-cluster-level-failover) | Reference |Move | Operator
   [How to use cluster-level failover ](https://pulsar.apache.org/docs/next/client-libraries-java/#how-to-use-cluster-level-failover) | Task | Keep it in Java client guide | Operator
   [How does cluster-level failover work?](https://pulsar.apache.org/docs/next/client-libraries-java/#how-to-use-cluster-level-failover)| Reference |Move | Developer? <br><br> Unsure about this since this part seems not quite "deeply technical"? Should operators be the primary audience?
   
   
   2.2 `cluster-level failover` belongs to `fault tolerance`:
   - Should we create an independent guide called `fault tolerance` and locate `cluster-level failover` there?
   - Are there any other missing content that should be added to the `Pulsar fault tolerance` guide?
   
   🔹🔹🔹
   
   Thoughts?  @D-2-Ed @DaveDuggins @momo-jun @hangc0276 Thank you!
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org