-
Notifications
You must be signed in to change notification settings - Fork 61.9k
Add transparency information to social preview docs #16418
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
Conversation
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
Automatically generated comment ℹ️This comment is automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request. |
@aisgbnok |
This comment was marked as spam.
This comment was marked as spam.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@aisgbnok 👋🏻 - thank you for your contribution ✨
I've made some suggestions (most of them relating to our content model) that I'm going to apply.
I'll merge this once I've checked that the preview works fine 🚢
...nd-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md
Outdated
Show resolved
Hide resolved
...nd-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md
Outdated
Show resolved
Hide resolved
...nd-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md
Outdated
Show resolved
Hide resolved
@ramyaparimi 👋🏻 - I think this is ready to be merged. The deployment is behaving oddly and I can't see the View deployment button, nor the updates I've just made on the preview. I raised this yesterday with the team in charge but haven't heard anything back. |
@mchammer01 Hey, the preview link seems to be updated for me? I like your changes, writing documentation can be hard. It takes a certain mindset. My only concern is that |
@aisgbnok - yes, thanks, I noticed that the preview eventually got updated but things are a bit slow today 😟 |
...nd-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md
Show resolved
Hide resolved
…atures/customizing-your-repository/customizing-your-repositorys-social-media-preview.md
I fixed the other tip too and hopefully we should be good to go. Thanks for highlighting the rendering issue @aisgbnok ✨ |
I've marked this as |
@mchammer01 Since this test is still failing, I will wait until the test is passing to merge this PR 💖. I am not entirely sure why the test is failing though, is there anything I can do to fix the error? |
I'm not sure. Is there something wrong with the image I committed? Any specific format I should be using. It looks fine on the preview. The error seems to be |
@ramyaparimi - I think we need someone from engineering to take a look. I'ts token-related and I haven't got a clue. |
@aisgbnok That is what I thought as well that it could be the size of the image or a format error. But seems like it is something related to an input. I will ask my team about the error and get back to you 💖. |
Looks like we can't write to forks using GitHub Actions. I've disabled the optimize images for the public repo. If possible to optimize the image before we merge that would be great, but disabling for the public repo should be enough to get the build green. |
@mchammer01 I will wait for your one final approval before I can get this merged 💖. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Final approval, as requested 😄
@heiskr I tried to run optimize images from my repo, but it skipped. I think because https://github.com/aisgbnok/docs/blob/db6301e9381d28fb1576cd4ac606d01f878529c3/.github/workflows/optimize-images.yml#L19 https://github.com/aisgbnok/docs/actions/runs/2097447192 Not sure if there is another way, or if I should just leave it be? Thanks for the help! |
No worries, we can always run it later 🤷🏼 |
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Why:
Closes #16417
What's being changed:
Addition of a small "Transparency" section to the "Customizing your repository's social media preview" page.
Here is what the built and rendered addition looks like:
If you have any feedback, questions, concerns, etc. don't hesitate to reply. I can add more information. For example, here is what a social preview with a transparent PNG looks like in Google Chat/Spaces.
Check off the following:
Writer impact (This section is for GitHub staff members only):