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

Disabling two-factor authentication documentation update #34830

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

georgethemarmot
Copy link

@georgethemarmot georgethemarmot commented Oct 4, 2024

Why:

Documentation was not up to date with website changes

What's being changed (if available, include any code snippets, screenshots, or gifs):

Image and description of where to disable 2fa

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

Copy link

welcome bot commented Oct 4, 2024

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 Oct 4, 2024
Copy link
Contributor

github-actions bot commented Oct 4, 2024

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
authentication/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@nguyenalex836 nguyenalex836 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 authentication Content relating to authentication and removed triage Do not begin working on this issue until triaged by the team labels Oct 4, 2024
@nguyenalex836
Copy link
Contributor

@georgethemarmot Thank you for opening a PR! ✨ While your changes appear to be correct, I'll get this triaged for review by our technical writing team to validate content / style changes 💛

@subatoi subatoi added the needs SME This proposal needs review from a subject matter expert label Oct 7, 2024
Copy link
Contributor

github-actions bot commented Oct 7, 2024

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀

@kashyapanjali
Copy link

how can i contribute ?

@nguyenalex836
Copy link
Contributor

@kashyapanjali Hello! 👋 While there aren't any opportunities to contribute regarding this PR, take a look at our help wanted section to find open issues you can work on ✨

@rachaelrenk rachaelrenk requested review from rachaelrenk and removed request for rachaelrenk October 24, 2024 18:47
Copy link
Contributor

@subatoi subatoi left a comment

Choose a reason for hiding this comment

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

Hi @georgethemarmot

Thanks for raising this PR and identifying the discrepancy. You're absolutely right that we need to change this, but I've amended your proposals to fit with our style guide.

One more thing is that the image you've proposed doesn't conform to the guidelines in https://docs.github.com/en/contributing/writing-for-github-docs/creating-screenshots so I created a new one that I'll add in a comment below, that you can add to your branch.

Once you've accepted all the changes we can get this merged. Many thanks!


![Screenshot of an account's 2FA settings. A green button labeled "Enabled" is outlined in orange.](/assets/images/help/2fa/disable-two-factor-authentication.png)
![Screenshot of an account's 2FA settings. The option menu is outlined in red.](/assets/images/help/2fa/disable-two-factor-authentication.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
![Screenshot of an account's 2FA settings. The option menu is outlined in red.](/assets/images/help/2fa/disable-two-factor-authentication.png)
![Screenshot of an account's 2FA settings. The ellipsis button (three dots) is highlighted with a dark orange outline.](/assets/images/help/2fa/disable-two-factor-authentication.png)

Context in https://docs.github.com/en/contributing/writing-for-github-docs/creating-screenshots

@@ -38,9 +38,9 @@ To remove yourself from your organization:
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.security %}
{% ifversion 2fa-reconfiguration-inline-update %}
1. Hover over **Enabled**, then click **Disable**.
1. Click on the three dots option menu, then click **Disable two-factor authentication**.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. Click on the three dots option menu, then click **Disable two-factor authentication**.
1. Click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then select **Disable two-factor authentication**.

Context in https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide#lists-and-list-items and https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide#use-clear-consistent-symbols-and-labels

@subatoi
Copy link
Contributor

subatoi commented Nov 18, 2024

disable-two-factor-authentication

New image to use

@nguyenalex836 nguyenalex836 added more-information-needed More information is needed to complete review SME reviewed An SME has reviewed this issue/PR and removed waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert labels Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
authentication Content relating to authentication content This issue or pull request belongs to the Docs Content team more-information-needed More information is needed to complete review SME reviewed An SME has reviewed this issue/PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants