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 Thu, 29 Jun 2017 13:32:35 GMT
Github user NightOwl888 commented on the issue:

    https://github.com/apache/lucenenet/pull/206
  
    @Shazwazza - Added another minor issue to the above list. Any chance you will be able
to answer some of these questions soon? In particular, I would like to know if there is a
spec that the HTML docs can be converted to (and whether there a convention we can use for
changing the code links within them into the correct hyperlinks). Even if it is imperfect
or still incomplete, it would be nice to have some documentation hosted so people using the
beta have somewhere more relevant to turn than the Lucene 4.8.0 docs.
    
    @synhershko - Any particular reason you are suggesting Github pages instead of hosting
at http://lucenenet.apache.org/docs/3.0.3/Index.html? I think it would be less confusing if
users only have to modify the version number in the URL to get to the latest. Although, since
most of the new classes are not in the same location as the old, now would be the ideal time
to jump to a different host if that is indeed the plan.
    
    Question: For pre-releases should we be releasing new docs on each release in a new versioned
location, or updating the existing 4.8.0 version location until it is fully released? Seems
the former would be a better option in terms of legacy usage and automation of deployment,
but may end up taking up lots of space if we end up with a lot of pre-releases.


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