lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [lucenenet] NightOwl888 edited a comment on issue #229: Updates docs build
Date Tue, 20 Aug 2019 04:35:26 GMT
NightOwl888 edited a comment on issue #229: Updates docs build
URL: https://github.com/apache/lucenenet/pull/229#issuecomment-522848491
 
 
   Sorry if I am a bit scatterbrained :).
   
   > Since Benchmark isn't a lib and it's part of the CLI, I was going move that under
tools too?
   
   Actually, it is both a library and a tool. The library is available if someone wants to
extend it to do customized benchmarks. So, looks good as-is.
   
   > I understand we have the CLI Demo stuff here for example: https://lucenenetdocs.azurewebsites.net/cli/demo/simple-facets.html
   and the demo's more or less map 1:1 with the c# demo files: https://lucenenetdocs.azurewebsites.net/api/Lucene.Net.Demo/Lucene.Net.Demo.Facet.SimpleFacetsExample.html
and I get that the c# demo code is actually in source code not in displayable docs files.
   Based on your comments above I'm just unsure what the end result is that you are after?
   
   Basically, I am hoping to get *some* of the documentation from the original JavaDocs into
markdown (which I can do manually), and get the code into the same markdown files (which I
am hoping you can achieve). So, the end user will basically have 4 ways to get the demo code:
   
   1. View it on screen with the CLI
   2. Export it using the CLI
   3. View it on the markdown doc (1:1 - I am hoping to have you automate getting the code
from the `.cs` files in the repo into the markdown so they stay up to date)
   4. They can view the code directly on GitHub
   
   The on-screen and export from the CLI embed the code as resources, so it is always the
same version as the `lucene-cli` tool. I am hoping to do something similar so the code samples
in the docs stay up to date as well.
   
   Once that is achieved, we really have no need for the original Demo documentation and can
remove the link/generation for it.
   
   Is that clear?

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