Search Published Documentation

Use portal search to quickly find published user documentation, technical guides, and API references. Searching helps you reach the information you need without browsing through every documentation section.

Overview

Published documentation is the documentation made available through the public documentation portal. You can use it to locate user-facing guides, technical content, and API reference material that has been published for viewing.

To begin a search, open the published documentation area by selecting View Published Docs or 🌐 View Published Docs, depending on where you access documentation in Atloria. In the portal, select Search to open the documentation search experience.

The search field is labeled Search docs.... Enter words or phrases that describe the information you need, such as a feature name, integration topic, endpoint concept, or user task. Use specific terms when possible to narrow your results.

📷 Screenshot pending: The published documentation portal showing the Search option and the View Published Docs entry point.

Search terms at a glance

Published documentation

Documentation that is available to view through the public documentation portal.

User documentation

Guides intended to help people use a product or feature.

Technical guides

Documentation that explains technical concepts, system details, or implementation-related information.

API references

Reference material for available APIs and their related resources.

Prerequisites

Before you start, make sure you have the following:

• Access to the Atloria published documentation portal.
• A published documentation site to search.
• A keyword, phrase, feature name, project name, or technical term related to the information you need.
• A stable internet connection so search results and documentation pages can load.
• If you are searching internal project documentation, access to the relevant project and its Technical Docs or User Docs area.

Step-by-Step Instructions

1. Open the published documentation portal.

   From the available documentation navigation, select View Published Docs or 🌐 View Published Docs.

   If you are working from a project, you may first see documentation options such as User Docs and Technical Docs. Select the appropriate area, then choose View Published Docs when it is available.

2. Open search.

   In the published documentation portal, select Search.

   The search interface opens and displays the Search docs... field.

   📷 Screenshot pending: The documentation search interface with the Search docs... field ready for a query.

3. Enter a search query.

   Click the Search docs... field and type a word or phrase that matches the documentation you want to find.

   For example, you can search for:

   • A user task, such as “export”
   • A documentation type, such as “API”
   • A subject area, such as “authentication”
   • A project-specific feature or product term
   • A technical concept, such as “database” or “configuration”

4. Review the matching documentation.

   Look through the returned results for titles and topics that best match your query. Published content can include materials associated with User Guides, Guides, and Technical documentation.

   If the first search does not return the content you expected, revise your query using a more specific phrase. For example, search for a feature name instead of a broad category.

5. Open the documentation you need.

   Select a result to open its published documentation page. Review the page content and use the portal navigation to continue to related guides or references as needed.

6. Search again when you need another topic.

   Select Search again and replace the text in Search docs... with a new query. You can use the same search workflow to move between user documentation, technical guides, and API reference topics.

Tips and Best Practices

• Start with specific terms. Search for the exact feature, capability, or project term you know. A search for “export documentation” is more likely to be useful than a search for “documentation.”

• Use the documentation category as a clue. If you want task instructions, look for results under User Guides or Guides. If you need system or implementation information, focus on Technical results.

• Try alternate terminology. Documentation may use a different term than the one you use day to day. If “login” does not help, try “authentication,” “access,” or the name of the relevant feature.

• Search by project context when necessary. When similar topics exist across multiple projects, include the project name or a distinguishing feature in your query.

• Use published documentation for viewable content. The published portal is intended for finding material that has been made available for viewing. If you need to work with project documentation directly, use the project’s User Docs or Technical Docs area instead.

• Keep queries concise. Begin with two to four meaningful words. If needed, add another term to make the query more precise.

Related Pages

• View Published Documentation
• Browse User Guides
• Use Technical Docs
• Read API References
• Export Documentation
• Search Across Projects

Troubleshooting