[GitHub] [lucenenet] NightOwl888 commented on issue #396: Idea on how to handle manually editing the docs files while keeping the automated conversion

[GitBox <gi...@apache.org>]

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


   > As an example of such a namespace, see https://lucenenet.apache.org/docs/4.8.0-beta00009/api/analysis-phonetic/Lucene.Net.Analysis.Phonetic.Language.html
   
   That was actually not part of Lucene, but part of the [commons-codec](https://github.com/apache/commons-codec) package from Apache, which was imported to save us from maintaining an external library and porting the parts of it we don't need. There are a couple others, the [SAX](https://github.com/apache/lucenenet/tree/f5cca0b1a7c855f2fe44a5cdd27763aab7acdf22/src/Lucene.Net.Benchmark/Support/Sax) and [TagSoup](https://github.com/apache/lucenenet/tree/f5cca0b1a7c855f2fe44a5cdd27763aab7acdf22/src/Lucene.Net.Benchmark/Support/TagSoup) modules that were imported into Lucene.Net.Benchmarks to parse HTML. AFAIK, we could use [HTML Agility Pack](https://html-agility-pack.net/) instead and dump these classes if someone were willing to analyze this at a higher level to map over the functionality.
   
   The only actual Lucene case I can think of where we are missing the document is the migration guide (#399), presumably because it was named [Migrate.txt](https://github.com/apache/lucene-solr/blob/releases/lucene-solr/4.8.0/lucene/MIGRATE.txt) instead of following the other "overview" and "package" naming conventions. 
   
   Lucene.Net.Codecs was only different because we were trying to release that document before we had the conversion process sorted out. Now that it is, would it make sense to integrate these changes back into the original doc?
   
   Are there any other cases you can specifically recall where the documentation doesn't exist in Lucene? If there are no other exceptions and your suggestion is not to use override files on the rest, I am on board with that - it would be fewer files to maintain and less confusing to contributors.


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