You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: websites/site/contributing/documentation.md
+28-13Lines changed: 28 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,17 +41,24 @@ This ensures the website is always synched with the `master` branch and PRs that
41
41
42
42
### Build script
43
43
44
+
#### Local Build and Host
45
+
44
46
To build the website and run it on your machine, run the PowerShell script: `./websites/site/site.ps1` with the `-ServeDocs` flag. For example:
45
47
46
-
```
48
+
```console
47
49
./websites/site/site.ps1 -ServeDocs
48
50
```
49
51
50
52
When executed this will build the site and host it at [http://localhost:8081](http://localhost:8081).
51
53
54
+
#### Release Build
55
+
56
+
> [!IMPORTANT]
57
+
> The following steps are automated in the `Lucene-Net-Website.yml` workflow. This workflow runs automatically when a PR or branch that contains website changes is merged/pushed to the `master` branch. The workflow submits a new PR with the compiled website content to the `lucenenet-site` repository. The below information is provided in case the automation fails and the release needs to be done manually.
58
+
52
59
To build the website for release, run the script:
53
60
54
-
```
61
+
```console
55
62
./websites/site/site.ps1
56
63
```
57
64
@@ -137,17 +144,25 @@ publish docs site
137
144
138
145
### Build script
139
146
147
+
#### Local Build and Host
148
+
140
149
To build the api docs and run it on your machine, run the PowerShell script: `./websites/apidocs/docs.ps1`. For example:
When executed this will build the site and host it at [http://localhost:8080](http://localhost:8080). _(Ensure to pass in the current version of Lucene.Net you are building.)_
147
156
157
+
#### Release Build
158
+
159
+
> [!IMPORTANT]
160
+
> The following steps are automated in the `Lucene-Net-Documentation.yml` workflow. This workflow runs automatically when changes are pushed to the corresponding `docs/[Version]` branch. The workflow submits a new PR with the compiled API documentation content to the `lucenenet-site` repository. The below information is provided in case the automation fails and the release needs to be done manually.
161
+
162
+
148
163
To build the api docs for release, run the script:
@@ -156,13 +171,13 @@ This will build the site with all live parameters configured correctly and outpu
156
171
The script parameters are:
157
172
158
173
-`-LuceneNetVersion`_(mandatory)_ This is the Lucene.Net version including pre-release information that is being built. For example: `4.8.0-beta00008`. _(This value will correspond to the folder and branch name where the docs get hosted, see below)_
159
-
*`-ServeDocs`_(optional)_ A boolean switch. If present, it will build the docs and host the site. If not present it will build the static site to be hosted elsewhere.
160
-
*`-Clean`_(optional)_ A boolean switch. If present, it will clear all caches and tool files before it builds again. This is handy if a new version of docfx is available or if there's odd things occurring with the incremental build.
161
-
*`-DisableMetaData`_(optional)_ A boolean switch. If present it will disable the docfx metadata build operation of the docs build. Can be handy when debugging the docs build.
162
-
*`-DisableBuild`_(optional)_ A boolean switch. If present it will disable the site building operation of the docs build. Can be handy when debugging the docs build.
163
-
*`-DisablePlugins`_(optional)_ A boolean switch. If present it will not build the custom Lucene.Net `DocumentationTools.sln` docsfx plugins and exclude them from the build.
*`-BaseUrl`_(optional)_ Default is https://lucenenet.apache.org/docs/. Used to set the base URL of the docfx xref map files for cross linking between project builds.
174
+
-`-ServeDocs`_(optional)_ A boolean switch. If present, it will build the docs and host the site. If not present it will build the static site to be hosted elsewhere.
175
+
-`-Clean`_(optional)_ A boolean switch. If present, it will clear all caches and tool files before it builds again. This is handy if a new version of docfx is available or if there's odd things occurring with the incremental build.
176
+
-`-DisableMetaData`_(optional)_ A boolean switch. If present it will disable the docfx metadata build operation of the docs build. Can be handy when debugging the docs build.
177
+
-`-DisableBuild`_(optional)_ A boolean switch. If present it will disable the site building operation of the docs build. Can be handy when debugging the docs build.
178
+
-`-DisablePlugins`_(optional)_ A boolean switch. If present it will not build the custom Lucene.Net `DocumentationTools.sln` docsfx plugins and exclude them from the build.
-`-BaseUrl`_(optional)_ Default is https://lucenenet.apache.org/docs/. Used to set the base URL of the docfx xref map files for cross linking between project builds.
166
181
167
182
### File/folder structure
168
183
@@ -194,12 +209,12 @@ To use the dotnet tool you must download the current tag of the Java Lucene proj
-[.NET Standard 2.1](https://docs.microsoft.com/en-us/dotnet/standard/net-standard)
33
+
-[.NET Standard 2.0](https://docs.microsoft.com/en-us/dotnet/standard/net-standard)
34
+
- .NET Framework 4.6.2
35
+
36
+
### Remaining work
37
+
38
+
See **[Current Status](xref:contributing/current-status)** for more details on the remaining work
39
+
40
+
This version is a direct port of the Java Lucene project at [this release](https://github.com/apache/lucene-solr/releases/tag/releases%2Flucene-solr%2F4.8.0)
-[Lucene.Net.Analysis.Common](https://www.nuget.org/packages/Lucene.Net.Analysis.Common/) - Analyzers for indexing content in different languages and domains
46
+
-[Lucene.Net.Analysis.Kuromoji](https://www.nuget.org/packages/Lucene.Net.Analysis.Kuromoji/) - Japanese Morphological Analyzer
47
+
-[Lucene.Net.Analysis.Morfologik](https://www.nuget.org/packages/Lucene.Net.Analysis.Morfologik/) - Analyzer for dictionary stemming, built-in Polish dictionary
-[Lucene.Net.Analysis.Phonetic](https://www.nuget.org/packages/Lucene.Net.Analysis.Phonetic/) - Analyzer for indexing phonetic signatures (for sounds-alike search)
50
+
-[Lucene.Net.Analysis.SmartCn](https://www.nuget.org/packages/Lucene.Net.Analysis.SmartCn/) - Analyzer for indexing Chinese
51
+
-[Lucene.Net.Analysis.Stempel](https://www.nuget.org/packages/Lucene.Net.Analysis.Stempel/) - Analyzer for indexing Polish
52
+
-[Lucene.Net.Benchmark](https://www.nuget.org/packages/Lucene.Net.Benchmark/) - System for benchmarking Lucene
53
+
-[Lucene.Net.Classification](https://www.nuget.org/packages/Lucene.Net.Classification/) - Classification module for Lucene
54
+
-[Lucene.Net.Codecs](https://www.nuget.org/packages/Lucene.Net.Codecs/) - Lucene codecs and postings formats
55
+
-[Lucene.Net.Expressions](https://www.nuget.org/packages/Lucene.Net.Expressions/) - Dynamically computed values to sort/facet/search on based on a pluggable grammar
56
+
-[Lucene.Net.Facet](https://www.nuget.org/packages/Lucene.Net.Facet/) - Faceted indexing and search capabilities
57
+
-[Lucene.Net.Grouping](https://www.nuget.org/packages/Lucene.Net.Grouping/) - Collectors for grouping search results
58
+
-[Lucene.Net.Highlighter](https://www.nuget.org/packages/Lucene.Net.Highlighter/) - Highlights search keywords in results
59
+
-[Lucene.Net.ICU](https://www.nuget.org/packages/Lucene.Net.ICU/) - Specialized ICU (International Components for Unicode) Analyzers and Highlighters
60
+
-[Lucene.Net.Join](https://www.nuget.org/packages/Lucene.Net.Join/) - Index-time and Query-time joins for normalized content
61
+
-[Lucene.Net.Memory](https://www.nuget.org/packages/Lucene.Net.Memory/) - Single-document in-memory index implementation
62
+
-[Lucene.Net.Misc](https://www.nuget.org/packages/Lucene.Net.Misc/) - Index tools and other miscellaneous code
63
+
-[Lucene.Net.Queries](https://www.nuget.org/packages/Lucene.Net.Queries/) - Filters and Queries that add to core Lucene
64
+
-[Lucene.Net.QueryParser](https://www.nuget.org/packages/Lucene.Net.QueryParser/) - Text to Query parsers and parsing framework
> This is a maintenance update that upgrades ICU4N to the latest version, since several serious concurrency and resource loading bugs have been patched since the last Lucene.NET release.
11
+
12
+
<!-- Release notes generated using configuration in .github/release.yml at Lucene.Net_4_8_0_beta00018 -->
13
+
14
+
## What's Changed
15
+
### 🐞 Bug Fixes
16
+
* FuzzyQuery produces a wrong result when prefix is equal to the term length by @paulirwin in https://github.com/apache/lucenenet/pull/1002
17
+
* Validate PatternParser DTDs against expected name by @paulirwin in https://github.com/apache/lucenenet/pull/1358
18
+
* Validate file paths for FSDirectory and Replicator by @paulirwin in https://github.com/apache/lucenenet/pull/1357
19
+
* Bumped ICU4N to 60.1.0-alpha.440 by @NightOwl888 in https://github.com/apache/lucenenet/pull/1353
20
+
* ShingleFilter produces invalid queries by @tohidemyname in https://github.com/apache/lucenenet/pull/946
21
+
* Fix SegmentInfos replace doesn't update userData by @tohidemyname in https://github.com/apache/lucenenet/pull/948
22
+
### 🚀 Performance Improvements
23
+
* SWEEP: Replace J2N's TripleShift call with C# 11's unsigned right shift operator by @paulirwin in https://github.com/apache/lucenenet/pull/1007
24
+
### 🏆 Improvements
25
+
* Added "Improvements" Category for Release Notes by @NightOwl888 in https://github.com/apache/lucenenet/pull/1015
26
+
### 📄 Website and API Documentation
27
+
* website/site/.htaccess - bug fix by removing BOM and update to beta0017 redirection by @rclabo in https://github.com/apache/lucenenet/pull/1005
28
+
* Updated .htaccess copy and release procedure by @NightOwl888 in https://github.com/apache/lucenenet/pull/1010
29
+
* Added GitHub Automation for Release Notes by @NightOwl888 in https://github.com/apache/lucenenet/pull/1011
30
+
* fix: Render ASF policy links in static HTML footer by @rbowen in https://github.com/apache/lucenenet/pull/1303
31
+
* Fix/apidocs breadcrumb toc asf by @zka26 in https://github.com/apache/lucenenet/pull/1232
32
+
* README: fix typo MacOS -> macOS by @jbampton in https://github.com/apache/lucenenet/pull/1179
33
+
* Added ASF-required links using drop-down menu and unified navigation by @zka26 in https://github.com/apache/lucenenet/pull/1198
34
+
* fix: Self-host all external website dependencies by @mmafrar in https://github.com/apache/lucenenet/pull/1197
35
+
* Fix typos by @jbampton in https://github.com/apache/lucenenet/pull/1177
36
+
* Replace lucene.testSettings.config references with lucene.testsettings.json by @paulirwin in https://github.com/apache/lucenenet/pull/1035
37
+
38
+
## New Contributors
39
+
*@jbampton made their first contribution in https://github.com/apache/lucenenet/pull/1177
40
+
*@mmafrar made their first contribution in https://github.com/apache/lucenenet/pull/1197
41
+
*@rbowen made their first contribution in https://github.com/apache/lucenenet/pull/1303
42
+
*@tohidemyname made their first contribution in https://github.com/apache/lucenenet/pull/946
43
+
*@zka26 made their first contribution in https://github.com/apache/lucenenet/pull/1198
0 commit comments