lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [lucenenet] Shazwazza commented on issue #396: Idea on how to handle manually editing the docs files while keeping the automated conversion
Date Thu, 26 Nov 2020 02:42:12 GMT

Shazwazza commented on issue #396:
URL: https://github.com/apache/lucenenet/issues/396#issuecomment-734040160


   > Implementing this procedure would close #283 and allow us to begin working on #284
immediately (and allow us to accept PRs to update API documentation).
   
   yep! without a lot of work we can very quickly start getting all of the docs and code samples
fixed up
   
   > However, the tag docs/converted/4.8.1 sounds like a finished product rather than a
half-way point which is what it actually is. Perhaps one of the following would be more descriptive?
   
   yep sure, I'm happy with `docs/markdown-converted/4.8.1`
   
   > By that I hope you mean git mergetool
   
   yes exactly. I just use GitExtensions so this happens all automatically for me. I use KDiff
instead of beyond compare since I like it better and it does all the 3 way merging, auto guessing,
whitespace options, etc... (although it looks like it was made in the 80s and never changed)
   
   > Perhaps the simplest way to enforce this would be to remove git tracking for JavaDocToMarkdownConverter
from the master branch and add it to .gitignore on the master branch
   
   Yep all of what you said makes sense. The converter code could even be removed entirely
from the master branch if we wanted and only live in the conversion branches.  I have no experience
with what `nbgv prepare-release` so I don't really have a comment about that one (but seems
like an interesting tool!)
   
   ---
   
   I'm happy to get started on this if we agree with the branch naming?
   


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



Mime
View raw message