ShreyeshArangath opened a new issue, #2157:
URL: https://github.com/apache/auron/issues/2157
**Is your feature request related to a problem? Please describe.**
<!--
A clear and concise description of what the problem is. Ex. I'm always
frustrated when [...]
-->
Documentation currently lives in two places: the main apache/auron repo
(README, CONTRIBUTING) and apache/auron-sites (auron.apache.org)
- Content like getting-started, configuration, and benchmarks is duplicated
across both repos
- Changes in one repo don't propagate to the other, leading to silent
divergence
- Contributors submitting PRs to apache/auron have no way to ensure their
documentation changes are
reflected on the website, and a lot of features don't directly make it to
the documentation until a contributor manually updates
**Describe the solution you'd like**
<!--
A clear and concise description of what you want to happen.
-->
Make `apache/auron` the single source of truth for all documentation content
by adding a `docs/` directory in the main repo. This way:
- Every PR that changes behavior can include corresponding doc updates,
tracked and reviewed together
- Documentation changes become part of the standard PR review cycle
- No more silent divergence between the code repo and the website
If `apache/auron-sites` still needs to be managed separately (for site
theme, layout, VuePress config,
deployment), it can use an extscm (or git submodule/subtree) to clone/pull
the `docs/` content from
`apache/auron` at build time. The VuePress build in `auron-sites` would
then render docs sourced from
`apache/auron`.
**Describe alternatives you've considered**
<!--
A clear and concise description of any alternative solutions or features
you've considered.
-->
- **Keep the current two-repo setup** with a CI check that flags drift —
but this adds complexity and
doesn't solve the fundamental problem of contributors needing to update two
repos.
- **Move everything into `apache/auron`** — simpler, but may
not be desired if the site theme/layout/deployment needs to evolve
independently.
- **Use a GitHub Action in `apache/auron` to auto-sync docs to
`auron-sites`** on merge — reduces manual
drift but still keeps two repos as sources and adds CI complexity.
**Additional context**
<!--
Add any other context or screenshots about the feature request here.
-->
N/A
--
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]
