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

Update configuring-notifications.md to add link for Custom Routing #34903

Closed
wants to merge 1 commit into from

Conversation

shadoath
Copy link

Add link to the Custom Routing URL.

Why:

Shorten the path to reaching the page needed.

Closes:

N/A

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

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.

Add link to the Custom Routing URL.

Because why follow all the steps when there is a quick link for this.
Copy link

welcome bot commented Oct 11, 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 11, 2024
@shadoath
Copy link
Author

Note: I think there are more needed edits for this page to match the current UI. However I don't understand how the {% data reusables.notifications-v2.manage-notifications %} tags work and wanted to keep my change to a smaller scope for this first pr.

Copy link
Contributor

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
account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.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

@shadoath shadoath marked this pull request as ready for review October 11, 2024 14:45
@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team account-and-profile Content relating to account and profile and removed triage Do not begin working on this issue until triaged by the team labels Oct 11, 2024
@nguyenalex836
Copy link
Contributor

@shadoath Thank you for opening a PR! ✨ Just for context, I wanted to share a link to our style guide regarding user interface elements 💛

If you are proposing this update because the UI isn't quite correct, can you elaborate on the changes you think are needed?

@nguyenalex836 nguyenalex836 added the more-information-needed More information is needed to complete review label Oct 11, 2024
@shadoath
Copy link
Author

shadoath commented Oct 11, 2024

What needs the UI updates are the images and steps to get to the "Notification" settings page as these images and steps are out of date as to the current UI:

Screenshot 2024-10-11 at 1 41 25 PM

What I did here was provide an easy shortcut to the notifications (Although most links like this are to other docs.github.com pages) when it is only text being hyperlinked.

Reading more of the doc there is a link below to that page. I think a better fix would be to move this text:
Screenshot 2024-10-11 at 1 45 48 PM

To the top of the page.

@nguyenalex836
Copy link
Contributor

@shadoath Thank you for providing that context! I'm looping in one of our technical writers @subatoi to assist in reviewing your last comment. We'll provide an update once we determine what next best steps will be 💛

@subatoi
Copy link
Contributor

subatoi commented Oct 13, 2024

Hi, I'm afraid we can't accept this contribution— #34903 (comment) already pointed out the style issue with hyperlinks. We don't link to specific parts in the UI from instructional procedures like this. This docs article is designed to be use on a section by section basis and as a reference article, and we already link to the relevant section at the top of the page:

Screenshot 2024-10-13 at 08 42 34

In actual fact, the Dependabot settings section you linked to should link to https://docs.github.com/en/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#choosing-your-notification-settings rather than using the wording it does.

I'm happy to leave this PR open whilst we figure out what you mean regarding the UI being out of date, but I'm not sure about this because the images seem to match the current experience. Are you able to take screenshots of your own experience so I can see if I'm missing something? Just to let you know: the best resolution may be to direct you to a Discussion or to our Support team, depending on the case.

@shadoath
Copy link
Author

shadoath commented Oct 14, 2024

Sure here is a screenshot of my profile where I don't see anything that looks like the indicated options as the prior screenshots show: ("In the upper right corner of any page, click {mail icon}")
Screenshot 2024-10-14 at 3 48 03 PM

Screenshot 2024-10-14 at 3 52 09 PM

@subatoi
Copy link
Contributor

subatoi commented Oct 15, 2024

Hi @shadoath, if you don't have any notifications set up on https://github.com/settings/notifications to go to GitHub.com, then the icon won't appear for you. If you try flipping one of the toggles (eg "Subscriptions") to "On GitHub", then refresh, it should appear.

Per the article:

To use the notifications inbox on GitHub and GitHub Mobile, you must enable web and mobile notifications in your notification settings. For more information, see "Choosing your notification settings."

@subatoi
Copy link
Contributor

subatoi commented Oct 15, 2024

I'm going to go ahead and close this out as there isn't a UI issue. Feel free to check out our issues marked help wanted and thank you for your interest in the GitHub Docs—if you continue to experience issues, you can raise a Discussion or if your plan includes it, you can raise an issue with Support

@subatoi subatoi closed this Oct 15, 2024
@shadoath shadoath deleted the patch-1 branch October 15, 2024 13:20
@shadoath
Copy link
Author

Hi @shadoath, if you don't have any notifications set up on github.com/settings/notifications to go to GitHub.com, then the icon won't appear for you. If you try flipping one of the toggles (eg "Subscriptions") to "On GitHub", then refresh, it should appear.

Thank you, that was the missing piece for me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
account-and-profile Content relating to account and profile content This issue or pull request belongs to the Docs Content team more-information-needed More information is needed to complete review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants