Support Search

Site Tips


    Site Summary

    The RightScale Support site is designed to be both flexible and powerful in the way you gain access to the information needed.  Some will find browsing most effective.  Others might use our powerful search engine with advanced options to pin point their specific content needs.  Here are other  basic tips on using the RightScale Support Portal.

    Support Home

    "Support" in the blue header directs you back to our Support Home Page.  (http://support.rightscale.com)

    So does the first entry in the breadcrumb below the header.  (RightScale Support > OtherBreadCrumbs > ...)

    Search

    Global Search

    screen-CorpWebSiteHeader.png

    The SEARCH button in the upper right is a Global Site Search (searches our support site and all of its documentation, our Blog, Forums, etc.) and is exactly the same throughout www.rightscale.com.

    Support Search

    Standard

    screen-SupportSearch.png

    The Find button in the Support Search window searches the Support site only.  The advanced options are easy to use, yet very powerful.
    The checkbox allows you to restrict the search from the current hierarchy of the Support site and down.  For example, FAQS only.  Notice as you navigate about our site, the path by the checkbox changes to reflect the current area you are browsing.

    The Support Search uses the Lucene Search Engine.  It is fully documented here.  Here are a few basic but practical examples you can submit right from the standard Find:

    ssh AND tag:faq  - Find all FAQs with "ssh" in them.  (Note:  AND is case sensitive)

    haproxy AND tag:tutorial AND tag:advanced - Find all advanced tutorials with "haproxy" in them

    Advanced

    Use the Advanced Search and fill out the forms as needed. Take advantage of the power of the Lucene search engine without having to learn its syntax.  For example:

    All of these words:  Elastic load balancer

    User level: intermediate

    Doc type: tutorial

    Will find all intermediate tutorials on our Support Site that contain the words "elastic" and "load" and "balancer".  If you want to find those three words literally run together, place them in double quotes.  That is, change the Search query slightly like this:

    All of these words:  "Elastic load balancer"

    Note that having a pattern surrounded in double quotes can have a subtle effect on the search results.  Searching for "create credentials" will produce different results than simply create credentials.  Surrounding it in quotes searches on the entire phrase.

    Site Map or Alphabetic Index

    Check out the Site Map in the Useful Links section.  You can find things there by browsing about, or using your browser search function.  By default, a full hierarchical map is displayed.  However, you can also build out a full alphabetic index of the entire Support Portal.

    Metadata (or tags)

    screen-Tags-v1.pngWe attach metadata to our documents so that your search options are easy to use, yet powerful.  Each document has been tagged with metadata and falls within the following categories:

    User Level

    Although subjective, we have tried to categorize with the following levels:

    • beginner
    • intermediate
    • advanced

    Document Type

    Each type of document contains a consistent set of elements so that you can quickly and easily view the document and make sense of it.  The look and feel of each document is consistent and repeatable, improving your learning experience.

    • tutorial - Step by step procedures to accomplish a specific task.  They range from beginner tutorials that may take a few minutes, to more advanced tutorials that can take hours as you build them up over time.  Tutorials consist of a clearly stated objective, prerequisites (if any), background or overview level information and the steps required to complete the objective.
    • concept - Conceptual information.  Concept documents answer the question "What is a ...?"
    • reference - Reference information usually takes the shape of lists or tables.
    • FAQ - Frequently Asked Questions.  Our FAQs have a basic numeric ID.  You can locate FAQs by the ID, browsing the document title, or using our Search engine.  (e.g. Show me all FAQs containing the word "haproxy")  FAQs generally answer the question "How do I ...?"  They tend to be tighter scoped than tutorials.
    • RN - Release Notes.  We have designed a special templates for our Release Notes to make sure they are easy to access, navigate, and read.  Our Release Notes are split into two primary types: 
      1. Cloud Management Platform  (e.g. the Dashboard)
      2. ServerTemplates.

    Note:  Most, but not all documents have been tagged with this metadata.  The effort to categorize appropriate documents is still underway.

    Remember the Breadcrumbs!

    Although our new Support Portal is browseable, many will find content via the Support Search.  Our documentation is more modular in its approach, leveraging easy to read templates tied to the document type (tutorial, reference, concept, etc).  When finding content via the Support Search, the breadcrumbs are always displayed.  That way even if you did not browse to the document, you can get to the parent directory with one mouse click.

     For example, consider the following progression with respect to  SQS queues:

    • Support Search:  create a new SQS queue
    • Number one hit is:  Creating a New Queue
    • It turns out, creating a SQS queue really doesn't discuss the policy part of the queue you were looking for...
    • Breadcrumb is: 

      screen-Breadcrumb-v1.png

    • So you select the parent directory in the breadcrumb (Simple Queue Service).
    • The parent page contains a link that contains the information you're looking for:  Adding a Statement to a Queue Policy

    In summary, remember the breadcrumbs (and the parent directory)!

    Header and Footer

    The Header and the Footer of the Support site is consistent with the rest of our corporate website:  http://www.rightscale.com.

    Icons

    Printer Icon 

    Selecting the printer icon enables you to print the current document you are viewing.  You also have the option to save it as a PDF file.  For Tutorials in particular, you may find this helpful.  Feel free to print out a more involved Tutorial so you can mark it up with notes as progress through it.

     

    Notification Icon

    All of our documentation is open and viewable.  You do not need to create an account and "login" to view anything on our Support site.  However, there is one feature that you can only gain access to if you create a free account and login:  Notifications

    When you select the Notification icon, you are given the following notification choices:

    screen-NotificationsOn-v1.png

    Notifications are sent to the email address that you specified when you signed up for your account.  As an example use case, you could set a notification for any time a new Release Note is created or modified.

    Logging In and Logging Out

    By design, we made this unobtrusive.  Most won't need to login at all, so we tucked it away at the bottom of the page.  You'll find the links to login or logout at the very bottom left of any page in our site.  When you login, you can click the "My Page" link to go to a page that is reserved for your use only. You can use this page to keep your own notes about the documentation.

    Important!  Due to spam account creations, we have disabled the ability to create your own account on the Support Portal.  You will have to reach Services to get an account created.  The primary benefit in doing this is the ability to get email notifications on pages you want to track changes on.

    Site Feedback

    See any errors with our site or documentation set?   Have any comments or questions?  Let us know!  (We want to help!)  You can use the "Site Feedback" link in the Useful Links window.  Your comments will get routed directly to our documentation team. 

    Important!  This is not for booking product Support related tickets, just comments on the site or documentation set.  See the Get Support button on the Support home page for more information on Support Services.

    Support Portal Tutorial

    After you have looked over this document, put into practice several tips listed here by completing a basic Support Portal Tutorial.

    Powered by MindTouch