A cleanup is needed. One dev-docs folder is enough now :) We also have the help/ folder which is plaintext since it can be invoked with ./gradlew helpXXX. Someone should decide what goes in help/ vs dev-docs/
Asciidoc is more capable than MD, and renders well in GitHub as well: https://github.com/apache/lucene/blob/main/dev-docs/pmc-chair.adoc I think there may be some future idea to compile dev-docs into some dev guide online, if so, adoc will make it much easier to cross-link, add images, tables etc. Jan > 15. okt. 2021 kl. 16:51 skrev Adrien Grand <[email protected]>: > > I suspect that the adoc format got used because it was the format that was > already being used for the Solr ref guide. +1 to move to Markdown. > > > > On Fri, Oct 15, 2021 at 3:49 PM Michael Sokolov <[email protected] > <mailto:[email protected]>> wrote: > I was poking around looking for info on how we release Lucene, and I > stumbled into this dev-docs folder. It seems to have info that's > mostly useful for solr workflows, assumes you are working in > lucene-solr repo, etc. The info about pmc-chair seems helpful, and > maybe Putnam's guide to using git worktree, which was new to me, but > the rest should probably go / get updated to refer to lucene repo. > > One question I have is about this adoc format - is it processed by > something and published somewhere, or is this just intended to be read > in the source tree (or maybe on github). If it's the latter, maybe we > should switch to markdown? > > Also, I did find the dev-tools folder and the release wizard. The > README.md in there is very helpful. I wonder if we ought to simply > consolidate the docs in dev-docs in here so they are easier to > discover together? > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [email protected] > <mailto:[email protected]> > For additional commands, e-mail: [email protected] > <mailto:[email protected]> > > > > -- > Adrien
