Last modified by Erik Bakker on 2024/09/02 16:11
Show last authors
1 {{container}}{{container layoutStyle="columns"}}(((
2 Check out the eMagiz documentation platform, which is an add-on to the eMagiz platform. It contains four categories of information, including the Academy, Store, Support, and Release Information. Each category offers valuable resources to help you make the most of the eMagiz platform. On top of that, we guide you through the different ways to navigate the documentation portal and teach you how to use the search functionality. This will make it easier for you to find what you need.
3
4 Should you have any questions, please get in touch with academy@emagiz.com.
5
6 == 1. Prerequisites ==
7 * An interest in learning more about the eMagiz platform.
8
9 == 2. Key concepts ==
10 * Providing information about the eMagiz documentation platform.
11
12 == 3. Introducing the eMagiz documentation platform ==
13
14 The eMagiz documentation platform is an add-on to the [[eMagiz platform>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-introduction.WebHome||target="blank"]]. 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.
15
16 === 3.1 Academy ===
17
18 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>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]] section that explains the eMagiz platform, the documentation portal, and the critical features of the eMagiz platform for you to utilize.
19
20 On top of that, we have the [[Microlearnings>>doc:Main.eMagiz Academy.Microlearnings.WebHome||target="blank"]] 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>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]] to courses per level of experience in the platform (i.e. [[Novice Level - eMagiz>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]) so you can learn to use the platform in a structured way.
21
22 This section, in addition to the learnings, details our [[certification program>>doc:Main.eMagiz Academy.Get Certified.WebHome||target="blank"]], including the requirements and how to sign up for a certification.
23
24 === 3.2 Store ===
25
26 This segment documents all store components managed by eMagiz. We have divided these store items into two categories called [[accelerators>>doc:Main.eMagiz Store.Accelerators.WebHome||target="blank"]] and [[system connectors>>doc:Main.eMagiz Store.System Connectors.WebHome||target="blank"]]. 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>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-store.WebHome||target="blank"]].
27
28 === 3.3 Support ===
29
30 This segment houses information that supports you in case you need to migrate via the help of our [[migration paths>>doc:Main.eMagiz Support.Migration Paths.WebHome||target="blank"]] and in case you are facing a problem in one of your environments, via the help of our [[RCA knowledge base>>doc:Main.eMagiz Support.RCA Knowledge Base.WebHome||target="blank"]]. 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>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-assistance-needed.WebHome||target="blank"]].
31
32 === 3.4 Release Information ===
33
34 This segment houses all our release information on the platform. Here, the technical [[release notes>>doc:Main.Release Information.Portal.WebHome||target="blank"]] of the eMagiz platform, our [[infrastructure>>doc:Main.Release Information.Runtime Images.WebHome||target="blank"]], and our [[cloud>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]] as well as more functional release blogs on the [[platform>>doc:Main.Release Information.Release Blogs.WebHome||target="blank"]] and the [[documentation portal>>doc:Main.Release Information.Documentation Portal.WebHome||target="blank"]]. This category intends to inform our users of what changes in every release so they can adapt.
35
36 === 3.4 Navigation ===
37
38 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.
39
40 {{video attachment="left-panel-navigation-doc-portal.mp4" reference="Main.Videos.Fundamental.WebHome"/}}
41
42 Secondly, use the breadcrumb navigation at the top of the page to get to the exact location, as shown below.
43
44 {{video attachment="breadcrumb-navigation-doc-portal.mp4" reference="Main.Videos.Fundamental.WebHome"/}}
45
46 Thirdly, you can use the navigation on the left of the page to get to the desired location.
47
48 {{video attachment="card-navigation-doc-portal.mp4" reference="Main.Videos.Fundamental.WebHome"/}}
49
50 === 3.5 Search ===
51
52 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.
53
54 {{video attachment="search-functionality-doc-portal.mp4" reference="Main.Videos.Fundamental.WebHome"/}}
55
56 {{info}}
57 * The search searches through all information available on the documentation portal.
58 * Once you are in the search overview, you can drill down to specific parts of the documentation portal (as demonstrated in the video)
59 * Searching for partial words will not result in any hits.
60 * In the above video, I could also have clicked directly on the link to "New Equilibrium"{{/info}}
61
62 == 4. Key takeaways ==
63
64 * The eMagiz documentation platform is an add-on to the [[eMagiz platform>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-introduction.WebHome||target="blank"]]
65 * It consists of four main categories of information
66 ** Academy
67 ** Store
68 ** Support
69 ** Release Information
70 * You can follow a tour to understand better how to navigate the eMagiz documentation portal.
71
72 == 5. Suggested Additional Readings ==
73
74
75 * [[Home (Menu)>>doc:Main.WebHome||target="blank"]]
76 * [[Academy (Menu)>>doc:Main.eMagiz Academy.WebHome||target="blank"]]
77 ** [[Fundamental (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
78 *** [[eMagiz Platform (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-introduction.WebHome||target="blank"]]
79 *** [[Support (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-assistance-needed.WebHome||target="blank"]]
80 *** [[Store (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-store.WebHome||target="blank"]]
81 ** [[Microlearnings (Menu)>>doc:Main.eMagiz Academy.Microlearnings.WebHome||target="blank"]]
82 *** [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
83 *** [[Novice Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
84 ** [[Certification Program (Explanation)>>doc:Main.eMagiz Academy.Get Certified.WebHome||target="blank"]]
85 * [[Store (Menu)>>doc:Main.eMagiz Store.WebHome||target="blank"]]
86 ** [[Accelerators (Navigation)>>doc:Main.eMagiz Store.Accelerators.WebHome||target="blank"]]
87 ** [[System Connectors (Navigation)>>doc:Main.eMagiz Store.System Connectors.WebHome||target="blank"]]
88 * [[Support (Menu)>>doc:Main.eMagiz Support.WebHome||target="blank"]]
89 ** [[Migration Paths (Navigation)>>doc:Main.eMagiz Support.Migration Paths.WebHome||target="blank"]]
90 ** [[RCA Knowledge Base (Navigation)>>doc:Main.eMagiz Support.RCA Knowledge Base.WebHome||target="blank"]]
91 * [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
92 ** [[Release Notes (Navigation)>>doc:Main.Release Information.Portal.WebHome||target="blank"]]
93 ** [[Release Blogs (Navigation)>>doc:Main.Release Information.Release Blogs.WebHome||target="blank"]]
94 ** [[Runtime Images (Navigation)>>doc:Main.Release Information.Runtime Images.WebHome||target="blank"]]
95 ** [[Cloud Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
96 ** [[Documentation Portal (Navigation)>>doc:Main.Release Information.Documentation Portal.WebHome||target="blank"]]
97 * [[Documentation (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=runtime+level||target="blank"]]
98
99 )))((({{toc/}}))){{/container}}{{/container}}