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

Remove self-referencing links for webhooks docs #4283

Merged
merged 3 commits into from Jun 26, 2018

Conversation

@annegentle
Copy link
Contributor

@annegentle annegentle commented Jun 20, 2018

Fix for Issue #4282; docs-only change.

to add. After you have added the integration, you'll see a URL for the
integration on the :ref:`integration detail page <webhooks:Webhook Integrations>`. Use this
URL when setting up a new webhook with your provider -- these steps vary
integration once you go to readthedocs.org/dashboard, log in, and then go to
Copy link
Member

@stsewd stsewd Jun 20, 2018

I'm not sure if is the best to point to the users to that link and the log in step, I think if the users are reading this they already in their project's admin page (the above step already point to that).

Copy link
Contributor Author

@annegentle annegentle Jun 21, 2018

Agreed, good point. Revising.

integration once you go to readthedocs.org/dashboard, log in, and then go to
**Admin** > **Integrations** to see or create an integration.

As an example, the URL pattern looks like this: *readthedocs.org/api/v2/webhook/<project-name>/<nnnnnn>/*.
Copy link
Member

@stsewd stsewd Jun 20, 2018

We can use <id> instead of <nnnn>

Copy link
Contributor Author

@annegentle annegentle Jun 21, 2018

Thanks - and is that formatting okay with angle brackets and italic?

Copy link
Member

@stsewd stsewd Jun 21, 2018

Yeah, I think is fine

integrations, this integration has a specific URL, found on the
:ref:`integration detail page <webhooks:Webhook Integrations>`.
integrations, this integration has a specific URL, found on the project's
**Integrations** Admin dashboard page on readthedocs.org.
Copy link
Member

@stsewd stsewd Jun 20, 2018

Also here, probably the users already know that the project is in readthedocs.org, right?

Copy link
Contributor Author

@annegentle annegentle Jun 21, 2018

Yeah, I'm revising in the next patch, see what you think... I still find it a bit disorienting if I'm not in that Dashboard very often.

Copy link
Member

@stsewd stsewd Jun 21, 2018

I think it is great now, we can change the wording here too. Thanks for the contribution btw ;)

@@ -90,8 +101,8 @@ branches
Default: **latest**

token
The integration token. You'll find this value on the
:ref:`integration detail page <webhooks:Webhook Integrations>` page.
The integration token. You'll find this value on the on your project's
Copy link
Member

@stsewd stsewd Jun 20, 2018

on your shouldn't be there

@ericholscher
Copy link
Member

@ericholscher ericholscher commented Jun 26, 2018

Looks good. Thanks for the PR!

@ericholscher ericholscher merged commit 22b914e into readthedocs:master Jun 26, 2018
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants