Fossil SCM
Assorted tweaks and improvements to the new email alerts material in www/forum.wiki.
Commit
4326f76f7f3e99cbc343c559e8bb89ffe5664c61599b5f7ef8d4ba73f240169a
Parent
6b2752030d391a6…
1 file changed
+21
-15
+21
-15
| --- www/forum.wiki | ||
| +++ www/forum.wiki | ||
| @@ -357,12 +357,12 @@ | ||
| 357 | 357 | below. |
| 358 | 358 | |
| 359 | 359 | If you use the same user name and email address as you used for your |
| 360 | 360 | normal user login, Fossil will simply tie your alert preferences to your |
| 361 | 361 | login, and it will be considered already-verified. Otherwise, Fossil |
| 362 | -will create up an alert-only record, and you will have to verify the | |
| 363 | -email address before Fossil will send notifications to it. | |
| 362 | +will create an alert-only record, and you will have to verify the email | |
| 363 | +address before Fossil will send notifications to it. | |
| 364 | 364 | |
| 365 | 365 | This shows a key aspect of the way Fossil's email alerts system works, |
| 366 | 366 | by the way: a user can be signed up for email alerts without having a |
| 367 | 367 | full-fledged Fossil user account. Only when both user names are the same |
| 368 | 368 | are the two records tied together under the hood. |
| @@ -369,13 +369,13 @@ | ||
| 369 | 369 | |
| 370 | 370 | |
| 371 | 371 | <h4>Test the Email Subsystem</h4> |
| 372 | 372 | |
| 373 | 373 | If you'd rather not create an inane "testing" post in your Fossil |
| 374 | -instance just to force out an email alert, we can check whether the | |
| 375 | -email subsystem separate from the rest of the Fossil Email Alerts system | |
| 376 | -is working with the following command: | |
| 374 | +instance just to force out an email alert, we can test the email | |
| 375 | +subsystem separately from the rest of the Fossil email alerts system | |
| 376 | +with the following command: | |
| 377 | 377 | |
| 378 | 378 | <verbatim> |
| 379 | 379 | $ fossil alerts test-message [email protected] --body README.md --subject Test |
| 380 | 380 | </verbatim> |
| 381 | 381 | |
| @@ -391,12 +391,12 @@ | ||
| 391 | 391 | <h4>Frist Post</h4> |
| 392 | 392 | |
| 393 | 393 | Since you've already edited the skin per [#skin | the instructions |
| 394 | 394 | above], you can click the "Forum" link in the navbar and create a new |
| 395 | 395 | post. I suggest taking the time to compose a suitable introductory |
| 396 | -message especially for your project's forum, suitable for pointing new | |
| 397 | -forum users at. | |
| 396 | +message especially for your project's forum, one which a new user would | |
| 397 | +find helpful. | |
| 398 | 398 | |
| 399 | 399 | Wait a few seconds, and you should receive a notification email with the |
| 400 | 400 | post's subject and body text in the email. |
| 401 | 401 | |
| 402 | 402 | |
| @@ -434,22 +434,28 @@ | ||
| 434 | 434 | This should also kick off the backoffice processing, if there are any |
| 435 | 435 | pending alerts to send out. |
| 436 | 436 | |
| 437 | 437 | <verbatim> |
| 438 | 438 | $ fossil alert pending |
| 439 | +</verbatim> | |
| 440 | + | |
| 441 | +Show any pending alerts. The number of lines output here should equal | |
| 442 | +the [#status | status output above]. | |
| 443 | + | |
| 444 | +<verbatim> | |
| 439 | 445 | $ fossil test-add-alerts f5900 |
| 440 | 446 | $ fossil alert send |
| 441 | 447 | </verbatim> |
| 442 | 448 | |
| 443 | -If the first command gives no output and <tt>pending-alerts</tt> in the | |
| 444 | -earlier command is 0, the second command will add another alert, which | |
| 445 | -should shortly cause another notification email. The <tt>f</tt> in the | |
| 446 | -final parameter means you're scheduling a "forum" alert, and the integer | |
| 447 | -is the ID of a forum post, which you can find by visiting | |
| 448 | -<tt>/timeline?showid</tt> on your Fossil instance. | |
| 449 | - | |
| 450 | -The third command above is necessary because the | |
| 449 | +Manually create an email alert and push it out immediately. | |
| 450 | + | |
| 451 | +The <tt>f</tt> in the first command's final parameter means you're | |
| 452 | +scheduling a "forum" alert. The integer is the ID of a forum post, which | |
| 453 | +you can find by visiting <tt>/timeline?showid</tt> on your Fossil | |
| 454 | +instance. | |
| 455 | + | |
| 456 | +The second command above is necessary because the | |
| 451 | 457 | <tt>test-add-alerts</tt> command doesn't kick off a backoffice run. |
| 452 | 458 | |
| 453 | 459 | <verbatim> |
| 454 | 460 | $ fossil ale send |
| 455 | 461 | </verbatim> |
| 456 | 462 |
| --- www/forum.wiki | |
| +++ www/forum.wiki | |
| @@ -357,12 +357,12 @@ | |
| 357 | below. |
| 358 | |
| 359 | If you use the same user name and email address as you used for your |
| 360 | normal user login, Fossil will simply tie your alert preferences to your |
| 361 | login, and it will be considered already-verified. Otherwise, Fossil |
| 362 | will create up an alert-only record, and you will have to verify the |
| 363 | email address before Fossil will send notifications to it. |
| 364 | |
| 365 | This shows a key aspect of the way Fossil's email alerts system works, |
| 366 | by the way: a user can be signed up for email alerts without having a |
| 367 | full-fledged Fossil user account. Only when both user names are the same |
| 368 | are the two records tied together under the hood. |
| @@ -369,13 +369,13 @@ | |
| 369 | |
| 370 | |
| 371 | <h4>Test the Email Subsystem</h4> |
| 372 | |
| 373 | If you'd rather not create an inane "testing" post in your Fossil |
| 374 | instance just to force out an email alert, we can check whether the |
| 375 | email subsystem separate from the rest of the Fossil Email Alerts system |
| 376 | is working with the following command: |
| 377 | |
| 378 | <verbatim> |
| 379 | $ fossil alerts test-message [email protected] --body README.md --subject Test |
| 380 | </verbatim> |
| 381 | |
| @@ -391,12 +391,12 @@ | |
| 391 | <h4>Frist Post</h4> |
| 392 | |
| 393 | Since you've already edited the skin per [#skin | the instructions |
| 394 | above], you can click the "Forum" link in the navbar and create a new |
| 395 | post. I suggest taking the time to compose a suitable introductory |
| 396 | message especially for your project's forum, suitable for pointing new |
| 397 | forum users at. |
| 398 | |
| 399 | Wait a few seconds, and you should receive a notification email with the |
| 400 | post's subject and body text in the email. |
| 401 | |
| 402 | |
| @@ -434,22 +434,28 @@ | |
| 434 | This should also kick off the backoffice processing, if there are any |
| 435 | pending alerts to send out. |
| 436 | |
| 437 | <verbatim> |
| 438 | $ fossil alert pending |
| 439 | $ fossil test-add-alerts f5900 |
| 440 | $ fossil alert send |
| 441 | </verbatim> |
| 442 | |
| 443 | If the first command gives no output and <tt>pending-alerts</tt> in the |
| 444 | earlier command is 0, the second command will add another alert, which |
| 445 | should shortly cause another notification email. The <tt>f</tt> in the |
| 446 | final parameter means you're scheduling a "forum" alert, and the integer |
| 447 | is the ID of a forum post, which you can find by visiting |
| 448 | <tt>/timeline?showid</tt> on your Fossil instance. |
| 449 | |
| 450 | The third command above is necessary because the |
| 451 | <tt>test-add-alerts</tt> command doesn't kick off a backoffice run. |
| 452 | |
| 453 | <verbatim> |
| 454 | $ fossil ale send |
| 455 | </verbatim> |
| 456 |
| --- www/forum.wiki | |
| +++ www/forum.wiki | |
| @@ -357,12 +357,12 @@ | |
| 357 | below. |
| 358 | |
| 359 | If you use the same user name and email address as you used for your |
| 360 | normal user login, Fossil will simply tie your alert preferences to your |
| 361 | login, and it will be considered already-verified. Otherwise, Fossil |
| 362 | will create an alert-only record, and you will have to verify the email |
| 363 | address before Fossil will send notifications to it. |
| 364 | |
| 365 | This shows a key aspect of the way Fossil's email alerts system works, |
| 366 | by the way: a user can be signed up for email alerts without having a |
| 367 | full-fledged Fossil user account. Only when both user names are the same |
| 368 | are the two records tied together under the hood. |
| @@ -369,13 +369,13 @@ | |
| 369 | |
| 370 | |
| 371 | <h4>Test the Email Subsystem</h4> |
| 372 | |
| 373 | If you'd rather not create an inane "testing" post in your Fossil |
| 374 | instance just to force out an email alert, we can test the email |
| 375 | subsystem separately from the rest of the Fossil email alerts system |
| 376 | with the following command: |
| 377 | |
| 378 | <verbatim> |
| 379 | $ fossil alerts test-message [email protected] --body README.md --subject Test |
| 380 | </verbatim> |
| 381 | |
| @@ -391,12 +391,12 @@ | |
| 391 | <h4>Frist Post</h4> |
| 392 | |
| 393 | Since you've already edited the skin per [#skin | the instructions |
| 394 | above], you can click the "Forum" link in the navbar and create a new |
| 395 | post. I suggest taking the time to compose a suitable introductory |
| 396 | message especially for your project's forum, one which a new user would |
| 397 | find helpful. |
| 398 | |
| 399 | Wait a few seconds, and you should receive a notification email with the |
| 400 | post's subject and body text in the email. |
| 401 | |
| 402 | |
| @@ -434,22 +434,28 @@ | |
| 434 | This should also kick off the backoffice processing, if there are any |
| 435 | pending alerts to send out. |
| 436 | |
| 437 | <verbatim> |
| 438 | $ fossil alert pending |
| 439 | </verbatim> |
| 440 | |
| 441 | Show any pending alerts. The number of lines output here should equal |
| 442 | the [#status | status output above]. |
| 443 | |
| 444 | <verbatim> |
| 445 | $ fossil test-add-alerts f5900 |
| 446 | $ fossil alert send |
| 447 | </verbatim> |
| 448 | |
| 449 | Manually create an email alert and push it out immediately. |
| 450 | |
| 451 | The <tt>f</tt> in the first command's final parameter means you're |
| 452 | scheduling a "forum" alert. The integer is the ID of a forum post, which |
| 453 | you can find by visiting <tt>/timeline?showid</tt> on your Fossil |
| 454 | instance. |
| 455 | |
| 456 | The second command above is necessary because the |
| 457 | <tt>test-add-alerts</tt> command doesn't kick off a backoffice run. |
| 458 | |
| 459 | <verbatim> |
| 460 | $ fossil ale send |
| 461 | </verbatim> |
| 462 |