Skip to content

MLE-28021 Small docs fix#619

Open
rjrudin wants to merge 1 commit intodevelopfrom
feature/merge-docs
Open

MLE-28021 Small docs fix#619
rjrudin wants to merge 1 commit intodevelopfrom
feature/merge-docs

Conversation

@rjrudin
Copy link
Copy Markdown
Contributor

@rjrudin rjrudin commented Mar 19, 2026

Just pointing to releases page to avoid having to update the tag name in future releases.

Just pointing to releases page to avoid having to update the tag name in future releases.
Copilot AI review requested due to automatic review settings March 19, 2026 13:55
@github-actions
Copy link
Copy Markdown

Copyright Validation Results
Total: 4 | Passed: 0 | Failed: 0 | Skipped: 4 | at: 2026-03-19 13:55:59 UTC | commit: 5984d37

⏭️ Skipped (Excluded) Files

  • CONTRIBUTING.md
  • docs/import/embedder/embedder.md
  • docs/spark-integration.md
  • gradle.properties

✅ All files have valid copyright headers!

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates documentation to reduce release-specific maintenance and to correct the documented defaults for how embeddings are stored when using the embedder feature.

Changes:

  • Update Spark integration docs to link to the GitHub releases index instead of a specific tag.
  • Update embedder docs to reflect current default embedding field/element names and the default XML namespace.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
docs/spark-integration.md Points users to the general GitHub releases page for downloading the Flux uber-jar.
docs/import/embedder/embedder.md Corrects documented defaults for JSON/XML embedding storage (name + XML namespace).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 242 to +255
@@ -250,9 +250,9 @@ Flux will then create an array with the name provided to the option and store ea

### XML documents

By default, Flux will store an embedding in a new element named `embedding` that is added to the chunk element. The new
element will have an empty namespace value. The embedding array is serialized to a string - so that it begins with `[`
and ends with `]` - and stored as the text node of the `embedding` element.
By default, Flux will store an embedding in a new element named `vector` that is added to the chunk element. The new
element will default to a namespace of `http://marklogic.com/vector`. The embedding array is serialized to a string - so that it begins with `[`
and ends with `]` - and stored as the text node of the `vector` element.
Comment on lines 38 to +39
To use Flux with `spark-submit`, first download the `marklogic-flux-2.1.0-all.jar` file from the
[GitHub release page](https://github.com/marklogic/flux/releases/tag/2.0.0). This jar file includes Flux and all of
[GitHub release page](https://github.com/marklogic/flux/releases). This jar file includes Flux and all of

To use Flux with `spark-submit`, first download the `marklogic-flux-2.1.0-all.jar` file from the
[GitHub release page](https://github.com/marklogic/flux/releases/tag/2.0.0). This jar file includes Flux and all of
[GitHub release page](https://github.com/marklogic/flux/releases). This jar file includes Flux and all of
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants