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
websites/site/contributing/documentation.md: Added more information about the automated build scripts and that the manual steps are only necessary when the automation fails.
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
0 commit comments