1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/contributing_to_docs/templates/overview_topic_template.adoc
Vikram Goyal d3e3233ae9 Initial Commit
2018-05-29 11:28:00 +10:00

33 lines
1.1 KiB
Plaintext

[[contributing-to-docs-templates-overview-topic-template]]
= Overview
{product-author}
{product-version}
:icons: font
:experimental:
Start with a clear introduction to the topic directory/category of topics and what information customers can expect to find in the included topics
////
////
== Quick Links
////
This section is a way to provide quick links to popular topics that we think will be of most interest to our customers. The example below would be in the Overview topic of the Administration Guide, and shows links to the Managing Nodes topic in that topic category. Note that this is just one example to show how we can help customers to find the information they need. This section may or may not be required. Use the table below as a template and remove this text.
////
[option="header"]
|===
|How do I? |Links to relevant topics
.^|Add, view, or delete nodes in my OpenShift environment
a|link:../admin_guide/manage_nodes.html#adding-nodes[Add a node]
link:../admin_guide/manage_nodes.html#viewing-nodes[View a node]
link:../admin_guide/manage_nodes.html#deleting-nodes[Delete a node]
|Do something else as an admin
|Link to topic(s)