-
Notifications
You must be signed in to change notification settings - Fork 183
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
Move internal wiki page "Subscribe to Notifications" next to tools/notification-configuration #4837
Conversation
@weshaggard @hallipr I have few questions: Q1. How is this tool being used? I see there is a package for it: but I didn't find any other mentions of it. Is this package still relevant? How is it supposed to be used? Q2. In the README I added, I added a reference to our internal wiki, which I am not sure makes sense, given this is a public repo. But then again, if the tool is public, shouldn't the doc for it also be public? |
Q1: It is used in https://github.com/Azure/azure-sdk-tools/blob/main/eng/pipelines/notifications.yml which is a pipeline we run daily at https://dev.azure.com/azure-sdk/internal/_build?definitionId=679 Q2: We try to avoid linking to our internal wiki from public repos (link from our internal wiki to public repo where needed), but there are some exceptions to that rule. As a general rule try to document everything in the open repo and we only keep things internal if there is something sensitive. So for this tool I suspect we can move things out here. |
@weshaggard I am sorry if I am being dense, but I see only usages of Can you point me to the line in |
Sorry I think I misunderstood your question. It is possible that might not be used any longer. @sima-zhu do you know if we use that tool for anything anymore? |
We merged this step together with notification creator, so it is no longer in use. Thanks @konrad-jamrozik for bringing this up! Created a work item for the cleanup. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Feel free to gradually move the content out to the README.md
This PR adds a README.md file to
tools/notification-configuration
.This README most notably just points to the wiki article describing the feature that is implemented by the sources in the directory to which the README was added, i.e.:
https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/63/Subscribe-to-Notifications
As accompanying change to this PR, I made several updates to the doc hyperlinked from the README. You can find the full diff of my wiki changes here.