Improve documentation on deployment wide search #454
Merged
+18
−8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation for Hopsworks' free-text search, with a focus on deployment-wide search capabilities. Key changes include:
- Addition of YAML frontmatter for meta-description.
- A dedicated section detailing search functionalities across projects.
- Expanded explanation of asset visibility and a new "Tags" section.
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation regarding deployment-wide search functionality.
- Introduces YAML front matter with a description for the documentation page.
- Adds new sections ("## Search" and "## Tags") to better structure and explain search capabilities and tagging details.
- Clarifies the scope and limitations of search results based on project membership.
Comments suppressed due to low confidence (1)
docs/concepts/projects/search.md:20
- Consider adding the missing closing parenthesis after the PII example for proper punctuation and readability.
A keyword is a single user-defined word attached to an ML asset. Keywords can be used to help it make it easier to find ML assets or understand the context in which they should be used (for example, *PII* could be used to indicate that the ML asset is based on personally identifiable information.
There was a problem hiding this comment.
Pull Request Overview
This PR aims to improve the documentation on deployment-wide search capabilities in Hopsworks by introducing a YAML front matter and reorganizing content for clearer guidance on ML asset discovery.
- Added YAML front matter with a description.
- Introduced a new "Search" section with a revised bullet list of searchable assets.
- Expanded the text detailing search functionality and asset access limitations.
jimdowling
approved these changes
Mar 12, 2025
SirOibaf
added a commit
to SirOibaf/logicalclocks.github.io
that referenced
this pull request
Mar 12, 2025
* Improve documentation on deployment wide search * Update docs/concepts/projects/search.md Co-authored-by: Copilot <[email protected]> * add plural * fix copilot suggestion * add new line --------- Co-authored-by: Copilot <[email protected]>
SirOibaf
added a commit
that referenced
this pull request
Mar 12, 2025
* Improve documentation on deployment wide search * Update docs/concepts/projects/search.md * add plural * fix copilot suggestion * add new line --------- Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.