Help:Creating Troubleshooting Content
From DocWiki
| Line 1: | Line 1: | ||
Configuration examples should have consistent content. The following guidelines can help you create a configuration example. | Configuration examples should have consistent content. The following guidelines can help you create a configuration example. | ||
| - | ==Creating your | + | ==Creating your troubleshooting Page== |
| - | Type the name of your | + | Type the name of your troubleshooting topic into the '''search''' box. Use the following syntax: |
| - | '''<product name> <feature/description> | + | '''Troubleshooting<product name> <feature/description> ''' |
| - | For example, "Cisco Unity Express Networking with Direct IP Addressing | + | For example, "Troubleshooting Cisco Unity Express Networking with Direct IP Addressing" |
| - | If the | + | If the page does not exist, you will be prompted to create a page. Copy the source code at [[Template:Troubleshooting_Simple]] to your new page to develop your content. |
{{note|This template contains details that might not be applicable to your troubleshooting information. Please edit at your discretion.}} | {{note|This template contains details that might not be applicable to your troubleshooting information. Please edit at your discretion.}} | ||
Revision as of 22:27, 26 January 2011
Configuration examples should have consistent content. The following guidelines can help you create a configuration example.
Contents |
Creating your troubleshooting Page
Type the name of your troubleshooting topic into the search box. Use the following syntax:
Troubleshooting<product name> <feature/description>
For example, "Troubleshooting Cisco Unity Express Networking with Direct IP Addressing"
If the page does not exist, you will be prompted to create a page. Copy the source code at Template:Troubleshooting_Simple to your new page to develop your content.
 | Note: | This template contains details that might not be applicable to your troubleshooting information. Please edit at your discretion. |
Topology
The topology that you upload should be a JPEG or GIF file. Many tools provide icons for topologies. Cisco also provides icons at the Marketing Library.
Configuration Output
 | Caution: | Make sure that you scrub the IP addresses, domain names, and any other sensitive information. Examples of clean content are shown at DocWiki:No Proprietary Information. |
Examples should use preformatted text. Put your example in the following format:
<pre>Your configuration example text</pre>
Categories
Categories for Configuration Examples differ slightly from a regular article. For the most part, the paths for the categories are the same as for Cisco Products (see DocWiki:Categories). An additional layer of categories is placed right above the article so that troubleshooting information can be grouped together.
