Using the Documentation

Hopefully, using the GridRepublic Documentation is easy. Here are a few things that might not be obvious, though.

Contents

How to Create an Article

There are two ways to create an article --

Create a link to an article that doesn't exist

When editing, if you insert a link to an article that doesn't exist, you will create a new article. (To create a link, select some text whlle editing a page, then click the "link" icon. In the "Insert Link" popup, select "Documentation" link, then enter the title of the article you want to create and click "Insert". After you click to "Save" your text, you'll see a link to your new article.

Search for a page that doesn't exist

If you use the "Search" function (via the "Search" tab in the left column of the community page layouts), and no matching article is found, you will be shown a "Create Article" button: click on this to create an article.


Edting Articles

Inserting Links

When editing an article, if you select text, you'll see that the "Insert link" icon becomes availale in the edit window toolbar. Click on this "Edit Link" and you'll see the "Insert Link" popup window. This window allows insertion of two kinds of links:

Link to Webpage

If you select the "Webpage" link option, then the popup allows you to provide any web address. When you click "insert", this address will be the "link to" address for the highlighted text.

Link to Documentation

If you select the "Documentation" link option then the popup expects an article title (for instance, the title of this article is "Using the Documentation"). When you click insert, the specified article will be the "link to" address for the highligted text. (Note: if there is no article with the provided title, one will be created. That is: creating a documentation link to an article that does not exist is a way to create an article.)


Try it out

If you're not quite sure about things, and you want to play around but don't want to mess up any "real" pages, try the Sandbox Page, which is there expressly for the purpose of trying things out. Add, edit, delete, whatever.