You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by sh...@apache.org on 2020/01/06 09:56:44 UTC
[lucenenet] branch master updated: Moving the markdown converter
solution to the src/docs folder
This is an automated email from the ASF dual-hosted git repository.
shazwazza pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
The following commit(s) were added to refs/heads/master by this push:
new 67e0477 Moving the markdown converter solution to the src/docs folder
new 049b771 Merge pull request #234 from Shazwazza/moving-markdown-converter
67e0477 is described below
commit 67e04776f94fc7c14d3f6e2346765931d1b0a4a8
Author: Shannon <sd...@gmail.com>
AuthorDate: Mon Jan 6 19:25:42 2020 +1100
Moving the markdown converter solution to the src/docs folder
---
.../JavaDocToMarkdownConverter.sln | 0
.../JavaDocToMarkdownConverter/App.config | 0
.../JavaDocToMarkdownConverter/CustomMarkdownScheme.cs | 0
.../JavaDocToMarkdownConverter/DocConverter.cs | 0
.../JavaDocToMarkdownConverter/Formatters/CodeExtractor.cs | 0
.../Formatters/CodeLinkReplacer.cs | 0
.../Formatters/ConvertedDocument.cs | 0
.../Formatters/DivWrapperReplacer.cs | 0
.../Formatters/DocTypeReplacer.cs | 0
.../Formatters/ExtraHtmlElementReplacer.cs | 0
.../Formatters/JavaDocFormatters.cs | 0
.../Formatters/NamedAnchorLinkReplacer.cs | 0
.../Formatters/PatternReplacer.cs | 0
.../Formatters/RepoLinkReplacer.cs | 0
.../JavaDocToMarkdownConverter.csproj | 0
.../JavaDocToMarkdownConverter/Program.cs | 0
.../JavaDocToMarkdownConverter/Properties/AssemblyInfo.cs | 0
.../JavaDocToMarkdownConverter/StringExtensions.cs | 0
.../JavaDocToMarkdownConverter/packages.config | 0
src/docs/readme.md | 14 ++++++++++++++
websites/apidocs/index.md | 4 ++++
21 files changed, 18 insertions(+)
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter.sln b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter.sln
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter.sln
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter.sln
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/App.config b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/App.config
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/App.config
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/App.config
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/CustomMarkdownScheme.cs b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/CustomMarkdownScheme.cs
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/CustomMarkdownScheme.cs
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/CustomMarkdownScheme.cs
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/DocConverter.cs b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/DocConverter.cs
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/DocConverter.cs
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/DocConverter.cs
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/CodeExtractor.cs b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/CodeExtractor.cs
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/CodeExtractor.cs
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/CodeExtractor.cs
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/CodeLinkReplacer.cs b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/CodeLinkReplacer.cs
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/CodeLinkReplacer.cs
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/CodeLinkReplacer.cs
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/ConvertedDocument.cs b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/ConvertedDocument.cs
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/ConvertedDocument.cs
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/ConvertedDocument.cs
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/DivWrapperReplacer.cs b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/DivWrapperReplacer.cs
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/DivWrapperReplacer.cs
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/DivWrapperReplacer.cs
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/DocTypeReplacer.cs b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/DocTypeReplacer.cs
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/DocTypeReplacer.cs
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/DocTypeReplacer.cs
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/ExtraHtmlElementReplacer.cs b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/ExtraHtmlElementReplacer.cs
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/ExtraHtmlElementReplacer.cs
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/ExtraHtmlElementReplacer.cs
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/JavaDocFormatters.cs b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/JavaDocFormatters.cs
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/JavaDocFormatters.cs
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/JavaDocFormatters.cs
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/NamedAnchorLinkReplacer.cs b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/NamedAnchorLinkReplacer.cs
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/NamedAnchorLinkReplacer.cs
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/NamedAnchorLinkReplacer.cs
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/PatternReplacer.cs b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/PatternReplacer.cs
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/PatternReplacer.cs
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/PatternReplacer.cs
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/RepoLinkReplacer.cs b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/RepoLinkReplacer.cs
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/RepoLinkReplacer.cs
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Formatters/RepoLinkReplacer.cs
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter.csproj b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter.csproj
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter.csproj
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter.csproj
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Program.cs b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Program.cs
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Program.cs
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Program.cs
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Properties/AssemblyInfo.cs b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Properties/AssemblyInfo.cs
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Properties/AssemblyInfo.cs
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/Properties/AssemblyInfo.cs
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/StringExtensions.cs b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/StringExtensions.cs
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/StringExtensions.cs
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/StringExtensions.cs
diff --git a/src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/packages.config b/src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/packages.config
similarity index 100%
rename from src/dotnet/tools/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/packages.config
rename to src/docs/JavaDocToMarkdownConverter/JavaDocToMarkdownConverter/packages.config
diff --git a/src/docs/readme.md b/src/docs/readme.md
index e69de29..e4786e8 100644
--- a/src/docs/readme.md
+++ b/src/docs/readme.md
@@ -0,0 +1,14 @@
+# Documentation tools
+
+## LuceneDocsPlugins
+
+This is a DocFx custom extension. It is built and executed as part of the docs build process to customize/extend some of the features in DocFx.
+
+## JavaDocToMarkdownConverter
+
+This is a utility that is executed against the Java Lucene source to convert their documentation files into markdown documentation files that we can
+use to build the Lucene.Net documentation suite.
+
+This utility does a lot of edge case work to try to automatically convert as much as possible from the Java Lucene repo into something usable for our project.
+
+The source that this is executed against is this tag: https://github.com/apache/lucene-solr/releases/tag/releases%2Flucene-solr%2F4.8.1
\ No newline at end of file
diff --git a/websites/apidocs/index.md b/websites/apidocs/index.md
index 0c48316..17f73aa 100644
--- a/websites/apidocs/index.md
+++ b/websites/apidocs/index.md
@@ -46,7 +46,11 @@ on some of the conceptual or inner details of Lucene:
* [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
* [Lucene.Net.Analysis.Stempel](xref:Lucene.Net.Analysis.Stempel): Analyzer for indexing Polish
+
<!-- * [Lucene.Net.Analysis.UIMA](xref:Lucene.Net.Analysis.UIMA): Analysis integration with Apache UIMA -->
+
+<!-- Change to Lucene.Net.Analysis.OpenNLP .... see https://github.com/apache/lucenenet/pull/230> -->
+
* [Lucene.Net.Benchmark](xref:Lucene.Net.Cli.Benchmark): System for benchmarking Lucene
* [Lucene.Net.Classification](xref:Lucene.Net.Classification): Classification module for Lucene
* [Lucene.Net.Codecs](xref:Lucene.Net.Codecs): Lucene codecs and postings formats.