...
draw.io Diagram | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Versioning docs
The release-specific documentation (release docs) should evolve with the code changes. Thus, maintaining the docs regarding design, implementation details and API examples on master under /docs would make things easier. In this way, the code and the corresponding docs change can coexist in the same PR. Specific pages around these include:
- Quickstart
- Concepts
- Writing Data
- Querying Data
- Configuration
- Performance
- Administering
In addition to these docscontent, a new set of API docs will be generated by javadoc for each release (similar to this).
Content regarding the general information of Hudi should remain in asf-site branch (site docs):
- Use Cases
- Talks & Powered By
- Comparison
- Releases
- Community
- Code
- Developers
- Feedback
The release -specific docs on master and general content site docs in asf-site are generated separately. The generated web pages are then uploaded to the hosting server for the Hudi site. The landing page references the specific version of docs content through links.
...