joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 01:36:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

events_notes_alerts: Fix formatting of alerts docs

Browse source
This commit is contained in:
Will Binns 2017-03-26 07:35:20 -06:00
parent 400c0c47bd
commit 346fd13b61
No known key found for this signature in database
GPG key ID: 302EBEAEEB74A404
1 changed files with 33 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/adding-events-release-notes-and-alerts.md
View file

@ -191,30 +191,24 @@ addresses are on the linked GitHub profiles.
<https://bitcoin.org/en/alert/YYYY-MM-DD-short-title>).
2. Paste the following text into the top of the file:
```
---
## Title displayed on alert page
title: "11/12 March 2013 Chain Fork"
title: "11/12 March 2017 Chain Fork"
## Short URL for use in P2P network alerts: https://bitcoin.org/<shorturl>
shorturl: "chainfork"
## Active alerts will display the banner (below) on all bitcoin.org content
pages
## Active alerts will display the banner (below) on all bitcoin.org content pages
active: true
## Banner displayed if 'active: true'. Can use HTML formatting
banner: "<b>Chain fork</b> - Please stop mining on bitcoin version 0.8.0.
Click here for more information."
## Banner displayed if 'active: true'. Can use HTML formatting banner: "<b>Chain fork</b> - Please stop mining on bitcoin version 0.14.1. Click here for more information."
## Date of the alert in YYYY-MM-DD format
date: 2015-03-11
date: 2017-03-11
---
{% comment %}
First paragraph should indicate whose bitcoins are safe, to avoid
starting a panic.
First paragraph should indicate whose bitcoins are safe, to avoid starting a panic.
{% comment %}
Your bitcoins are safe if you received them in transactions
confirmed before 2015-07-06 00:00 UTC.
Your bitcoins are safe if you received them in transactions confirmed before 2015-07-06 00:00 UTC.
{% comment %}
Second paragraph should summarize the problem, and subsequent
@ -232,7 +226,7 @@ Click here for more information."
please see this note.
```
- Edit the file. It is written in [Markdown format][].
- Edit the file. It is written in [Markdown format](https://guides.github.com/features/mastering-markdown/).
- Commit it.
@ -263,7 +257,7 @@ The following fields may be defined in the the alert YAML header:
```yaml
---
## (Required; HTML text) Title displayed on alert page
title: "11/12 March 2013 Chain Fork"
title: "11/12 March 2017 Chain Fork"
## (Optional; display ASCII only) Short URL for use in P2P network alerts:
https://bitcoin.org/<shorturl>
shorturl: "chainfork"
@ -272,7 +266,7 @@ all bitcoin.org content pages
active: true
## (Optional; HTML text) Banner displayed if 'active: true'. Can use HTML
formatting
banner: "<b>Chain fork</b> - Please stop mining on bitcoin version 0.8.0. Click
banner: "<b>Chain fork</b> - Please stop mining on bitcoin version 0.14.1. Click
here for more information."
## (Optional; default=alert) CSS class to set banner color
## alert = red | warning = orange | success = green | info = blue
@ -287,7 +281,7 @@ the document:
```html
<div style="text-align:right">
<i>This notice last updated: Thu, 16 May 2013 01:37:00 UTC</i>
<i>This notice last updated: Thu, 16 May 2017 01:37:00 UTC</i>
</div>
```