apache
Introduce dev-docs
This PR adds a template for dev documentation.
I've recently read the Velox Developer Guide and I really think that it would be super useful to have something like that. We are far away from it, but this PR includes a couple of documents explaining Multi-stage query engine and all the machinery required to write that doc using MkDocs as well as some tips and codestyle.
The main thing this is not doing is to actually publish these pages. It should be trivial to publish this documentation in GitHub Pages, but before doing that I think it is better to see if other committers actually like the proposed mechanism.
This can also be a first step on a possible migration of the public user documentation into something that is easier to write for committers.
Codecov Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 63.20%. Comparing base (d78b39b) to head (ba9c3ad).
Additional details and impacted files
@@ Coverage Diff @@
## master #14346 +/- ##
============================================
- Coverage 63.24% 63.20% -0.04%
Complexity 1432 1432
============================================
Files 3133 3133
Lines 185904 185904
Branches 28401 28401
============================================
- Hits 117568 117504 -64
- Misses 59277 59335 +58
- Partials 9059 9065 +6
| Flag | Coverage Δ | |
|---|---|---|
| custom-integration1 | 100.00% <ø> (ø) |
|
| integration | 100.00% <ø> (ø) |
|
| integration1 | 100.00% <ø> (ø) |
|
| integration2 | 0.00% <ø> (ø) |
|
| java-11 | 63.18% <ø> (+0.01%) |
:arrow_up: |
| java-21 | 63.16% <ø> (-0.04%) |
:arrow_down: |
| temurin | 63.20% <ø> (-0.04%) |
:arrow_down: |
| unittests | 63.20% <ø> (-0.04%) |
:arrow_down: |
| unittests1 | 55.62% <ø> (ø) |
|
| unittests2 | 33.87% <ø> (-0.04%) |
:arrow_down: |
Flags with carried forward coverage won't be shown. Click here to find out more.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
