lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [lucenenet] Shazwazza opened a new pull request #229: Updates docs build
Date Mon, 12 Aug 2019 04:29:52 GMT
Shazwazza opened a new pull request #229: Updates docs build
URL: https://github.com/apache/lucenenet/pull/229
 
 
   * Fixes build of csproj doc tools to not include the strong name signing
   * Fixes some namespaces issues in the JavaDocToMarkdownConverter
   * Re-executes the JavaDocToMarkdownConverter and commits updated files (incuding whitespaces
so on next run there's no changes)
   * Fixes UI auto-expanding quirk with docfx and the docs (hamburger menu)
   * Fixes some links from the docs home page and removes the ICU `to be completed` note
   
   Have upload the result of this to our temporary docs pages.
   
   @NightOwl888 just regarding your comments here https://github.com/apache/lucenenet/pull/206#issuecomment-519378752
   
   ### home page/package names
   
   Can you elaborate a bit more on this:
   
   > It would probably be easier to understand if we updated the names on the home page
to reflect the package names
   
   ... I've moved the Kuromoji and SmartCn headings outside of the big Analysis heading since
they are separate packages and linked to them properly from the home page, is this the type
of thing you mean? I also fixed the ICU link on the home page. 
   
   (there's currently still an issue with docfx when there is overlapping namespaces between
packages, i haven't yet researched into how to fix this but i can, the docfx team are very
responsive)
   
   ### build/build times
   
   A full clean build takes about 20 mins on my machine so should be ok for the build server.
On the build server you'd want to run the powershell:
   
   ```
   ./websites/apidocs/docs.ps1 0 1
   ```
   
   which is shorthand for
   
   ```
   ./websites/apidocs/docs.ps1 --ServeDocs 0 --Clean 1
   ```
   
   The output website is in `./websites/apidocs/_site`
   
   ### versioning
   
   I know that in the JavaDocToMarkdownConverter there's a TODO for passing in a tab/version
which is for the method `RepoLinkReplacer` ... but, this method is looking for links in files
like `overview.md` with this syntax `src-html`, but as far as i can see there is only 2x places
in all of the source that contains these types of links which is in the `Lucene.Net/overview.md`
file which is supposed to link to some demos. For this method it would prob just be easier
to fix this file, unless there are more inline links i'm unsure of.
   
   Apart from that is there another area where we need to have the version number/tag injected
in places?
   
   ### hosting
   
   The docs are currently just hosted on my azure subscription which is also why it has that
temporary dns name. I'm fine to leave it there for any length of time but we should look at
getting these hosted properly, it's just static files so nothing special. 

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