Help:Web portal tutorial guidelines
From TBwiki
(Difference between revisions)
(add category) |
(Add tips) |
||
| Line 9: | Line 9: | ||
== Web portal tutorial convention == | == Web portal tutorial convention == | ||
| + | |||
| + | The following are mandatory when describing web procedures. | ||
=== Page title === | === Page title === | ||
* Toolpack version number are no longer in the title | * Toolpack version number are no longer in the title | ||
| − | + | Example | |
| − | + | ||
| − | + | ||
Toolpack:Creating_a_New_Gateway_Configuration_A | Toolpack:Creating_a_New_Gateway_Configuration_A | ||
| Line 26: | Line 26: | ||
=== Page content === | === Page content === | ||
| − | * First sentence contains Toolpack version | + | * '''First''' sentence contains Toolpack version |
=== '''''Applies to version(s): v2.5, v2.6.''''' === | === '''''Applies to version(s): v2.5, v2.6.''''' === | ||
Wiki code | Wiki code | ||
| Line 33: | Line 33: | ||
* Set display title (Note that the version is not present) | * Set display title (Note that the version is not present) | ||
<nowiki>{{DISPLAYTITLE:Creating an IP Port Range}}</nowiki> | <nowiki>{{DISPLAYTITLE:Creating an IP Port Range}}</nowiki> | ||
| + | |||
| + | === Tips === | ||
| + | |||
| + | *Split your procedures into several steps [[Web_Portal_Tutorial_Guide_v2.5#Configuring_SS7|Example:Configuring the ISUP Layer]] | ||
| + | *Add screen shots with red circles or squares [[Toolpack:Creating_SS7_Point_Codes_A|Example: Creating SS7 Point Codes]] | ||
[[Category:Help]] | [[Category:Help]] | ||
Revision as of 15:48, 24 July 2012
TelcoBridges support multiple versions simultaneously. We are therefore forced to maintain multiple procedures because of interface changes.This goes somewhat against the wiki philosophy where you always have the latest and the greatest.
The following naming convention takes into consideration:
- Support multiple versions of the same procedure
- Avoid duplication of the same content
- Relevant page title
- Quickly know which version a page applies
Contents |
Web portal tutorial convention
The following are mandatory when describing web procedures.
Page title
- Toolpack version number are no longer in the title
Example
Toolpack:Creating_a_New_Gateway_Configuration_A
- Versions of the same page are identify with letters
First version of the procedure
Toolpack:Creating_a_New_Gateway_Configuration_A
Second version
Toolpack:Creating_a_New_Gateway_Configuration_B
Page content
- First sentence contains Toolpack version
=== Applies to version(s): v2.5, v2.6. ===
Wiki code
=== '''''Applies to version(s): v2.5, v2.6.''''' ===
- Set display title (Note that the version is not present)
{{DISPLAYTITLE:Creating an IP Port Range}}
Tips
- Split your procedures into several steps Example:Configuring the ISUP Layer
- Add screen shots with red circles or squares Example: Creating SS7 Point Codes
