Skip to content
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.

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

Add link to document pinning blog posts #2538

Merged
merged 4 commits into from
Aug 31, 2023
Merged

Conversation

guimachiavelli
Copy link
Member

Fixes #2517

@github-actions
Copy link

All broken links are now fixed, thank you!

Copy link
Contributor

@Strift Strift left a comment

Choose a reason for hiding this comment

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

Two piece of feedback on my end:

  • It's best if we can make it so searching for "Document boosting" brings results, otherwise I fear user might not find it
  • I tend to see both guides as a workaround for the same issue; one backend implementation, and one frontend implementation. Both have downsides/limitations. I'm not sure this is conveyed by the current wording.

@guimachiavelli
Copy link
Member Author

Hi, @Strift!

Responding:

It's best if we can make it so searching for "Document boosting" brings results, otherwise I fear user might not find it

Agreed, which is why I'm using both document boosting and pinning in both blocks. I can invert their usage order so "boosting" is on the <Capsule> title if you prefer, but this will have no impact on search results in our search bar. I still think both "pinning" and "boosting" should be present to cover both ways of referring to this feature/technique.

FYI, the docs scraper runs on the main branch, so the search bar will only reflect changes in this PR after it has been merged.

I tend to see both guides as a workaround for the same issue; one backend implementation, and one frontend implementation. Both have downsides/limitations. I'm not sure this is conveyed by the current wording.

Done. If that's the angle we're going for, I'd suggest making it explicit in the blog posts' intro too.

@guimachiavelli guimachiavelli merged commit 594da9d into main Aug 31, 2023
2 checks passed
@guimachiavelli guimachiavelli deleted the document-pinning-link branch August 31, 2023 10:15
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.

How-to guide on document pinning
2 participants