[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2018-06-01 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 > We could potentially use some automation to overwrite the main Lucene.Net website and add a new subfolder for each version of docs right from the [Lucene.Net

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2018-06-01 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 I use the Releases section to find the commit to use, as these are frozen points in time. This is a little tricky because the core library was ported from

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2018-05-31 Thread Shazwazza
Github user Shazwazza commented on the issue: https://github.com/apache/lucenenet/pull/206 I've just run the script to do the docs conversions and can see the output. I'll make some tweaks to that since the overview.md file's need a special yaml type header to explicitly set their

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2018-05-30 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 > have fixed up a bunch of xref's To save a bunch of manual work, I created the https://github.com/apache/lucenenet/tree/master/src/dotnet/tools/JavaDocToMarkdownConverter tool. The

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2018-01-14 Thread Shazwazza
Github user Shazwazza commented on the issue: https://github.com/apache/lucenenet/pull/206 Just FYI I've pushed a bunch of new commits. The docs are looking fairly good now, have fixed up a bunch of xref's and put back in the main page link list, however some of the sections are not

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-12-04 Thread SilentCC
Github user SilentCC commented on the issue: https://github.com/apache/lucenenet/pull/206 Thank you! ---

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-12-03 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 @SilentCC Both of those classes were moved into [Lucene.Net.Queries](https://www.nuget.org/packages/Lucene.Net.Queries/). See the [Lucene 4.0 Migration

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-12-03 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 @SilentCC Both of those classes were moved into [Lucene.Net.Queries](https://www.nuget.org/packages/Lucene.Net.Queries/). See the [Lucene 4.0 Migration

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-12-03 Thread SilentCC
Github user SilentCC commented on the issue: https://github.com/apache/lucenenet/pull/206 Hello, every one!I am a college student. I find the CustomScoreProvider and CustomScoreQuery is not in Lucene4.8.0. Is there some another functions to replace them? ---

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-09-27 Thread Shazwazza
Github user Shazwazza commented on the issue: https://github.com/apache/lucenenet/pull/206 I can no longer replicate getting the temporary rogue files being put in the root no matter how i build it, i changed the build script to force docfx to log to an absolute location which i

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-09-27 Thread Shazwazza
Github user Shazwazza commented on the issue: https://github.com/apache/lucenenet/pull/206 Ok take #2 , was very late last night :) I've done a clean checkout of my branch which was part of the problem since i had old/stale file lying around. I had to fix up the docfx.json

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-09-27 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 Thanks Shannon. ### Docs Build There seems to be an issue with building the docs now.

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-09-27 Thread Shazwazza
Github user Shazwazza commented on the issue: https://github.com/apache/lucenenet/pull/206 Hi, quick update here ## New .csproj Format csproj references are all working but please let me know if I'm missing any since there's seems to be additional ones i didn't see

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-09-26 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 Sounds good. I would appreciate if you could at least fix the merge conflict and ensure it works using the new `.csproj` format. There were a few unforeseen issues that I have been

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-09-25 Thread Shazwazza
Github user Shazwazza commented on the issue: https://github.com/apache/lucenenet/pull/206 I can find a bit of time this week - not sure how much but i'll get back to you tomorrow and see where I'm at. Cheers! ---

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-09-14 Thread Shazwazza
Github user Shazwazza commented on the issue: https://github.com/apache/lucenenet/pull/206 @NightOwl888 thanks for the follow up! This weekend is an issue for me but i'll see if i can spend some time tomorrow to get us a little further. The TOC stuff - the way that

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-09-14 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 @Shazwazza Looking good. I like the drill down packages, although what I had in mind was a bit simpler than that - basically I was thinking to link over to the page and

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-09-07 Thread Shazwazza
Github user Shazwazza commented on the issue: https://github.com/apache/lucenenet/pull/206 I've got a little further here and managed to figure out the TOC stuff. So now we can have 'packages' which we define ourselves. Each 'package' can consist of one or more projects in the VS

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-08-24 Thread Shazwazza
Github user Shazwazza commented on the issue: https://github.com/apache/lucenenet/pull/206 Some comments inline: > The api folder is not currently in .gitignore, so the .yml documents all appear as uncommitted files. I have this in the .gitignore `apidocs/api/*.yml`

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-08-16 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 Thanks Shannon. There are basically 5 tasks I'd like to get done before the next beta release: 1. Finish up Replicator 2. Upgrade to the new `.csproj` format/VS2017 3. Support

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-08-16 Thread Shazwazza
Github user Shazwazza commented on the issue: https://github.com/apache/lucenenet/pull/206 Hi really sorry for the delay on this one, trying to find some time this week but it hasn't worked out for me :( I'll do my best to get back to this asap. I've also updated the

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-08-09 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 BTW - I tried running the code generation after copying and pasting the repo over to a different directory, and I am getting a null reference exception for some reason. ``` Done

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-08-09 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 During the building of a tool to get the `.html` pages converted, I can break the types of links we have into 3 categories: 1. Code links 2. Repo links 3. Namespace links

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-07-11 Thread Shazwazza
Github user Shazwazza commented on the issue: https://github.com/apache/lucenenet/pull/206 Awesome, I'll try to find some time this week to see what I can do ! --- 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

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-07-11 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 FYI - The CLI tool and docs have been merged to master. https://github.com/apache/lucenenet/tree/cli/src/tools/lucene-cli/docs --- If your project is set up for it, you can reply to

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-07-10 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 Thanks. I ended up dividing them into separate documents because it was too easy to scroll by the end of the command you are looking at into the next command, so that was not needed anyway.

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-07-10 Thread Shazwazza
Github user Shazwazza commented on the issue: https://github.com/apache/lucenenet/pull/206 Yes that's exactly how it works in DocFx too --- 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

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-07-08 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 @Shazwazza - Ok, you have explained how to link from one document to another in Markdown. How would you do an anchor within the same document so that it works in DocFx? I went

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-07-07 Thread Shazwazza
Github user Shazwazza commented on the issue: https://github.com/apache/lucenenet/pull/206 Ah i see, we can include any md files from anywhere in the solution so wherever you want to put them will work just fine :) I'm on the list so all good, just haven't had a chance to

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-07-06 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 Actually, I was referring to the new "tools" folder under "src" (to keep the docs near the source code the same as they would be by converting the HTML pages from Java). BTW - There

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-07-06 Thread Shazwazza
Github user Shazwazza commented on the issue: https://github.com/apache/lucenenet/pull/206 @NightOwl888 If you put markdown files in the /apidocs/tools folder that should be fine and then i can update any "toc" files to point to them. Currently that folder already exists for download

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-07-06 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 Much appreciated - keep up the good work 👍 I am almost to the point where I will start documenting the [new CLI tool](https://github.com/NightOwl888/lucenenet/tree/cli/src/tools).

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-07-06 Thread geobmx540
Github user geobmx540 commented on the issue: https://github.com/apache/lucenenet/pull/206 > @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

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-06-30 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 I have added some comments inline. I also [asked a

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-06-29 Thread Shazwazza
Github user Shazwazza commented on the issue: https://github.com/apache/lucenenet/pull/206 Hi all, Here's some feedback on many of the above questions/comments: I've pushed some updates to this PR which: * Fixed up a couple of cref's * Updated to use

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-06-29 Thread NightOwl888
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

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-06-12 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 @Shazwazza Thanks again. I took a look and documentation generated perfectly. The documentation and code samples look great. I have done all of the grunt work to update the

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-05-17 Thread Shazwazza
Github user Shazwazza commented on the issue: https://github.com/apache/lucenenet/pull/206 OK cool, I'm happy to update this PR with what I can and let you know what I get done. Probably isn't going to happy super fast but I can put in some work each week! --- If your project is

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-05-16 Thread NightOwl888
Github user NightOwl888 commented on the issue: https://github.com/apache/lucenenet/pull/206 @Shazwazza Thanks for this! > it's also possible to add markdown articles using docfx but I've removed these for now until we might want them. We definitely want

[GitHub] lucenenet issue #206: API Doc site generator using DocFx script

2017-05-16 Thread synhershko
Github user synhershko commented on the issue: https://github.com/apache/lucenenet/pull/206 This looks great, thanks for the initiative! @NightOwl888 I assume many files' code comments are still broken so we will gradually get them fixed so it looks better then @wwb