This is an automated email from the ASF dual-hosted git repository. nightowl888 pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/lucenenet.git
commit 94521bcd8f6a69b3c42eb7f7da66eaf8bd6d6c15 Author: Shad Storhaug <[email protected]> AuthorDate: Wed Mar 24 02:48:59 2021 +0700 websites/apidocs: Added migration guide to the API docs site and added a link from the index.md page. --- websites/apidocs/docfx.core.json | 5 +++-- websites/apidocs/docfx.json | 3 ++- websites/apidocs/index.md | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/websites/apidocs/docfx.core.json b/websites/apidocs/docfx.core.json index 7c4b6da..7d276f7 100644 --- a/websites/apidocs/docfx.core.json +++ b/websites/apidocs/docfx.core.json @@ -1,4 +1,4 @@ -{ +{ "metadata": [ { "src": [ @@ -23,7 +23,8 @@ "content": [ { "files": [ - "overview.md" + "overview.md", + "migration-guide.md" ], "src": "../../src/Lucene.Net" }, diff --git a/websites/apidocs/docfx.json b/websites/apidocs/docfx.json index 7b046e6..ffcfa7a 100644 --- a/websites/apidocs/docfx.json +++ b/websites/apidocs/docfx.json @@ -1,4 +1,4 @@ -{ +{ "metadata": [ { "src": [ @@ -518,6 +518,7 @@ { "files": [ "Lucene.Net/overview.md", + "Lucene.Net/migration-guide.md", "Lucene.Net.Analysis.Common/overview.md", "Lucene.Net.Analysis.Morfologik/overview.md", "Lucene.Net.Analysis.OpenNLP/overview.md", diff --git a/websites/apidocs/index.md b/websites/apidocs/index.md index 3d19dc3..777265e 100644 --- a/websites/apidocs/index.md +++ b/websites/apidocs/index.md @@ -31,7 +31,7 @@ on some of the conceptual or inner details of Lucene: - [Changes](https://github.com/apache/lucenenet/releases/tag/<EnvVar:LuceneNetReleaseTag>): List of changes in this release. - System Requirements: Minimum and supported .NET versions. __TODO: Add link__ -- Migration Guide: What changed in Lucene 4; how to migrate code from Lucene 3.x. __TODO: Add link__ +- [Migration Guide](xref:Lucene.Net.Migration.Guide): What changed in Lucene 4; how to migrate code from Lucene 3.x. - [File Formats](xref:Lucene.Net.Codecs.Lucene46) : Guide to the supported index format used by Lucene. This can be customized by using [an alternate codec](xref:Lucene.Net.Codecs). - [Search and Scoring in Lucene](xref:Lucene.Net.Search): Introduction to how Lucene scores documents. - [Classic Scoring Formula](xref:Lucene.Net.Search.Similarities.TFIDFSimilarity): Formula of Lucene's classic [Vector Space](http://en.wikipedia.org/wiki/Vector_Space_Model) implementation. (look [here](xref:Lucene.Net.Search.Similarities) for other models)
