docs icon indicating copy to clipboard operation
docs copied to clipboard

Update managing-scheduled-reminders-for-your-team.md with "Get mentioned on slack" section

Open ranyitz opened this issue 1 year ago â€ĸ 4 comments

Why:

I've had to contact support to figure this out, so I thought it would be good to add it to the official docs.

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.

ranyitz avatar Feb 23 '24 13:02 ranyitz

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.

welcome[bot] avatar Feb 23 '24 13:02 welcome[bot]

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
organizations/managing-organization-settings/managing-scheduled-reminders-for-your-organization.md fpt
ghec
fpt
ghec
organizations/organizing-members-into-teams/managing-scheduled-reminders-for-your-team.md fpt
ghec
fpt
ghec

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

github-actions[bot] avatar Feb 23 '24 13:02 github-actions[bot]

Before i'm going to invest any time fixing the lint errors, please let me know if you'd like to accept this PR first. And ideally, what should be done from your perspective

ranyitz avatar Feb 23 '24 14:02 ranyitz

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

nguyenalex836 avatar Feb 23 '24 18:02 nguyenalex836

Hi @ranyitz 👋đŸģ

Apologies for the delay in reviewing. Thanks for flagging your difficulty in finding the information you needed to make Slack reminders work properly.

I'd like to be sure that I understand your use case properly before reviewing this PR because it's possible that we should add information about reminders in private channels to more articles than just this one.

It sounds as if you were using private Slack channels for reminders and needed to go through some additional steps before the reminders worked. Something like the steps described in the README for the integration. Have I understood correctly, or was there more to the problem?

felicitymay avatar May 30 '24 17:05 felicitymay

@felicitymay thanks for returning to me on that.

Yes we used private slack channels for reminders, i'll provide some additional context. The reminders integration is less effective if the reminded user is not notified. In our case, some users were mentioned and thus notified, and other users were not. I couldn't find what needs to be done and approached the support:

image

Consider that the entry point for this feature is https://docs.github.com/en/organizations/organizing-members-into-teams/managing-scheduled-reminders-for-your-team and not https://github.com/integrations/slack?tab=readme-ov-file#getting-started

ranyitz avatar May 30 '24 17:05 ranyitz

Thanks for confirming your use case ✨

I'm going to look into this a little further because it seems as there are several articles in GitHub docs where this information is relevant. It might make sense to create a reusable and then include that text in the relevant articles. 🤔

I'll get back to you on this tomorrow.

felicitymay avatar May 30 '24 18:05 felicitymay

@ranyitz - it seems as if this information is needed in two files:

The related article for users, Managing your scheduled reminders, doesn't seem to include the option to select a Slack channel.

I made some changes locally and tested them before committing them to your branch. I've expanded the information about choosing a Slack channel to let people know that if they choose a private channel, they'll need to ask users to run extra steps. In addition, I've added links to the README file for the integration.

It would be good to know if this would have answered your questions.

felicitymay avatar May 31 '24 10:05 felicitymay

I'm not sure why the preview keeps failing. I'm going to update the branch from main and see if that fixes the problem.

felicitymay avatar May 31 '24 11:05 felicitymay

@felicitymay I'm not able to merge this PR, so i'll leave it to you from here.

ranyitz avatar May 31 '24 13:05 ranyitz

I'm not able to merge this PR, so i'll leave it to you from here.

@ranyitz - many thanks for your collaboration on this update to the docs, and for flagging it in the first place. Once the tests have passed, I'll merge this and you'll see the changes in the live docs within a day.

felicitymay avatar May 31 '24 13:05 felicitymay

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 :zap:

github-actions[bot] avatar May 31 '24 14:05 github-actions[bot]