Skip to content

add link icon to section headers #1755

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 4 commits into from
Jul 1, 2025
Merged

add link icon to section headers #1755

merged 4 commits into from
Jul 1, 2025

Conversation

kaitlynmichael
Copy link
Contributor

@kaitlynmichael kaitlynmichael commented Jun 25, 2025 •
edited
Loading

@kaitlynmichael kaitlynmichael requested a review from a team June 25, 2025 14:01
@kaitlynmichael kaitlynmichael self-assigned this Jun 25, 2025
rrelledge
rrelledge reviewed Jun 25, 2025
View reviewed changes
Copy link
Collaborator

@rrelledge rrelledge left a comment

Choose a reason for hiding this comment

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

Thank you! This seems to work great on most pages I've checked. The only issue I've found so far is that the links that should appear in the "On this page" ToC on the right-hand side have disappeared for some pages that include embeds.

Before this change: https://redis.io/docs/latest/operate/rs/references/supported-platforms/
Versus after this change: https://redis.io/docs/staging/link-icon-poc/operate/rs/references/supported-platforms/

I think this issue might only affect pages where headers are included within the embed content, because other pages with embeds like https://redis.io/docs/staging/link-icon-poc/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart/ seem to be fine.

@andy-stark-redis
Copy link
Contributor

Nice improvement :-) Just a couple of thoughts:

  • Maybe it's just me, but the link icon seems a bit too far from the end of the heading. Maybe bring it in a bit closer and align the bottom of the icon with the text baseline? (Very minor, though.)
  • The tooltip that says "Copied!" doesn't seem to appear very reliably (I think you can only see it if you hover over the icon shortly after you've clicked it). Another option for this that you sometimes see (eg, here) is to jump to the corresponding heading when you click the icon. This copies the link but also changes the hash in the URL bar to give confirmation. Not sure if this is any better but it might be worth trying.

@cmilesb
Copy link
Contributor

cmilesb commented Jun 25, 2025

Another example RE: Embed header weirdness -

Compatibility page - before: https://redis.io/docs/latest/operate/rs/references/compatibility
Compatibility page - after: https://redis.io/docs/staging/link-icon-poc/operate/rs/references/compatibility/

It's also on the Cloud page, but they're basically the same. Any headers in that embed file don't show in the right-side TOC.

@kaitlynmichael
Copy link
Contributor Author

@rrelledge and @andy-stark-redis, I had augmented make some edits based on your feedback. It looks like it fixed Andy's suggestions, but the TOC weirdness Rachel and @cmilesb pointed out is still happening

@rrelledge
Copy link
Collaborator

@kaitlynmichael @cmilesb I pushed a fix for the "On this page" ToC for embeds. It seems like it's working now.

cmilesb
cmilesb approved these changes Jun 26, 2025
View reviewed changes
Copy link
Contributor

@cmilesb cmilesb left a comment

Choose a reason for hiding this comment

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

I think that worked, @rrelledge - looks good to me.

