Re: [DISCUSS] An easier way to discover design docs

2025-03-17 Thread Wei-Chiu Chuang
I've seen other projects following a more formal process to propose change -- Kafka's got KIP (Kafka Improvement Proposal), YuniKorn's got YIP, Spark: SPIP, Pulsar: PIP, RocketMQ: RIP, and I think it makes sense. Having design docs in Markdown format isn't a barrier. There are tools to convert Go

Re: [DISCUSS] An easier way to discover design docs

2025-03-15 Thread Abhishek Pal
Thanks Attila for your input. While this has been there - I am not sure if it is being actively followed. I think it might be better in such a case, to enforce checks for design changes so that devs mandatorily update design docs as part of such PRs. Thanks On Sat, 15 Mar 2025 at 23:43, Attila D

Re: [DISCUSS] An easier way to discover design docs

2025-03-15 Thread Attila Doroszlai
Hi Wei-Chiu, Abishek, We had this process [1] for a few years now that design docs should be created as markdown in hadoop-hdds/docs/content/design via pull request (some examples at [2]). Rendered versions are available on the website [3]. [1] https://ozone.apache.org/docs/edge/design/ozone-enh

Re: [DISCUSS] An easier way to discover design docs

2025-03-15 Thread Abhishek Pal
Thank you for starting this discussion. I actually had a proposal for this scenario. For large projects like Typescript and React which are always changing, they maintain a separate repository for tracking design documents. This is really useful in: 1. A single place for tracking every design deci

[DISCUSS] An easier way to discover design docs

2025-03-14 Thread Wei-Chiu Chuang
Hi community, We have a habit of attaching design docs to the jira. While it's convenient, I find it nearly impossible to discover someone posting design docs. We create nearly 200 jiras per month on average, so unless someone tags me in the jira, I wouldn't notice there's a design doc waiting to