errose28 commented on PR #10829: URL: https://github.com/apache/ozone/pull/10829#issuecomment-5095626222
Thanks Sammi for reviewing. > 1. with this patch, ozone repo only carries English version feature design markdown content, user guide/doc and multiple language content are removed No content is removed as stated by the first line in the PR description: > Pre-built rendered docs from the old site are still accessible at https://ozone.apache.org/docs/2.0.0, no change in availability to users. All that changes is this content is not tracked and built within the Ozone repo for new versions, which makes sense because the content here is stale regardless of language. Multi-language support will need to be handled on the new website for all current content anyways. > 2. new web-site will host feature design, user guide/doc, and multiple language support(if needed) > 3. for future feature development under a feature branch shall they submit the design doc to both ozone and ozone-repo in the same time, or submit the design doc to ozone first, then ozone-repo after feature branch is merge. This PR still leaves design docs in this repo. They were not published to the new website so no change in availability after this PR. It's tricky to get these into the new website with our current two repo layout. However content can be added as pages under the "System Internals" section of the website, where they will also be versioned as the implementation changes. All other content you mentioned are in the ozone-site repo. > What about user doc, only ozone-site host user doc, right? But consider feature branch development is in progress, both the design and user guide can be changed later, will it be too early to make the feature design and doc published on ozone web UI to be reached by the public. Yes this is also a complication with having the website in a separate repo, and is definitely a reason we could consider combing the repos in the future. If it was in the same repo the feature branch could host both the code and docs simultaneously. Technically when a docs change is merged into the website it lives under the "next" version which is documented as unreleased, but even then if a release is cut before the feature branch is merged the docs will go out incorrectly. I think with the current layout the workflow would be to raise the feature branch docs PR to the website repo whenever it is ready and keep it open until the feature branch is merged. > 4. will the docs of ozone-site be released together with ozone repo release, so every ozone release will have the same version docs? for docs could be changed over time, especially user docs, some might get deprecated, some might have new contents. Yes, the new website has versioning enabled, you can see this in the top left corner of the docs section of the website and the release manager guide has instructions to cut a new release for the docs too. > 5. it is not feasible now to auto sync contents from ozone repo to ozone-site repo now, right? For just the purposes of putting the docs in the release to host from the Web UI, it might be doable at build time but I haven't investigated. If we want to do this I would be more inclined to actually keep the entire Ozone website in the main Ozone repo though. -- 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]
