Skip to content

Partial fix for REDISIO-186: JSON broken links #724

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
Merged
merged 5 commits into from
Jun 22, 2022
Merged

Partial fix for REDISIO-186: JSON broken links #724

merged 5 commits into from
Jun 22, 2022

Conversation

nermiller
Copy link
Contributor

This PR fixes the RedisJSON part of the broken links as described in REDISIO-186.

@CLAassistant
Copy link

CLAassistant commented May 19, 2022 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@codecov
Copy link

codecov bot commented May 19, 2022 •
edited
Loading

Codecov Report

Merging #724 (228cfa7) into master (a31f2da) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #724   +/-   ##
=======================================
  Coverage   85.60%   85.60%           
=======================================
  Files          11       11           
  Lines        2931     2931           
=======================================
  Hits         2509     2509           
  Misses        422      422

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a31f2da...228cfa7. Read the comment docs.

banker
banker previously approved these changes May 19, 2022
View reviewed changes
@nermiller
Copy link
Contributor Author

@itamarhaber please review and merge. Thank you!

itamarhaber
itamarhaber previously approved these changes May 24, 2022
View reviewed changes
chayim
chayim reviewed Jun 3, 2022
View reviewed changes
docs/docs/indexing_JSON.md Outdated
@@ -168,7 +168,7 @@ FT.SEARCH userIdx '@name:(John)' RETURN 1 name HIGHLIGHT FIELDS 1 name TAGS '<b>

## Aggregation with JSON Path expression

[Aggregation](/redisearch/reference/aggregations) is a powerful feature. You can use it to generate statistics or build facet queries.
Aggregation is a powerful feature. You can use it to generate statistics or build facet queries.
Copy link
Contributor

Choose a reason for hiding this comment

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

The fix you provided removed the (broken) link to redisearch, potentially making it more difficult for users to learn about aggregations. WDYT about linking to the aggregation documentation instead?

[Aggregation](/docs/stack/search/reference/aggregations/)

This is the target destination I was thinking of: https://redis.io/docs/stack/search/reference/aggregations/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, @chayim. Please review and merge.

@nermiller nermiller dismissed stale reviews from itamarhaber and banker via 20b2e92 June 13, 2022 19:39
@chayim chayim merged commit 00af94f into RedisJSON:master Jun 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chayim chayim chayim approved these changes

@banker banker banker left review comments

@itamarhaber itamarhaber itamarhaber left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@nermiller @CLAassistant @banker @chayim @itamarhaber