Skip to content

Commit

Permalink
Gets the home page menu linking correct
Browse files Browse the repository at this point in the history
  • Loading branch information
Shazwazza committed Jan 20, 2020
1 parent 3db3847 commit fc144ef
Show file tree
Hide file tree
Showing 8 changed files with 27 additions and 35 deletions.
2 changes: 1 addition & 1 deletion src/Lucene.Net.Analysis.OpenNLP/overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
uid: Lucene.Net.Analysis.OpenNLP
uid: Lucene.Net.Analysis.OpenNlp
summary: *content
---

Expand Down
1 change: 1 addition & 0 deletions src/Lucene.Net.Benchmark/overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
uid: Lucene.Net.Benchmarks
title: Lucene.Net.Benchmarks
summary: *content
---

Expand Down
28 changes: 13 additions & 15 deletions src/Lucene.Net.Benchmark/package.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
uid: Lucene.Net.Benchmarks
title: Lucene.Net.Benchmarks
summary: *content
---

Expand All @@ -21,24 +22,21 @@ summary: *content
-->

The benchmark contribution contains tools for benchmarking Lucene using standard, freely available corpora.
<div>

ANT will
download the corpus automatically, place it in a temp directory and then unpack it to the working.dir directory specified in the build.
The temp directory
and working directory can be safely removed after a run. However, the next time the task is run, it will need to download the files again.
ANT will
download the corpus automatically, place it in a temp directory and then unpack it to the working.dir directory specified in the build.
The temp directory
and working directory can be safely removed after a run. However, the next time the task is run, it will need to download the files again.

Classes implementing the Benchmarker interface should have a no-argument constructor if they are to be used with the Driver class. The Driver
class is provided for convenience only. Feel free to implement your own main class for your benchmarker.
Classes implementing the Benchmarker interface should have a no-argument constructor if they are to be used with the Driver class. The Driver
class is provided for convenience only. Feel free to implement your own main class for your benchmarker.

The StandardBenchmarker is meant to be just that, a standard that runs out of the box with no configuration or changes needed.
Other benchmarking classes may derive from it to provide alternate views or to take in command line options. When reporting benchmarking runs
you should state any alterations you have made.
The StandardBenchmarker is meant to be just that, a standard that runs out of the box with no configuration or changes needed.
Other benchmarking classes may derive from it to provide alternate views or to take in command line options. When reporting benchmarking runs
you should state any alterations you have made.

To run the short version of the StandardBenchmarker, call "ant run-micro-standard". This should take a minute or so to complete and give you a preliminary idea of how your change affects the code
To run the short version of the StandardBenchmarker, call "ant run-micro-standard". This should take a minute or so to complete and give you a preliminary idea of how your change affects the code

To run the long version of the StandardBenchmarker, call "ant run-standard". This takes considerably longer.
To run the long version of the StandardBenchmarker, call "ant run-standard". This takes considerably longer.

The original code for these classes was donated by Andrzej Bialecki at http://issues.apache.org/jira/browse/LUCENE-675 and has been updated by Grant Ingersoll to make some parts of the code reusable in other benchmarkers
</div>
<div> </div>
The original code for these classes was donated by Andrzej Bialecki at http://issues.apache.org/jira/browse/LUCENE-675 and has been updated by Grant Ingersoll to make some parts of the code reusable in other benchmarkers
3 changes: 1 addition & 2 deletions src/Lucene.Net.Memory/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
uid: Lucene.Net.Memory
title: Lucene.Net.Memory
uid: Lucene.Net.Index.Memory
summary: *content
---

Expand Down
3 changes: 1 addition & 2 deletions src/Lucene.Net.Memory/package.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
uid: Lucene.Net.Memory
title: Lucene.Net.Memory
uid: Lucene.Net.Index.Memory
summary: *content
---

Expand Down
14 changes: 5 additions & 9 deletions src/docs/JavaDocToMarkdownConverter/DocConverter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ private void ConvertDoc(string inputDoc, string rootOutputDirectory)
/// </summary>
private static readonly Dictionary<string, Converter> CustomConverters = new Dictionary<string, Converter>(StringComparer.InvariantCultureIgnoreCase)
{
["Lucene.Net.Benchmark"] = new Converter(new CustomMarkdownScheme(new ElementWhitespacePrefixReplacer("div"))),
["Lucene.Net.Benchmarks"] = new Converter(new CustomMarkdownScheme(new ElementWhitespacePrefixReplacer("div"))),
["Lucene.Net.Replicator"] = new Converter(new CustomMarkdownScheme(new AllWhitespacePrefixReplacer()))
};

Expand All @@ -128,9 +128,10 @@ private void ConvertDoc(string inputDoc, string rootOutputDirectory)
private static readonly Dictionary<string, string> PackageNamespaceToStandalone = new Dictionary<string, string>(StringComparer.InvariantCultureIgnoreCase)
{
["Lucene.Net.Search.Grouping"] = "Lucene.Net.Grouping",
["Lucene.Net.Index.Memory"] = "Lucene.Net.Memory",
["Lucene.Net.Memory"] = "Lucene.Net.Index.Memory",
["Lucene.Net.Queryparser"] = "Lucene.Net.QueryParser",
["Lucene.Net.Testframework"] = "Lucene.Net.TestFramework",
["Lucene.Net.Benchmark"] = "Lucene.Net.Benchmarks"
};

