Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs converter update #2

Merged
merged 2 commits into from
Aug 16, 2019
Merged

Docs converter update #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8afe6f
lucene-cli: Updated docs so Markdown doesn't eat the command arguments
NightOwl888 Aug 15, 2019
6966999
azure-pipelines.yml: Added job to generate documentation
NightOwl888 Aug 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions azure-pipelines.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ name: 'vNext$(rev:.r)' # Format for build number (will be overridden)
# ArtifactFeedID: (Optional - set to your Azure DevOps Artifact (NuGet) feed. If not provided, publish job will be skipped.)
# BuildConfiguration: (Optional. Defaults to 'Release')
# BuildPlatform: (Optional. Defaults to 'Any CPU')
# GenerateDocs: (Optional. Only builds documentation website if set to 'true'.)
# IsRelease: (Optional. By default the Release job is disabled, setting this to 'true' will enable it)
# RunTests: 'true' (Optional - set to 'false' to disable test jobs - useful for debugging. If not provided, tests will be run.)

Expand All @@ -35,6 +36,10 @@ name: 'vNext$(rev:.r)' # Format for build number (will be overridden)
variables:
- name: BuildCounter
value: $[counter(variables['VersionSuffix'],coalesce(variables['BuildCounterSeed'], 1250))]
- name: DocumenationArtifactName
value: 'docs'
- name: DocumentationArtifactZipFileName
value: 'documentation.zip'
- name: BinaryArtifactName
value: 'testbinaries'
- name: NuGetArtifactName
Expand Down Expand Up @@ -160,6 +165,32 @@ stages:
PathtoPublish: '$(Build.ArtifactStagingDirectory)/$(NuGetArtifactName)'
ArtifactName: '$(NuGetArtifactName)'

- job: Docs
condition: and(succeeded(), eq(variables['GenerateDocs'], 'true'))
pool:
vmImage: 'windows-2019'

steps:
- powershell: |
$(Build.SourcesDirectory)/websites/apidocs/docs.ps1 0 1
errorActionPreference: 'continue'
ignoreLASTEXITCODE: true
failOnStderr: false
displayName: 'Generate Documentation'

- task: ArchiveFiles@2
displayName: 'Zip Documenation Files'
inputs:
rootFolderOrFile: '$(Build.SourcesDirectory)/websites/apidocs/_site'
includeRootFolder: false
archiveFile: '$(Build.ArtifactStagingDirectory)/$(DocumenationArtifactName)/$(DocumentationArtifactZipFileName)'

- task: PublishBuildArtifacts@1
displayName: 'Publish Artifact: $(DocumenationArtifactName)'
inputs:
PathtoPublish: '$(Build.ArtifactStagingDirectory)/$(DocumenationArtifactName)'
ArtifactName: '$(DocumenationArtifactName)'


