alnzng commented on PR #214:
URL: https://github.com/apache/flink-agents/pull/214#issuecomment-3332561226

   Thanks for your feedback @xintongsong! (Not sure if this was already 
discussed elsewhere)
   
   My primary concern is maintaining consistency within the Flink ecosystem. 
After reviewing the documentation sites for [Flink main 
project](https://nightlies.apache.org/flink/flink-docs-lts/), [Flink Kubernetes 
Operator](https://nightlies.apache.org/flink/flink-kubernetes-operator-docs-main/),
 [Flink ML](https://nightlies.apache.org/flink/flink-ml-docs-stable/), and 
other Flink subprojects, they all consistently use concise, single-word menu 
titles rather than the "How to..." pattern.
   
   From a semantic perspective, "How to Build an Agent" maps to **Development** 
and "How to Run an Agent" maps to **Deployment**. The current structure has 
some issues: we include "Monitoring" content under "How to Run an Agent," which 
doesn't seem like the right fit.
   
   The single-word terminology offers several advantages:
     1. **Ecosystem consistency** - aligns with established Flink project 
conventions
     2. **Conciseness** - provides cleaner navigation, especially on 
mobile/narrow screens
   
   I personally think using the established Flink ecosystem terminology 
(**Development**, **Deployment**, and **Operations**) would be the better 
approach. What are your thoughts on aligning with the broader Flink 
documentation standards?
   


-- 
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: issues-unsubscr...@flink.apache.org

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

Reply via email to