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

Links to docs unfurl poorly in Slack #314

Closed
cwjohnston opened this issue Mar 31, 2018 · 6 comments
Closed

Links to docs unfurl poorly in Slack #314

cwjohnston opened this issue Mar 31, 2018 · 6 comments
Labels
bug Bug in site build, layout, or functionality

Comments

@cwjohnston
Copy link
Contributor

When someone posts a link to our documentation into Slack, the page is crawled for metadata which is used to "unfurl" or provide a synopsis of the linked content. Right now it looks like this:

2018-03-30 at 5 57 pm

The unfurled message is the same for every page on our site, which makes these synopses obnoxiously repetitive. We should follow the instructions provided by Slack to make them useful.

@asachs01 asachs01 added bug Bug in site build, layout, or functionality enhancement New or updated site functionality and removed enhancement New or updated site functionality labels Apr 20, 2018
@apaskulin
Copy link
Contributor

b477814 produces https://gist.github.com/apaskulin/428ceec6805dbea20b2610401c760430

Working under a theory that a smaller image will render in-line with the text instead of expanding below (see unfurl for slack.com), but still looking for a way to test this.

@cwjohnston
Copy link
Contributor Author

@apaskulin On the face of it your commit looks 💯 to me! If it proves too difficult to test, perhaps we just roll with it and revert if needed?

@obfuscurity
Copy link

I agree with Cameron, let's :shipit: and see how it goes. I can also run it by Emerson Stone if you'd like a 3rd opinion from our design consultants.

@apaskulin
Copy link
Contributor

PR is ready (#515) for a first try at this. As a sidenote, Hugo offers a wealth of page-specific variables for this type of use case, including page summary (the first 70 words on the page), reading time, and word count. I left these out of #515 in an effort to keep unfurls brief and reduce noise, but I'm open to feedback if there's something more you'd like to see in an unfurl.

@cwjohnston
Copy link
Contributor Author

The end result of Alex’s first pass in #515 looks great when unfurled in slack, so I think we’re done here. If we need to iterate on this further, let’s open a new issue.

@obfuscurity
Copy link

obfuscurity commented Jun 22, 2018 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Bug in site build, layout, or functionality
Projects
None yet
Development

No branches or pull requests

4 participants