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 decision that was taken. 2. We can integrate the same repository as a part of the new website as well for easier access to the documentation 3. We do not need to write new docs every time, but rather we can raise new PRs for changes to existing docs if required
I do want to point out that while writing markdown might be more time consuming than a simple document - in the long run, as Ozone is a very active and fast evolving product, I truly believe this will be good to have and maintain. Reference repositories: - TypeScript/ECMAScript proposals repo: https://github.com/tc39/proposals - React Proposals: https://github.com/reactjs/rfcs Here <https://github.com/reactjs/rfcs/pull/262> is a reference PR on the React repository that was raised to add a new hook - this gives an idea of how they vote and decide on new features to add. Thanks. On Sat, 15 Mar 2025 at 03:45, Wei-Chiu Chuang <weic...@apache.org> wrote: > 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 be reviewed. > > How about adding them to Pull Requests or add a new GitHub Discussions > thread? > > Here's a list of recent design docs that I just noticed (and they are great > reads!) > Feel free to add more if I missed anything: > > Ozone Cross-Region Bucket Replication > Author: Ivan Andika (ivand...@apache.org) > https://docs.google.com/document/d/1URBcxKgqYWFpDSZBn5UOfR1bUQsEkeyr/edit > > S3 Object LifeCycle Management - Object Expiration > Author: Mohanad Elsafty, Xi Chen, Ivan Andika > > https://docs.google.com/document/d/1LDE7jnhPJ_fc--zEob48RmqDxcqrDgOv3E3NBInoC08/edit?tab=t.0 > > Improve failure handling during Ratis Pipeline/Container closure > Author: Nanda > > https://docs.google.com/document/d/1fHE3tudRfqIc7egbuvnd-lZ3Qa-jhDWIZpQ89sOiIYU/edit?tab=t.0#heading=h.t8png36sbu3e > > Improve RocksDB compaction in Ozone > Author: Weichiu > > https://docs.google.com/document/d/1v9aE9aHPryTFRbJPDO4ECtbimkDv24RdAQ_i4sw0pxI/edit?tab=t.0 >
