Skip to content

feat: Add "Leave GitHub Sponsors" section #5840

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 13 commits into from
May 8, 2021

Conversation

Panquesito7
Copy link
Contributor

@Panquesito7 Panquesito7 commented Apr 29, 2021

Why:

Closes #5780.

What's being changed:

  • Added a guide for how to leave the GitHub Sponsors program.

Check off the following:

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 (eg. a "before and after video")

@welcome
Copy link

welcome bot commented Apr 29, 2021

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 Apr 29, 2021
...in the guides (`content/sponsors/index.md`).
@Panquesito7 Panquesito7 force-pushed the leave_github_sponsors branch from f921b32 to de82071 Compare April 29, 2021 18:36
Copy link

@Nikitus-adm Nikitus-adm left a comment

Choose a reason for hiding this comment

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

Index

@janiceilene
Copy link
Contributor

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

@janiceilene janiceilene added sponsors Content related to GitHub Sponsors waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Apr 30, 2021
@felicitymay felicitymay self-assigned this May 6, 2021
@felicitymay
Copy link
Contributor

Hi @Panquesito7 - thank you so much for taking the time to create this new section of the help.

This is a much more than a simple bug fix and you've also found yourself editing the index.md file that we haven't documented yet! Before I review this PR, I'm going to check in with the team member who's recently reorganized this whole area to check exactly where we should be including these new articles on the landing and guides pages.

@jmarlena
Copy link
Contributor

jmarlena commented May 7, 2021

👋🏽 @panquestito7

Thank you for suggesting this and working on this PR!

I'm going to make some updates to the placement of these articles and add a few other updates to fit our styleguide.

@Panquesito7
Copy link
Contributor Author

Thank you for your help! Hopefully, I did everything correctly. 🙂

Copy link
Contributor

@jmarlena jmarlena left a comment

Choose a reason for hiding this comment

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

@Panquesito7 This is a very impressive first PR! 💪🏽

Since we'd appreciate your contributions more in the future, I've left a few comments to explain the "why" behind some changes I've made. 💖 I hope this context is helpful.

- /github/supporting-the-open-source-community-with-github-sponsors/disabling-your-github-sponsors-account
versions:
free-pro-team: '*'
permissions: You can easily leave the GitHub Sponsors program if you no longer want to participate. If some people are sponsoring you, you will need to contact GitHub Support about that.
Copy link
Contributor

Choose a reason for hiding this comment

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

This statement is generally about who can do what. A permissions statement isn't really needed here since anyone in the GitHub Sponsors program can disable their account. We could mention the caveat about when to contact GitHub Support but I decided to keep that in the article.

Copy link
Contributor

Choose a reason for hiding this comment

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

For the redirects in line 8: Since this is a new article, we don't actually need redirects. We use redirects when change an article title. But I understand why you'd include this here to copy similar patterns found in other articles

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For the redirects in line 8: Since this is a new article, we don't actually need redirects. We use redirects when change an article title. But I understand why you'd include this here to copy similar patterns found in other articles

Well, I actually kept them for that reason, but I'm not really sure if we should remove them. Maybe we should remove them according to what you said. 🙂

Copy link
Contributor

Choose a reason for hiding this comment

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

I removed them in the commits I made below. 💫


### Leaving the GitHub Sponsors program

{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
Copy link
Contributor

@jmarlena jmarlena May 7, 2021

Choose a reason for hiding this comment

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

Great use of reusables here! 💖


{% data reusables.sponsors.navigate-to-sponsors-dashboard %}
{% data reusables.sponsors.settings-tab %}
{% data reusables.sponsors.disable-your-account %}
Copy link
Contributor

Choose a reason for hiding this comment

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

Fwiw (for what it's worth), since we only need these steps one time, we don't need a reusable for them. It's great that you know how to create a reusable though! This will come in handy in future scenarios.

@@ -0,0 +1,9 @@
---
title: Leaving the GitHub Sponsors program
Copy link
Contributor

Choose a reason for hiding this comment

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

Since the target audience of this article is people who have set up GitHub Sponsors account, we're going to move the content of these two articles into the map topic geared for this specific audience.

@@ -0,0 +1,20 @@
---
title: Unpublishing your GitHub Sponsors account
Copy link
Contributor

Choose a reason for hiding this comment

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

I changed this title to profile to stay consistent with the UI.

@felicitymay felicitymay assigned jmarlena and unassigned felicitymay May 8, 2021
@Panquesito7
Copy link
Contributor Author

Any reasons why if you try to search Disabling your GitHub Sponsors account (or similar sentences) it doesn't show up anything? 🤔

Marcin198
Marcin198 previously approved these changes May 8, 2021
Copy link

@Marcin198 Marcin198 left a comment

Choose a reason for hiding this comment

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

Sponsorowane $$

@jmarlena
Copy link
Contributor

jmarlena commented May 8, 2021

👋🏽 @Panquesito7

Any reasons why if you try to search Disabling your GitHub Sponsors account (or similar sentences) it doesn't show up anything? 🤔

I'm honestly not sure but let's get this merged in and see if there's still search issues surfacing. Feel free to open an issue if the Search isn't working as expected after this PR merges.

There's some outstanding product questions about the differences between these procedures but to keep this work scoped down and rolling, we're going to merge this for now. 🚂

Thank you for your PR contribution and surfacing this important user need! 😸

Feel free to re-open a PR for any follow-up.

For instance, for these steps there's usually another header above this section that we use when we say:

Under "[subheader]", click button.

But I wasn't able to check this UI so this might be the only subheader.

image

@felicitymay
Copy link
Contributor

Any reasons why if you try to search Disabling your GitHub Sponsors account (or similar sentences) it doesn't show up anything?

I'm fairly sure that the staging previews just use the search index from the live site, and don't index the preview. So your new article won't appear in search results until the pull request is merged and the index recalculated. This may take a few minutes.

Copy link
Contributor

@jmarlena jmarlena left a comment

Choose a reason for hiding this comment

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

🚢

@jmarlena jmarlena merged commit 7b99fd0 into github:main May 8, 2021
@github-actions
Copy link
Contributor

github-actions bot commented May 8, 2021

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

@Panquesito7 Panquesito7 deleted the leave_github_sponsors branch May 8, 2021 04:37
@Panquesito7
Copy link
Contributor Author

Hey, GitHub team! I've seen the changes are not still there. Do we still have to wait more time, or is there something we should do? Thank you. 🙂

@felicitymay
Copy link
Contributor

Hey, GitHub team! I've seen the changes are not still there. Do we still have to wait more time, or is there something we should do? Thank you. 🙂

🤔 Your new articles should have been live a while back, I'll check with our engineering team as it sounds like a deployment bug.

@Panquesito7
Copy link
Contributor Author

should have been live a while back

This PR should fix it I think #6195.

@felicitymay
Copy link
Contributor

The docs engineering team fixed the problem.

🚀 https://docs.github.com/en/sponsors/receiving-sponsorships-through-github-sponsors/disabling-your-github-sponsors-account and https://docs.github.com/en/sponsors/receiving-sponsorships-through-github-sponsors/unpublishing-your-github-sponsors-profile are now live and findable in the search 😄

Thanks for your patience ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sponsors Content related to GitHub Sponsors waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a guide for how to leave the GitHub Sponsors program
8 participants