Public Documentation Search helps you find published documentation without opening each page manually. Use it when you are viewing a public documentation site and need to quickly locate a guide, publishing topic, or other published document.
Overview
Public Documentation Search is available from the published documentation experience. It searches documentation that has been made available to visitors, helping you move directly to relevant content instead of browsing through categories such as User Guides or Publishing.
This search is intended for readers of published documentation. Content must be in the Published state before it can be found through the public documentation search. Draft or unpublished material is not part of the public search experience.
You may encounter the public documentation area after selecting View Published Docs or 🌐 View Published Docs. From there, use the search control to look across the available published documentation.
📷 Screenshot pending: The published documentation page showing the View Published Docs option and the Search control.
Prerequisites
Before you start, make sure that:
- You have opened the public documentation site by selecting View Published Docs or 🌐 View Published Docs.
- The documentation you need has been published and is available to public visitors.
- You know one or more words related to the document you want to find, such as its title, subject, or feature name.
- You have access to a browser and an internet connection.
Step-by-Step Instructions
-
Click View Published Docs to open the public version of the documentation.
-
Click Search to open the public documentation search window.
-
Click the Search docs... field.
-
Type a word or phrase that describes the documentation you need.
-
Review the matching published documentation shown by the search window.
-
Click the document result that best matches your search.
-
Read the selected published documentation page.
📷 Screenshot pending: The Public Documentation Search window with the Search docs... field and matching published documentation results.
-
Click Search again when you want to start a new search.
-
Click the Search docs... field to replace your previous search text.
-
Type a more specific word or phrase to narrow the matching documents.
-
Click a different result if the first document does not answer your question.
Tips and Best Practices
-
Use specific terms whenever possible. For example, search for Publishing when you need publishing-related instructions instead of entering a broad term that may match many documents.
-
Search with words that are likely to appear in the document title or main topic. If you are looking for a manual, try the product area or task name rather than a full sentence.
-
Confirm that you are in the public documentation area before searching. The Search docs... field is for published documentation, while other search fields, such as Search across all projects..., Search projects..., Search documents..., or Search entities..., may be used in other areas of the application for different types of information.
-
If you cannot find a document, try a shorter search phrase. Then add another relevant term if the result list is too broad.
-
Use the navigation categories, such as User Guides and Publishing, when you know the general area but do not know the exact document name.
-
Remember that public search is limited to content marked Published. If a document is still being prepared, it will not appear to public visitors until it is published.
Related Pages
- View Published Documentation
- Publish Documentation
- Browse User Guides
- Search and Filter Documentation
- Export Documentation
Troubleshooting
No matching documentation appears
Check the spelling of your search terms and try a shorter or more general phrase. For example, search for Publishing instead of a long sentence describing the issue.
A document you expect is missing
Public Documentation Search shows published content. Ask the documentation owner to confirm that the document is marked Published and is available in the public documentation site.
You see a different search field
Make sure you opened View Published Docs before searching. Fields such as Search across all projects..., Search projects..., and Search entities... search other application areas rather than the published documentation available to visitors.
Was this page helpful?