lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [lucenenet] Shazwazza commented on issue #229: Updates docs build
Date Fri, 16 Aug 2019 02:45:36 GMT
Shazwazza commented on issue #229: Updates docs build
URL: https://github.com/apache/lucenenet/pull/229#issuecomment-521864645
 
 
   Nice, just got that merged.
   
   Regarding the strange blurb: This is a common format for metadata with markdown which uses
Yaml in it's headers. I think the term is "YAML Front Matter" . Each document can contain
a `uid` which is how the xref links work.  For example, the benchmark doc is linked to from
the docs home page using the format `[benchmark](xref:Lucene.Net.Cli.Benchmark): System for
benchmarking Lucene` and the special `summary: *content` metadata is a special value for docfx
to support 'overrides' which is used when clicking the "Improve this doc" button (but in this
example overrides aren't a thing since that is only for api doc overrides, so the `summary:
*content` could be removed from this md file). The reason the other CLI md docs might not
have this metadata is just because we aren't currently linking to them so they don't really
need a `uid`. The docs converter automatically adds uid metadata to all generted .md based
on the lucene overview html files so that we can xref them.  
   
   For the build issues on the server, i think docfx fails right away, the first logs when
docfx runs is:
   
   ```
   Building metadata...
   [19-08-15 03:47:25.597]Info:[ExtractMetadata]Environment variable VSINSTALLDIR is set to
C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools, it is used as the inner compiler.
   [19-08-15 03:47:26.114]Info:[ExtractMetadata]Loading projects...
   [19-08-15 03:47:28.354]Warning:[ExtractMetadata](D:/a/1/s/src/Lucene.Net/Lucene.Net.csproj)Workspace
failed with: [Failure] Msbuild failed when processing the file 'D:\a\1\s\src\Lucene.Net\Lucene.Net.csproj'
with message: The SDK 'Microsoft.NET.Sdk' specified could not be found.  D:\a\1\s\src\Lucene.Net\Lucene.Net.csproj
   ```
   
   AFAIK this is because the version of docfx being used requires VS 2017 build tools installed....
BUT I've just run some tests locally and now for whatever reason it works by passing in the
2019 msbuild version to the env variable.
   
   I've also realized that docfx builds the sln in the background anyways so the build script
doesn't actually need to build the lucene sln at all which will save some time. 
   
   I've pushed changes for that and will check on the build.
   

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