-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Documentation names cleanup #8586
Conversation
Co-authored-by: Santos Gallegos <[email protected]>
Co-authored-by: Santos Gallegos <[email protected]>
Co-authored-by: Santos Gallegos <[email protected]>
Thanks @stsewd for the feedback, addressed 👍🏽 |
I'd like to see this in a style guide. Seems like we have a lot of implicit rules we should make explicit, so we can properly apply them across the team. 👍 |
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.
Looks good. Let's not forget to create the redirects for this.
@astrojuanlu You didn't ship the redirect for this.
|
I went ahead and shipped the redirect now. |
Thanks, I was planning to do it before the deploy since we're hiding |
and with each change to your repository, Read the Docs is notified. When we | ||
receive a webhook notification, we determine if the change is related to an | ||
receive an integration notification, we determine if the change is related to an |
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.
In #8573 (comment) you said
We are consistent with other products
but GitHub calls these "Webhooks" (see https://github.com/readthedocs/readthedocs.org/settings/hooks), not "Integrations"
Anyways, I don't think we need to revert any of this work (at least now it makes sense under RTD itself), but I just want to mention that "Integration" is not a good name IMO and we should eventually stop using it :)
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.
but GitHub calls these "Webhooks" (see https://github.com/readthedocs/readthedocs.org/settings/hooks), not "Integrations"
those are indeed webhooks, from the github side (you create a webhook to subscribe to github events). Then you have integrations https://github.com/readthedocs/readthedocs.org/settings/installations, that's services that subscribe to those events (that's what rtd does)
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.
Well... Nope. If that's the case, we would be an "Integration" once we migrate to GitHub Application. --which is not the case, now.
This fixes #8573, fixes a stray broken link, and addresses some confusion that arose at #8529. In summary:
/webhooks
to/integrations
/vcs
to/edit-source
html_context
. Read the Docs injects them anyway (just checked on a project using furo), so developers can focus on using them in their themes.We will need to create appropriate redirections for
/webhooks
and/vcs
.I wanted to do this before documenting #8522, since we want to have more in-depth documentation about (outgoing) webhooks.