Saved queries (v8.2.0 updates) #76
Conversation
WalkthroughRewrites Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (6)
docs/assets/edit-saved-query.pngis excluded by!**/*.pngdocs/assets/image1-26.pngis excluded by!**/*.pngdocs/assets/save-query-dialog.pngis excluded by!**/*.pngdocs/assets/saved-queries-default-view.pngis excluded by!**/*.pngdocs/assets/saved-queries-import-export.pngis excluded by!**/*.pngdocs/assets/saved-queries-search-filter.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/analyze-data/cypher-search.mdx(4 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/analyze-data/cypher-search.mdx
[style] ~10-~10: Consider using a more concise synonym.
Context: ...nality of BloodHound. BloodHound offers a variety of prebuilt queries to help you get starte...
(A_VARIETY_OF)
[grammar] ~14-~14: Use a hyphen to join words.
Context: ...ational databases). It uses an ASCII-art style syntax to describe nodes and relat...
(QB_NEW_EN_HYPHEN)
[style] ~205-~205: Consider using “who” when you are referring to people instead of objects.
Context: ...nks. In simple terms, give me any users that are a member of a group up to three lin...
(THAT_WHO)
[style] ~261-~261: ‘joined together’ might be wordy. Consider a shorter alternative.
Context: ...ions on. The two queries we execute are joined together using the WITH keyword. When using ...
(EN_WORDINESS_PREMIUM_JOINED_TOGETHER)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
docs/analyze-data/cypher-search.mdx (2)
129-131: Typo resolved.“availble” → “available” fix looks good.
161-162: Alt text added — accessibility fix confirmed.Alt is present; consider a slightly more descriptive alt if the image shows results (optional).
🧹 Nitpick comments (6)
docs/analyze-data/cypher-search.mdx (6)
14-15: Hyphenation tweak for readability.-Cypher is a query language for graph databases (similar to SQL for relational databases). It uses an ASCII-art style syntax to describe nodes and relationships. If you can describe the path you're looking for, you can write it in Cypher. +Cypher is a query language for graph databases (similar to SQL for relational databases). It uses an ASCII‑art‑style syntax to describe nodes and relationships. If you can describe the path you're looking for, you can write it in Cypher.
96-103: “Save As” step likely inverted; rephrase for accuracy.If the UI has a Save button with a “Save As” option in its dropdown, the action should reference “Save As,” not “Save.”
- Select a prebuilt or saved query from the list. Click the drop-down arrow beside **Save As** and click **Save** to create a copy of the selected query. + Select a prebuilt or saved query from the list. Click the drop-down arrow beside **Save** and select **Save As** to create a copy of the selected query.Please confirm the exact control labels in v8.2.0 and adjust accordingly.
114-121: Clarify permissions for “Set to Public.”State explicitly who can edit/delete when public: Owner only? Admins only? Do Editors with share permission gain write? Also clarify whether the owner retains edit rights when set to Public.
Example addition after Line 118:
- When sharing is set to Public, only Admins (and the query owner?) can edit or delete. View access is granted to all users. Shared users do not gain edit rights unless they are Admins.
166-173: Comma splice/noun list polish.-Everything in the graph database is represented using common terms from graph theory, particularly **edges,** and **nodes**. +Everything in the graph database is represented using common terms from graph theory, particularly **edges** and **nodes**.
199-206: Grammar and formatting of repetition range.
- Use “who” for people and pluralize “member.”
- Format the repetition as inline code.
-Adding ***1..3** limits the search to relationships that are between one and three links. In simple terms, give me any users that are a member of a group up to three links away. +Adding `*1..3` limits the search to relationships that are between one and three links. In simple terms, “return any users who are members of a group up to three links away.”
261-261: Tighten phrasing.-The two queries we execute are joined together using the **WITH** keyword. +The two queries we execute are joined using the **WITH** keyword.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/analyze-data/cypher-search.mdx(4 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/analyze-data/cypher-search.mdx
[style] ~10-~10: Consider using a more concise synonym.
Context: ...nality of BloodHound. BloodHound offers a variety of prebuilt queries to help you get starte...
(A_VARIETY_OF)
[grammar] ~14-~14: Use a hyphen to join words.
Context: ...ational databases). It uses an ASCII-art style syntax to describe nodes and relat...
(QB_NEW_EN_HYPHEN)
[style] ~205-~205: Consider using “who” when you are referring to people instead of objects.
Context: ...nks. In simple terms, give me any users that are a member of a group up to three lin...
(THAT_WHO)
[style] ~261-~261: ‘joined together’ might be wordy. Consider a shorter alternative.
Context: ...ions on. The two queries we execute are joined together using the WITH keyword. When using ...
(EN_WORDINESS_PREMIUM_JOINED_TOGETHER)
🔇 Additional comments (3)
docs/analyze-data/cypher-search.mdx (3)
8-18: Solid restructure and scoping.Prebuilt-first flow and clear Quickstart are strong improvements. No blocking issues here.
Consider leaving this as one page; if length becomes unwieldy later, split “Create and Manage” vs “Write Custom” into separate pages and add cross-links. Do you want me to draft a split outline?
26-41: Navigation path sanity check.Confirm “Explore > Cypher > Saved Queries” matches v8.2.0 UI labels and nesting. If labels differ (e.g., “Analyze” vs “Explore”), update for accuracy.
59-69: No change needed: data collectors link is correct
The data collectors link already points to the OpenGraph Library page, which is the central documentation for all collectors.Likely an incorrect or invalid review comment.
There was a problem hiding this comment.
I left a couple minor change requests.
We can split it in a separate PR if you like, but this change definitely makes me want to split the "Write Custom Queries" section into its own page. Happy to split that into a separate effort if that makes most sense to you!
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/analyze-data/cypher-search.mdx (1)
204-206: Tighten the grammar in this sentence.“Give me any users that are a member…” mixes singular and plural. Consider “Give me any users who are members…” for clarity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/assets/save-query-dialog.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/analyze-data/cypher-search.mdx(4 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/analyze-data/cypher-search.mdx
[style] ~10-~10: Consider using a more concise synonym.
Context: ...nality of BloodHound. BloodHound offers a variety of prebuilt queries to help you get starte...
(A_VARIETY_OF)
[grammar] ~14-~14: Use a hyphen to join words.
Context: ...ational databases). It uses an ASCII-art style syntax to describe nodes and relat...
(QB_NEW_EN_HYPHEN)
[style] ~205-~205: Consider using “who” when you are referring to people instead of objects.
Context: ...nks. In simple terms, give me any users that are a member of a group up to three lin...
(THAT_WHO)
[style] ~261-~261: ‘joined together’ might be wordy. Consider a shorter alternative.
Context: ...ions on. The two queries we execute are joined together using the WITH keyword. When using ...
(EN_WORDINESS_PREMIUM_JOINED_TOGETHER)
🔇 Additional comments (1)
docs/analyze-data/cypher-search.mdx (1)
100-102: Clarify the Save vs. Save As workflow.This step tells readers to open the Save As menu and then choose Save, which sounds contradictory. Can you double-check the UI flow? If copying requires selecting Save As (or another specific option), please adjust the instructions so users don’t get stuck.
|
Thanks @StephenHinck! I'll split the page in a separate PR. |
Purpose
This pull request (PR) updates the Search with Cypher page to reflect the latest features that were released in v8.2.0.
I reviewed a few user stories in the BED-5789 epic to aid in this effort.
Questions for reviewers
Summary by CodeRabbit