lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From NightOwl888 <...@git.apache.org>
Subject [GitHub] lucenenet issue #206: API Doc site generator using DocFx script
Date Tue, 16 May 2017 11:46:41 GMT
Github user NightOwl888 commented on the issue:

    https://github.com/apache/lucenenet/pull/206
  
    @Shazwazza 
    
    Thanks for this!
    
    > it's also possible to add markdown articles using docfx but I've removed these for
now until we might want them.
    
    We definitely want them. Lucene has HTML documents that they add to each package, and
often this is where the best code samples and detailed overview of the API can be found. It
would be best if we could add the HTML documents unmodified from Lucene to our repo and have
the script convert them to be used in the documentation. Then we just need to copy over the
files from the next version and that part of the documentation will be automatic. Here is
an example of one of those HTML files:
    
    https://github.com/apache/lucene-solr/blob/releases/lucene-solr/4.8.0/lucene/highlighter/src/java/org/apache/lucene/search/highlight/package.html
    
    If there is a way to automate converting the code samples (preferably both to C# and VB.NET),
it would be ideal, but at least that would likely be the only part of the document that needs
to change if converting the code samples is not possible.
    
    It occurred to me that we also need to re-map the namespaces, but we should be able to
easily automate that part.
    
    For the home page, we should also aim to provide the same information as the rest of the
Java API docs: https://lucene.apache.org/core/4_8_0/.
    
    @synhershko 
    
    Yes, many of the files in Lucene.Net and Lucene.Net.Codecs have not been cleaned up yet.
Plus there are some other places where the comments need to be fixed up a bit. I have been
doing this bit by bit during the hour-long test runs when I can't really do much else.
    
    We could really use some help with this, as it would take one person the better part of
a week to get it all done. If 50 people contributed an hour each, we would be done in an hour
;).


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message