lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [lucenenet] NightOwl888 commented on issue #206: Website & API Doc site generator using DocFx script
Date Thu, 08 Aug 2019 06:05:15 GMT
NightOwl888 commented on issue #206: Website & API Doc site generator using DocFx script
URL: https://github.com/apache/lucenenet/pull/206#issuecomment-519378752
 
 
   @Shazwazza 
   
   I am working on rolling another beta and would like to try getting the docs updated to
reflect the install instructions for the `lucene-cli` tool and the new components in the `Lucene.Net.ICU`
project (which is now feature-complete). Note that the latter contains everything from Lucene's
`analyzers-icu` from the docs, but we moved it to a new library because we didn't want the
popular `Lucene.Net.Analysis.Common` project to depend on the huge ICU dependencies. In Java,
the features were readily built into the JDK, but they don't exist in .NET so we had to improvise.
Anyway, you can now remove the footnote that it is not done. It would probably be easier to
understand if we updated the names on the home page to reflect the package names, not sure
how difficult that would be.
   
   I'd like to try to get the doc building functionality hooked into the release build. Maybe
we won't have it automated to the point of doc site deployment, but it would be nice to at
least get it to the point where running a build produces the docs and main website as [build
artifacts](https://dev.azure.com/lucene-net/Lucene.NET/_build/results?buildId=5&view=results)
so they can be manually downloaded and deployed.
   
   Ideally, we would parameterize the version number and base URLs that the docs use and pass
them into a command to generate the docs. Those parameters would be put into `azure-pipelines.yml`
where we can change them if website locations change, etc.
   
   If you don't have time right now, we don't necessarily have to do this before the release
(the docs could be manually generated and synced up afterward). But if you have time to work
on this, it would be great if we could get it partially done.
   
   Thanks again for all your hard work!

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


With regards,
Apache Git Services

Mime
View raw message