Template: SPOF
(Create SPoF marker for GNU consensus software) |
(Use all-caps consistently) |
||
Line 1: | Line 1: | ||
<noinclude> | <noinclude> | ||
− | = GNU Consensus Marker: <abbr title="Single Point of Failure"> | + | = GNU Consensus Marker: <abbr title="Single Point of Failure">SPOF</abbr> = |
[[GNU/consensus/markers]] are used to indicate existing or potential issues that need to be addressed. | [[GNU/consensus/markers]] are used to indicate existing or potential issues that need to be addressed. | ||
Interested contributors can access a description of the problem, current issues, and related developer discussion. | Interested contributors can access a description of the problem, current issues, and related developer discussion. | ||
− | The Single Point of Failure marker indicates that the system can be compromised if this | + | The Single Point of Failure marker indicates that the system can be compromised if this SPOF is compromised. Usually SPOFs lead to denial of service and can negate the properties of a system (e.g., de-anonymizing users if the software provides anonymity). |
== Usage == | == Usage == | ||
Line 21: | Line 21: | ||
{{SPOF}} | {{SPOF}} | ||
− | == List of Pages with the | + | == List of Pages with the SPOF Marker == |
− | {{#ask: [[Category:Software]] | [[Category: | + | {{#ask: [[Category:Software]] | [[Category:SPOF]] | limit=0 | searchlabel=See a list of all pages marked with SPOF. }} |
== SPOF == | == SPOF == | ||
Line 37: | Line 37: | ||
<div class="gnu consensus marker spof" | <div class="gnu consensus marker spof" | ||
style="border: 1px solid red; border-left-width: 1rem; padding: 0.1rem 0.5rem; width: 5rem;"> | style="border: 1px solid red; border-left-width: 1rem; padding: 0.1rem 0.5rem; width: 5rem;"> | ||
− | [[{{{1|#SPOF}}}|<abbr title="Single Point of Failure"> | + | [[{{{1|#SPOF}}}|<abbr title="Single Point of Failure">SPOF</abbr>!]] |
</div> | </div> | ||
[[Category:Software|Software]] | [[Category:Software|Software]] | ||
− | [[Category: | + | [[Category:SPOF|SPOF]] |
</includeonly> | </includeonly> |
Revision as of 06:51, 20 December 2015
Contents
GNU Consensus Marker: SPOF
GNU/consensus/markers are used to indicate existing or potential issues that need to be addressed. Interested contributors can access a description of the problem, current issues, and related developer discussion.
The Single Point of Failure marker indicates that the system can be compromised if this SPOF is compromised. Usually SPOFs lead to denial of service and can negate the properties of a system (e.g., de-anonymizing users if the software provides anonymity).
Usage
Use all-caps!
{{SPOF}} will link to a #SPOF section in the same page.
{{SPOF PageName}} will link to a specific page detailing the issue.
The SPOF section or page can be created using a form. (TODO: add link to this form)
Example
List of Pages with the SPOF Marker
See a list of all pages marked with SPOF.
SPOF
Example section for the example. This section would:
- describe the problem
- describe what the project is doing to address it
- list issues related to this problem
- link to developer discussion about it