@kaitlynmichael kaitlynmichael merged commit d165cb7 into main Jul 1, 2025
4 checks passed
@kaitlynmichael kaitlynmichael deleted the link-icon-poc branch July 1, 2025 18:44
dwdougherty added a commit that referenced this pull request Jul 7, 2025
@dwdougherty @mich-elle-luna
@kaitlynmichael @paoloredis @andy-stark-redis @cmilesb @rrelledge @redisdocsapp @DevRockstarZ
DOC-5423: update the modules API page (#1815)
58d847e 
* Improve rack-awareness documentation for Kubernetes

- Add clear explanation of node labeling requirements for rack-awareness
- Emphasize that ALL eligible nodes must be labeled with chosen label
- Explain what eligible nodes are (nodes where RS pods can be scheduled)
- Suggest topology.kubernetes.io/zone as commonly available label
- Clarify that not all platforms have this label by default
- Update example to use current topology.kubernetes.io/zone instead of deprecated failure-domain.beta.kubernetes.io/zone
- Fix kubectl command formatting (add space after $)
- Add warning about operator failing if nodes are missing labels

Addresses DOC-1815

* Update content/operate/kubernetes/recommendations/node-selection.md

Co-authored-by: Kaitlyn Michael <[email protected]>

* Update content/operate/kubernetes/recommendations/node-selection.md

Co-authored-by: Kaitlyn Michael <[email protected]>

* Update content/operate/kubernetes/recommendations/node-selection.md

Co-authored-by: Kaitlyn Michael <[email protected]>

* Update content/operate/kubernetes/recommendations/node-selection.md

Co-authored-by: Kaitlyn Michael <[email protected]>

* Update content/operate/kubernetes/recommendations/node-selection.md

Co-authored-by: Kaitlyn Michael <[email protected]>

* Move redisvl documentation

* Remove type integration

* Add redisvl/_index.md

* Fix relrefs

* Add aliases

* Add missing aliases

* DOC-3967 moved/expanded keyspace page

* DOC-3967 fixed links to keyspace page

* DOC-3967 moved transaction and pipeline pages to reference section

* DOC-3967 moved patterns folder to clients

* DOC-3967 moved programmability folder into develop

* DOC-3967 fixed links to programmability section

* DOC-3967 added aliases to programmability pages

* DOC-3967 moved pub/sub and keyspace notification pages

* DOC-3967 added missing aliases

* RDI: Add Reboot step after parameter group step

* add link icon to section headers (#1755)

* add link icon to section headers

* review suggestions

* toc embed fix

* Attempt to fix the broken on this page ToC for embedded content that includes headers

---------

Co-authored-by: Rachel Elledge <[email protected]>

* mention admission controller (#1791)

* relref fix (#1793)

* Update content/operate/rc/api/api-reference/openapi.json

* fix typo (#1795)

* DOC-5419 added commands section

* DOC-5419 fixed dodgy link

* RS: Adjusted best practices for scalable Redis query engine & add benchmarks (#1687)

* DOC-4271 RS: Adjusted best practices for scalable Redis query engine & add benchmarks

* Style guide fix for indexes

* Fixed broken relrefs after AI/search reorg

* RS: Added missing module requirements to recover DB (#1679)

* DOC-4564 RS: Added missing module requirements to recover DB

* DOC-4564 Added rladmin command to identify module versions required by recoverable DBs

* DOC-4564 Copied missing module requirements to recover DB to RS 7.4 and 7.8 versions

* RS: Added DB port access requirement for Replica Of between different RS clusters (#1650)

* DOC-3829 RS: Added DB port access requirement for Replica Of between different RS clusters

* Updated relrefs to correct versions

* Update ai-videos.md

* Fix search-and-query documentation aliases for backward compatibility

## Critical alias fixes to resolve 404 errors and incorrect redirects:

### Fixed broken basic-constructs aliases:
- field-and-type-options.md: Fixed alias to point to correct interact paths
- schema-definition.md: Fixed alias to point to correct interact paths
- configuration.md: Added missing interact aliases and fixed format

### Fixed directory redirect issues (_index.md files):
- Added trailing slash variants for all directory aliases
- Fixed indexing/ and query/ URLs that were redirecting to home page
- Updated: _index.md, indexing/_index.md, query/_index.md, advanced-concepts/_index.md, administration/_index.md, best-practices/_index.md, deprecated/_index.md

### Added missing aliases:
- index-mgmt-best-practices.md: Added missing interact alias
- aggregations-syntax.md: Added missing interact alias

### Root causes addressed:
- Aliases were incorrectly pointing to /ai/ paths instead of /interact/ paths
- Directory aliases needed both with/without trailing slash variants
- Some files missing interact aliases entirely

These fixes should resolve:
- 404 errors on basic-constructs URLs
- Directory URLs redirecting to home page instead of correct AI locations
- Missing backward compatibility for moved files

Addresses DOC-5428

* Update redisvl workflow (#1802)

* DEV: (RediSearch) doc expiration capabilities in Redis 8 (#1792)

* DEV: (RediSearch) doc expiration capabilities in Redis 8

* Apply suggestions from code review

Co-authored-by: andy-stark-redis <[email protected]>

* Apply more suggestions from code review

---------

Co-authored-by: andy-stark-redis <[email protected]>

* add leading slash to alias (#1804)

* DOC-5423: update the modules API page

---------

Co-authored-by: mich-elle-luna <[email protected]>
Co-authored-by: mich-elle-luna <[email protected]>
Co-authored-by: Kaitlyn Michael <[email protected]>
Co-authored-by: paoloredis <[email protected]>
Co-authored-by: Andy Stark <[email protected]>
Co-authored-by: Cameron Bates <[email protected]>
Co-authored-by: Rachel Elledge <[email protected]>
Co-authored-by: redisdocsapp[bot] <177626021+redisdocsapp[bot]@users.noreply.github.com>
Co-authored-by: andy-stark-redis <[email protected]>
Co-authored-by: JooYoung Lim <[email protected]>
Co-authored-by: Cameron Bates <[email protected]>
Co-authored-by: Rachel Elledge <[email protected]>
Co-authored-by: paoloredis <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rrelledge rrelledge rrelledge left review comments

@cmilesb cmilesb cmilesb approved these changes

Assignees

@kaitlynmichael kaitlynmichael

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@kaitlynmichael @andy-stark-redis @cmilesb @rrelledge