xintongsong commented on PR #214: URL: https://github.com/apache/flink-agents/pull/214#issuecomment-3332968292
I personally think that a "how to" pattern might be more user friendly. Actually, I think it's more important to make the titles as clear as possible than keeping them concise, so that people won't need to click into the page to find out the content is not what they are looking for. In addition, the "how to" pattern reminds us to write and organize the documentation from the user perspective rather than project developer perspective. For your concerns: - I would not be worried about aligning with other Flink ecosystem projects. Just don't see any benefit for keeping them aligned. - For the conciseness, I agree we'd better avoid too long titles, but maybe not necessarily single-word. If you look at Flink's documentation, there are also titles like "Fine-Grained Resource Management" , "Recovery job progress from job master failures" and "Building Flink from Source", and they display perfectly on mobile devices with a slide-in navigation bar. But I do I agree with you that it doesn't seem right to include "Monitoring" into "How to Run an Agent". Maybe we can replace "Run" with something like "Operate" or "Maintain"? -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