/// <summary>
Expand All @@ -142,25 +143,20 @@ private void ConvertDoc(string inputDoc, string rootOutputDirectory)
"Lucene.Net",
"Lucene.Net.Analysis.Common",
"Lucene.Net.Analysis.Morfologik",
"Lucene.Net.Analysis.OpenNLP",
"Lucene.Net.Highlighter",
"Lucene.Net.Grouping",
"Lucene.Net.Memory",
"Lucene.Net.QueryParser",
"Lucene.Net.Sandbox",
"Lucene.Net.Suggest",
"Lucene.Net.TestFramework"
"Lucene.Net.TestFramework",
"Lucene.Net.Benchmarks",
};

/// <summary>
/// Appends the YAML front-matter header
/// </summary>
/// <param name="ns"></param>
/// <param name="fileContent"></param>
/// <param name="rawTitle">
/// If specified will add the "title" front-matter, this is used for overview.md files that are
/// standalone (not part of a real namespace) (aka conceptual files in docfx)
/// </param>
/// <returns></returns>
private string AppendYamlHeader(string ns, string fileContent)
{
Expand Down
1 change: 0 additions & 1 deletion websites/apidocs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,6 @@
"Lucene.Net.Analysis.OpenNLP/overview.md",
"Lucene.Net.Highlighter/overview.md",
"Lucene.Net.Grouping/package.md",
"Lucene.Net.Memory/package.md",
"Lucene.Net.QueryParser/overview.md",
"Lucene.Net.Sandbox/overview.md",
"Lucene.Net.Suggest/overview.md",
Expand Down
10 changes: 5 additions & 5 deletions websites/apidocs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ on some of the conceptual or inner details of Lucene:
* [Lucene.Net](xref:Lucene.Net) - Core library
* [Lucene.Net.Analysis.Common](xref:Lucene.Net.Analysis.Common) - Analyzers for indexing content in different languages and domains
* [Lucene.Net.Analysis.Kuromoji](xref:Lucene.Net.Analysis.Ja) - Japanese Morphological Analyzer
* [Lucene.Net.Analysis.Morfologik](xref:Lucene.Net.Analysis.Uk) - Analyzer for dictionary stemming, built-in Polish dictionary
* [Lucene.Net.Analysis.Morfologik](xref:Lucene.Net.Analysis.Morfologik) - Analyzer for dictionary stemming, built-in Polish dictionary
* [Lucene.Net.Analysis.OpenNLP](xref:Lucene.Net.Analysis.OpenNlp) - OpenNLP Library Integration
* [Lucene.Net.Analysis.Phonetic](xref:Lucene.Net.Analysis.Phonetic) - Analyzer for indexing phonetic signatures (for sounds-alike search)
* [Lucene.Net.Analysis.SmartCn](xref:Lucene.Net.Analysis.Cn.Smart) - Analyzer for indexing Chinese
Expand All @@ -52,19 +52,19 @@ on some of the conceptual or inner details of Lucene:
* [Lucene.Net.Codecs](xref:Lucene.Net.Codecs) - Lucene codecs and postings formats
* [Lucene.Net.Expressions](xref:Lucene.Net.Expressions) - Dynamically computed values to sort/facet/search on based on a pluggable grammar
* [Lucene.Net.Facet](xref:Lucene.Net.Facet) - Faceted indexing and search capabilities
* [Lucene.Net.Grouping](xref:Lucene.Net.Search.Grouping) - Collectors for grouping search results
* [Lucene.Net.Grouping](xref:Lucene.Net.Grouping) - Collectors for grouping search results
* [Lucene.Net.Highlighter](xref:Lucene.Net.Search.Highlight) - Highlights search keywords in results
* [Lucene.Net.ICU](xref:Lucene.Net.Analysis.Icu) - Specialized ICU (International Components for Unicode) Analyzers and Highlighters
* [Lucene.Net.Join](xref:Lucene.Net.Join) - Index-time and Query-time joins for normalized content
* [Lucene.Net.Memory](xref:Lucene.Net.Index.Memory) - Single-document in-memory index implementation
* [Lucene.Net.Misc](xref:Lucene.Net.Misc) - Index tools and other miscellaneous code
* [Lucene.Net.Queries](xref:Lucene.Net.Queries) - Filters and Queries that add to core Lucene
* [Lucene.Net.QueryParser](xref:Lucene.Net.QueryParsers.Classic) - Text to Query parsers and parsing framework
* [Lucene.Net.QueryParser](xref:Lucene.Net.QueryParser) - Text to Query parsers and parsing framework
* [Lucene.Net.Replicator](xref:Lucene.Net.Replicator) Files replication utility
* [Lucene.Net.Sandbox](xref:Lucene.Net.Sandbox) - Various third party contributions and new ideas
* [Lucene.Net.Spatial](xref:Lucene.Net.Spatial) - Geospatial search
* [Lucene.Net.Suggest](xref:Lucene.Net.Search.Suggest) - Auto-suggest and Spell-checking support
* [Lucene.Net.TestFramework](xref:Lucene.Net.Testframework) - Framework for testing Lucene-based applications
* [Lucene.Net.Suggest](xref:Lucene.Net.Suggest) - Auto-suggest and Spell-checking support
* [Lucene.Net.TestFramework](xref:Lucene.Net.TestFramework) - Framework for testing Lucene-based applications

### Tools

Expand Down

0 comments on commit fc144ef

Please sign in to comment.