I started to answer "1. The Drill website" thinking that it's better to
consolidate the docs rather than fragment them. But then I realised
that these docs are for a different audience than those on the website,
so having them somewhere else is less of a concern. And possibly even
better because
1. a question like "Is it okay to write about unreleased or experimental
features?" is easily answered with "Yes" and
2. they can be authored the wiki way of ad-hoc independent edits while
official docs should probably try to follow a more controlled process.
Perhaps ideally Paul Rogers' Drill wiki would be merged into such a new
dev wiki...
On 2021/04/26 11:21, Vitalii Diravka wrote:
Hi devs
Currently we have good documentation for Drill developers in Drill source
<https://github.com/apache/drill/tree/master/docs/dev>
But to edit smth there we need to create Jira ticket, which can be overkill
for some minor edit. So we can place it in a better place.
What way do you prefer:
1. Apache Drill website
<http://drill.apache.org/docs/developer-information/>:
2. GitHub Wiki (currently it is not enabled for Drill, but the good example
is in Paul's Drill Wiki <https://github.com/paul-rogers/drill/wiki>)
* Both 1 and 2 better in editing (probably 2 slightly better here).
* Possibly 1 is better in searching (via Apache Drill website or Google),
but 2 probably is only
with GitHub search via Wiki pages.
* 2 is essential for devs
Thoughts?
Kind regards
Vitalii