- stage: Test_Stage
displayName: 'Test Stage:'
Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/analysis/kuromoji-build-dictionary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene analysis kuromoji-build-dictionary <FORMAT> <INPUT_DIRECTORY> <OUTPUT_DIRECTORY> [-e|--encoding] [-n|--normalize] [?|-h|--help]</code>
<code>lucene analysis kuromoji-build-dictionary \<FORMAT> \<INPUT_DIRECTORY> \<OUTPUT_DIRECTORY> [-e|--encoding] [-n|--normalize] [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/analysis/stempel-compile-stems.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene analysis stempel-compile-stems <STEMMING_ALGORITHM> <STEMMER_TABLE_FILE> [-e|--encoding] [?|-h|--help]</code>
<code>lucene analysis stempel-compile-stems \<STEMMING_ALGORITHM> \<STEMMER_TABLE_FILE> [-e|--encoding] [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/analysis/stempel-patch-stems.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene analysis stempel-patch-stems <STEMMER_TABLE_FILE> [-e|--encoding] [?|-h|--help]</code>
<code>lucene analysis stempel-patch-stems \<STEMMER_TABLE_FILE> [-e|--encoding] [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/benchmark/extract-reuters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene benchmark extract-reuters [?|-h|--help]</code>
<code>lucene benchmark extract-reuters \<INPUT_DIRECTORY> \<OUTPUT_DIRECTORY> [?|-h|--help]</code>

### Arguments

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/benchmark/extract-wikipedia.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene benchmark extract-wikipedia [?|-h|--help]</code>
<code>lucene benchmark extract-wikipedia \<INPUT_WIKIPEDIA_FILE> \<OUTPUT_DIRECTORY> [-d|--discard-image-only-docs] [?|-h|--help]</code>

### Arguments

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/benchmark/find-quality-queries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene benchmark find-quality-queries [?|-h|--help]</code>
<code>lucene benchmark find-quality-queries \<INPUT_DIRECTORY> [?|-h|--help]</code>

### Arguments

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/benchmark/run-trec-eval.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene benchmark run-trec-eval [?|-h|--help]</code>
<code>lucene benchmark run-trec-eval \<INPUT_TOPICS_FILE> \<INPUT_QUERY_RELEVANCE_FILE> \<OUTPUT_SUBMISSION_FILE> \<INDEX_DIRECTORY> [-t|--query-on-title] [-d|--query-on-description] [-n|--query-on-narrative] [?|-h|--help]</code>

### Arguments

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/benchmark/run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene benchmark run [?|-h|--help]</code>
<code>lucene benchmark run \<ALGORITHM_FILE> \<OUTPUT_DIRECTORY> [?|-h|--help]</code>

### Arguments

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/demo/index-files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
### Synopsis

```
lucene demo index-files <INDEX_DIRECTORY> <SOURCE_DIRECTORY> [-u|--update] [?|-h|--help]
lucene demo index-files \<INDEX_DIRECTORY> \<SOURCE_DIRECTORY> [-u|--update] [?|-h|--help]
lucene demo index-files [-src|--view-source-code] [-out|--output-source-code]
```

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/demo/search-files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
### Synopsis

```
lucene demo search-files <INDEX_DIRECTORY> [-f|--field] [-r|--repeat] [-qf|--queries-file] [-q|--query] [--raw] [-p|--page-size] [?|-h|--help]
lucene demo search-files \<INDEX_DIRECTORY> [-f|--field] [-r|--repeat] [-qf|--queries-file] [-q|--query] [--raw] [-p|--page-size] [?|-h|--help]
lucene demo search-files [-src|--view-source-code] [-out|--output-source-code]
```

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/index/check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene index check [<INDEX_DIRECTORY>] [-v|--verbose] [-c|--cross-check-term-vectors] [-dir|--directory-type] [-s|--segment] [?|-h|--help]</code>
<code>lucene index check [\<INDEX_DIRECTORY>] [-v|--verbose] [-c|--cross-check-term-vectors] [-dir|--directory-type] [-s|--segment] [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/index/copy-segments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene index copy-segments <INPUT_DIRECTORY> <OUTPUT_DIRECTORY> <SEGMENT>[ <SEGMENT_2>...] [?|-h|--help]</code>
<code>lucene index copy-segments \<INPUT_DIRECTORY> \<OUTPUT_DIRECTORY> \<SEGMENT>[ \<SEGMENT_2>...] [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/index/delete-segments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene index delete-segments <INDEX_DIRECTORY> <SEGMENT>[ <SEGMENT_2>...] [?|-h|--help]</code>
<code>lucene index delete-segments \<INDEX_DIRECTORY> \<SEGMENT>[ \<SEGMENT_2>...] [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/index/extract-cfs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene index extract-cfs <CFS_FILE_NAME> [-dir|--directory-type] [?|-h|--help]</code>
<code>lucene index extract-cfs \<CFS_FILE_NAME> [-dir|--directory-type] [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/index/fix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene index fix [<INDEX_DIRECTORY>] [-v|--verbose] [-c|--cross-check-term-vectors] [-dir|--directory-type] [--dry-run] [?|-h|--help]</code>
<code>lucene index fix [\<INDEX_DIRECTORY>] [-v|--verbose] [-c|--cross-check-term-vectors] [-dir|--directory-type] [--dry-run] [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/index/list-cfs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene index list-cfs <CFS_FILE_NAME> [-dir|--directory-type] [?|-h|--help]</code>
<code>lucene index list-cfs \<CFS_FILE_NAME> [-dir|--directory-type] [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/index/list-high-freq-terms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene index list-high-freq-terms [<INDEX_DIRECTORY>] [-t|--total-term-frequency] [-n|--number-of-terms] [-f|--field] [?|-h|--help]</code>
<code>lucene index list-high-freq-terms [\<INDEX_DIRECTORY>] [-t|--total-term-frequency] [-n|--number-of-terms] [-f|--field] [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/index/list-segments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene index list-segments [<INDEX_DIRECTORY>] [?|-h|--help]</code>
<code>lucene index list-segments [\<INDEX_DIRECTORY>] [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/index/list-taxonomy-stats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene index list-taxonomy-stats [<INDEX_DIRECTORY>] [-tree|--show-tree] [?|-h|--help]</code>
<code>lucene index list-taxonomy-stats [\<INDEX_DIRECTORY>] [-tree|--show-tree] [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/index/list-term-info.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene index list-term-info <INDEX_DIRECTORY> <FIELD> <TERM> [?|-h|--help]</code>
<code>lucene index list-term-info \<INDEX_DIRECTORY> \<FIELD> \<TERM> [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/index/merge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene index merge <OUTPUT_DIRECTORY> <INPUT_DIRECTORY> <INPUT_DIRECTORY_2>[ <INPUT_DIRECTORY_N>...] [?|-h|--help]</code>
<code>lucene index merge \<OUTPUT_DIRECTORY> \<INPUT_DIRECTORY> \<INPUT_DIRECTORY_2>[ \<INPUT_DIRECTORY_N>...] [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/index/split.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene index split <OUTPUT_DIRECTORY> <INPUT_DIRECTORY>[ <INPUT_DIRECTORY_2>...] [-n|--number-of-parts] [-s|--sequential] [?|-h|--help]</code>
<code>lucene index split \<OUTPUT_DIRECTORY> \<INPUT_DIRECTORY>[ \<INPUT_DIRECTORY_2>...] [-n|--number-of-parts] [-s|--sequential] [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/index/upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene index upgrade [<INDEX_DIRECTORY>] [-d|--delete-prior-commits] [-v|--verbose] [-dir|--directory-type] [?|-h|--help]</code>
<code>lucene index upgrade [\<INDEX_DIRECTORY>] [-d|--delete-prior-commits] [-v|--verbose] [-dir|--directory-type] [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/lock/stress-test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene lock stress-test <ID> <VERIFIER_HOST> <VERIFIER_PORT> <LOCK_FACTORY_TYPE> <LOCK_DIRECTORY> <SLEEP_TIME_MS> <TRIES> [?|-h|--help]</code>
<code>lucene lock stress-test \<ID> \<VERIFIER_HOST> \<VERIFIER_PORT> \<LOCK_FACTORY_TYPE> \<LOCK_DIRECTORY> \<SLEEP_TIME_MS> \<TRIES> [?|-h|--help]</code>

### Description

Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/tools/lucene-cli/docs/lock/verify-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Synopsis

<code>lucene lock verify-server <IP_HOSTNAME> <MAX_CLIENTS> [?|-h|--help]</code>
<code>lucene lock verify-server \<IP_HOSTNAME> \<MAX_CLIENTS> [?|-h|--help]</code>

### Description

Expand Down