Documentation Portal Introduced

Version 49.1 by Erik Bakker on 2024/07/29 07:58

In this microlearning, we will introduce the eMagiz documentation platform. The focus will be to address the fundamental concepts of the documentation platform. Please refer to other Fundamentals to learn more about related items and look at the relevant microlearnings available to learn how to work in eMagiz.

Should you have any questions, please get in touch with academy@emagiz.com.

1. Prerequisites

  • An interest in learning more about the eMagiz platform.

2. Key concepts

All concepts are discussed in the section below.

3. Introducing the eMagiz documentation platform

The eMagiz documentation platform is an add-on to the eMagiz platform. Within the documentation portal, we have four distinct categories of information for you to utilize. Should this be your first visit to the eMagiz documentation portal, we urge you to check out the tour. You can start this tour from the home page by clicking the "Show tour" icon in the bottom right-hand corner of your screen.

3.1 Academy

In this segment, you can learn about the platform. To make your learning experience manageable, we have divided this segment into three categories. It starts with the Fundamental section that explains the eMagiz platform, the documentation portal, and the critical features of the eMagiz platform for you to utilize. 

On top of that, we have the Microlearnings section that explains all components of the platform from a user perspective (i.e., what do I need to do to act eMagiz) in bite-size pieces. This section divides the knowledge into various levels from Platform & Pattern Crash Courses to courses per level of experience in the platform (i.e. Novice Level - eMagiz) so you can learn to use the platform in a structured way.

This section, in addition to the learnings, details our certification program, including the requirements and how to sign up for a certification.

3.2 Store

This segment documents all store components managed by eMagiz. We have divided these store items into two categories called accelerators and system connectors. Here, you can browse through (and search for) specific store solutions that you can use within your model. If you want more information on the store, please check out this fundamental.

3.3 Support

This segment houses information that supports you in case you need to migrate via the help of our migration paths and in case you are facing a problem in one of your environments, via the help of our RCA knowledge base. On top of that, we provide an easy link to our support portal when you need to register a ticket with our support department. If you are still determining whether you need to register our ticket or communicate another way, please check out this fundamental.

3.4 Release Information

This segment houses all our release information on the platform. Here, the technical release notes of the eMagiz platform, our infrastructure, and our cloud as well as more functional release blogs on the platform and the documentation portal. This category intends to inform our users of what changes in every release so they can adapt.

3.4 Navigation

There are three ways to navigate the documentation portal. For each example, we are going to navigate to the list of bi-weekly published release notes. The first one is by clicking through the various cards to get to the right information, as shown below.

Secondly, use the breadcrumb navigation at the top of the page to get to the exact location, as shown below.

Thirdly, you can use the navigation on the left of the page to get to the desired location.

3.5 Search

If you are new, need help navigating, or need help figuring out exactly where to look, you can use the documentation portal's search functionality by entering key phrases. You can access the search functionality at the top-left corner of your page by typing in a keyphrase and pressing Enter. This will lead you to an overview of your search results. Once you have found the information in question, you can click on the result to navigate to that page.

  • The search searches through all information available on the documentation portal.
  • Once you are in the search overview, you can drill down to specific parts of the documentation portal (as demonstrated in the video)
  • Searching for partial words will not result in any hits.
  • In the above video, I could also have clicked directly on the link to "New Equilibrium"

4. Key takeaways

  • The eMagiz documentation platform is an add-on to the eMagiz platform
  • It consists of four main categories of information
    • Academy
    • Store
    • Support
    • Release Information
  • You can follow a tour to understand better how to navigate the eMagiz documentation portal.

5. Suggested Additional Readings