ChenSammi commented on PR #10829:
URL: https://github.com/apache/ozone/pull/10829#issuecomment-5088684914
@errose28 , thanks for working on the documentation improvement. I have a
few questions about this proposal and try to understand the whole picture of
documentations:
1. with this patch, ozone repo only carries English version feature design
markdown content, user guide/doc and multiple language content are removed
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. 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.
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.
5. it is not feasible now to auto sync contents from ozone repo to
ozone-site repo now, right?
--
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]
