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

Documentation for build notifications using webhooks. #3671

Merged
merged 6 commits into from Apr 17, 2018

Conversation

@aasis21
Copy link
Contributor

@aasis21 aasis21 commented Feb 23, 2018

Regarding #3670

@@ -1,13 +1,46 @@
Enabling Build Notifications
============================

Using Email
******************
Copy link
Member

@stsewd stsewd Feb 23, 2018

Use ------ for subheadings with the same same size of the text, and should be sentence case.

You can read more about this here https://docs.readthedocs.io/en/latest/docs.html.

.. code-block:: json
{
'name': project.name,
Copy link
Member

@stsewd stsewd Feb 23, 2018

Json use " (double quotes).

What about putting real values here? Something like

{
    "name": "Read the Docs",
    "slug": "rtd",
    ...
}

@aasis21
Copy link
Contributor Author

@aasis21 aasis21 commented Feb 24, 2018

Thanks, @stsewd for the quick review.
I have made the changes as you suggested.

Copy link
Member

@humitos humitos left a comment

Thanks for this PR!

Left 3 small comments. After them, we could merge.

* Fill in the **Url** field under the **New Webhook Notifications** heading
* Submit the form

The project name, id and its bulid instance that failed will be sent to your webhook url:
Copy link
Member

@humitos humitos Feb 24, 2018

We should mention here that this is a POST request, maybe.

Copy link
Member

@humitos humitos Feb 24, 2018

Also, it doesn't send the project id, but the project slug.

"date": "2017-02-15 20:35:54",
}
}
Copy link
Member

@humitos humitos Feb 24, 2018

Remove these extra spaces, please (just leave one).

@@ -1,13 +1,46 @@
Enabling Build Notifications
============================

Using Email
Copy link
Member

@stsewd stsewd Feb 24, 2018

Sentence case here: Using email also Using webhook

* Fill in the **Url** field under the **New Webhook Notifications** heading
* Submit the form

The project name, slug and its bulid instance that failed will be sent as POST request to your webhook url:
Copy link
Member

@stsewd stsewd Feb 24, 2018

Little typo here its bulid -> its build

@aasis21
Copy link
Contributor Author

@aasis21 aasis21 commented Feb 26, 2018

@stsewd, I have made the suggested changes. Hoping that this can be merged now : )

Copy link
Contributor

@agjohnson agjohnson left a comment

These updates look great! I added some copyedit changes to grammar etc.


* Going to **Admin > Notifications** in your project.
* Fill in the **Email** field under the **New Email Notifications** heading
* Submit the form

You should now get notified when your builds fail!
You should now get notified on your email when your builds fail!
Copy link
Contributor

@agjohnson agjohnson Feb 27, 2018

'on your' -> 'by'

Using webhook
-------------

Read the Docs also allows webhooks configuration to receive notification regarding builds fails.
Copy link
Contributor

@agjohnson agjohnson Feb 27, 2018

This could be simplified to 'Read the Docs can also send webhooks when builds fail.'


Read the Docs also allows webhooks configuration to receive notification regarding builds fails.

Take these steps to enable build notifications using webhook:
Copy link
Contributor

@agjohnson agjohnson Feb 27, 2018

'using webhook' -> 'using a webhook'


Take these steps to enable build notifications using webhook:

* Going to **Admin > Notifications** in your project.
Copy link
Contributor

@agjohnson agjohnson Feb 27, 2018

'Going to' -> 'Go to'

Take these steps to enable build notifications using webhook:

* Going to **Admin > Notifications** in your project.
* Fill in the **Url** field under the **New Webhook Notifications** heading
Copy link
Contributor

@agjohnson agjohnson Feb 27, 2018

'Url' -> 'URL'

* Fill in the **Url** field under the **New Webhook Notifications** heading
* Submit the form

The project name, slug and its build instance that failed will be sent as POST request to your webhook url:
Copy link
Contributor

@agjohnson agjohnson Feb 27, 2018

'its build instance' could be slightly clearer as 'details for the build'

also: 'url' -> 'URL'

@aasis21
Copy link
Contributor Author

@aasis21 aasis21 commented Feb 27, 2018

Thanks, @agjohnson for the review. I have made changes as you suggested.

@aasis21
Copy link
Contributor Author

@aasis21 aasis21 commented Mar 6, 2018

@agjohnson, @humitos, @stsewd, Any new changes or suggestion regarding this.

Copy link
Member

@humitos humitos left a comment

Thanks!

@humitos
Copy link
Member

@humitos humitos commented Apr 17, 2018

All the requested changed from @agjohnson were already done. So, I'm merging this PR. Thanks for your contribution @aasis21!

@humitos humitos merged commit 8006182 into readthedocs:master Apr 17, 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

5 participants