Skip to content

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

Merged
merged 9 commits into from
Apr 5, 2022

Conversation

aisgbnok
Copy link
Contributor

@aisgbnok aisgbnok commented Mar 21, 2022

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:

image

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.

social-preview-transparency-chat

Check off the following:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

@welcome
Copy link

welcome bot commented Mar 21, 2022

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 21, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Mar 21, 2022

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 that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You 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.

Source Preview Production What Changed
content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md Modified Original

@ramyaparimi ramyaparimi added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review repositories Content related to repositories and removed triage Do not begin working on this issue until triaged by the team labels Mar 21, 2022
@ramyaparimi
Copy link
Contributor

@aisgbnok
Thanks so much for opening a PR! I'll get this triaged for review ⚡

@Aradsaeed

This comment was marked as spam.

Copy link
Contributor

@mchammer01 mchammer01 left a 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 🚢

@mchammer01 mchammer01 added ready to merge This pull request is ready to merge and removed waiting for review Issue/PR is waiting for a writer's review labels Apr 5, 2022
@mchammer01
Copy link
Contributor

mchammer01 commented Apr 5, 2022

@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.

@aisgbnok
Copy link
Contributor Author

aisgbnok commented Apr 5, 2022

@mchammer01 Hey, the preview link seems to be updated for me?
image

I like your changes, writing documentation can be hard. It takes a certain mindset. My only concern is that **Tip** doesn't look right? Thanks! ☺️

@mchammer01
Copy link
Contributor

@aisgbnok - yes, thanks, I noticed that the preview eventually got updated but things are a bit slow today 😟
I'll see if I can fix the rendering on the tip 🙂

…atures/customizing-your-repository/customizing-your-repositorys-social-media-preview.md
@mchammer01
Copy link
Contributor

I fixed the other tip too and hopefully we should be good to go. Thanks for highlighting the rendering issue @aisgbnok
Just waiting for an updates preview.

@mchammer01
Copy link
Contributor

I've marked this as ready-to-merge but one of the tests is failing. Re-running it.

@ramyaparimi
Copy link
Contributor

@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?

@aisgbnok
Copy link
Contributor Author

aisgbnok commented Apr 5, 2022

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 Error: Input required and not supplied: token which doesn't seem related, but I'm unsure. It would be great if all checks passed.

@mchammer01
Copy link
Contributor

@ramyaparimi - I think we need someone from engineering to take a look. I'ts token-related and I haven't got a clue.
The Optimize images job optimizes the size of screenshots in our docs, and may resize them before committing.

@ramyaparimi
Copy link
Contributor

@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 💖.

@heiskr
Copy link
Contributor

heiskr commented Apr 5, 2022

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.

@ramyaparimi
Copy link
Contributor

@mchammer01 I will wait for your one final approval before I can get this merged 💖.

Copy link
Contributor

@mchammer01 mchammer01 left a 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 😄

@aisgbnok
Copy link
Contributor Author

aisgbnok commented Apr 5, 2022

@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!

@heiskr
Copy link
Contributor

heiskr commented Apr 5, 2022

No worries, we can always run it later 🤷🏼

@heiskr heiskr merged commit d6e8e4a into github:main Apr 5, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Apr 5, 2022

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

@aisgbnok aisgbnok deleted the social-preview-transparency branch June 1, 2022 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team ready to merge This pull request is ready to merge repositories Content related to repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add transparency information to social preview documentation
5 participants