2. Documentation

This section serves as an outline of the “what” and “how” of the RepoPro user documentation. It takes you through its composition and explains the conventions and definitions that you’ll come across in succeeding sections of the documentation.

2.1. How to use this manual

This document follows a section-wise approach with sub-sections, which runs into three-levels. There are links provided in parts of this document to ensure easy cross-referencing. The user can read the document from the beginning to the end to get a complete understanding of the product, or read a specific section and use cross-references to get familiar with any particular feature.

Here is a brief summary of the succeeding sections of this documentation:

  • General Information - a summarized overview of the basic concepts and core functions found in RepoPro
  • Getting Started - briefs you on how to get started, Common UI elements, navigation menu elements and the Home screen
  • Browse - explains the browsing processes that help find Asset Instances by Asset Types and Taxonomies
  • Repository Search - explains the search processes that help find Asset Instances quickly
  • Relationships - explains the rules and semantics associated with Relationships
  • Subscriptions - gives the steps necessary to subscribe to Asset Types, Asset Instances, and Taxonomies
  • Administer - explains how you can define the blueprints for centrally storing and managing information, classify based on Taxonomies and Tags, configure administration-related information and Miscellaneous Settings
  • Manage Asset Instances - gives the steps necessary to add, view, edit and delete Asset Instances
  • Import/Export Excel - takes you through the Import and Export processes used in RepoPro
  • Help Content - explains the steps necessary for creating Help content

2.2. Document Conventions

  • Notes are presented in the following manner:

    Note

    This is a note.

  • Warnings are presented in the following manner:

    Warning

    This is a warning.

  • Code blocks are presented in the following format:

    1
2
3
4
    import antigravity

def main():
    antigravity.fly()

  • “Property” and “Parameter” mean one and the same unless otherwise specified.

  • All product-related terms and general terms have Camel Case.

  • All headings and titles have Camel Case.

  • Browse Grid and View/Edit Asset Instance are names of the same screen.

  • Variable values that are system-generated or where user input is required, such as screen names and URLs are enclosed within angle brackets, i.e., <>.

  • Instruction steps that are not mandatory have been marked as “(optional)”.

  • External links and links in examples are shown in blue.