errose28 commented on PR #10829: URL: https://github.com/apache/ozone/pull/10829#issuecomment-6302458832
Thanks @adoroszlai for the reviews. > Can you please clarify this? I don't see how Anu/Marton's design doc about design docs is replaced by a design doc about S3 versioning feature. This was a copy/paste error in the PR description. I've fixed it to point to https://github.com/apache/ozone-site/pull/188 which puts the design doc guidance in the website's developer guide. > I prefer moving design docs to the website. I am fine with either approach. To me both locations seem like workarounds for not keeping them in the same repo. I had some minor concerns with moving the design docs to the website but they all have reasonable resolutions: - Visibility of new designs. - We can help this by updating the OEP guidance to include sending an email to the dev list for new docs, which is good practice anyways. - Missing context for AI agents working on the features described in the docs - This is also an existing problem for the other docs - We often don't merge design doc PRs until the corresponding feature is merged so the doc can be updated as development progresses. This means the doc would not be available locally anyways without copying it in manually. If other reviewers (@smengcl @ChenSammi) agree I can update this PR to just remove hugo content, and raise another one moving design docs to the website. -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
