Skip to Content
Last modified by Erik Bakker on 2024/09/02 16:11
From version 43.1
edited by Erik Bakker
on 2024/02/01 10:05
Change comment: There is no comment for this version
To version 51.1
edited by Erik Bakker
on 2024/07/30 16:44
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,51 +1,95 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -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.
2 +Discover the power of the eMagiz documentation platform, an essential add-on to the eMagiz platform. With four distinct categories of information, including Academy, Store, Support, and Release Information, this platform offers a wealth of resources to help you make the most of eMagiz. Whether you're a beginner or an experienced user, the Academy segment provides comprehensive learning materials, including fundamental knowledge, microlearnings, and certification programs. Explore the Store section to access a variety of store components, including accelerators and system connectors to enhance your model. The Support segment offers invaluable resources such as migration paths, RCA knowledge base, and a support portal to address any concerns. Stay up to date with the latest platform changes and releases in the Release Information section. Plus, easily navigate the documentation portal and find relevant information using the intuitive search functionality. Join the eMagiz documentation portal today and elevate your eMagiz experience!
3 3  
4 4  Should you have any questions, please get in touch with academy@emagiz.com.
5 5  
6 6  == 1. Prerequisites ==
7 -* An interest to learn more about the eMagiz platform.
7 +* An interest in learning more about the eMagiz platform.
8 8  
9 9  == 2. Key concepts ==
10 -All concepts are discussed in the section below.
10 +* Providing information about the eMagiz documentation platform.
11 11  
12 -== 3. Introducing eMagiz documentation platform ==
12 +== 3. Introducing the eMagiz documentation platform ==
13 13  
14 -The eMagiz documentation platform is an add-on on top of 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. This tour can be started from the home page by clicking the "Show tour" icon in the bottom-hand right corner of your screen.
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 15  
16 16  === 3.1 Academy ===
17 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 key features from the eMagiz platform for you to utilize. 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 perform an action in eMagiz) in bite size pieces. In this section we divide the knowledge into various levels (from [[Crash Course>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]] to [[Microlearnings>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]) and courses (i.e. [[this>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]) so you can learn to use the platform in a structured way.
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 19  
20 -Apart from the learnings you can find in this section it also details our [[certification program>>doc:Main.eMagiz Academy.Get Certified.WebHome||target="blank"]], including requirements and how to sign-up for a certification.
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 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 +
22 22  === 3.2 Store ===
23 23  
24 -This segment documents all store components managed by eMagiz. For your convenience we have divided these store items into two distinct categories called [[accelerators>>doc:Main.eMagiz Store.Accelerators.WebHome||target="blank"]] and [[system connectors>>doc:Main.eMagiz Store.System Connectors.WebHome||target="blank"]]. In 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 [[eMagiz platform>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-store.WebHome||target="blank"]].
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"]].
25 25  
26 26  === 3.3 Support ===
27 27  
28 -This segment houses information that support 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 in case you need to register a ticket with our support department. In case you are unsure whether you need to register our ticket or communicate in another way please check out this [[eMagiz platform>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-assistance-needed.WebHome||target="blank"]].
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"]].
29 29  
30 30  === 3.4 Release Information ===
31 31  
32 -This segment houses all our release information on the platform. Here you can find the technical release notes of the [[eMagiz platform>>doc:Main.Release Information.Portal.WebHome||target="blank"]], 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"]]. The intent of this category is to inform our users of what is changed in every release so they can adapt to this.
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.
33 33  
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 +
34 34  == 4. Key takeaways ==
35 35  
36 -* The eMagiz documentation platform is an add-on on top of the [[eMagiz platform>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-introduction.WebHome||target="blank"]]
64 +* The eMagiz documentation platform is an add-on to the [[eMagiz platform>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-introduction.WebHome||target="blank"]]
37 37  * It consists of four main categories of information
38 38  ** Academy
39 39  ** Store
40 40  ** Support
41 41  ** Release Information
42 -* You can follow a tour to better understand the navigation of the eMagiz documentation portal.
70 +* You can follow a tour to understand better how to navigate the eMagiz documentation portal.
43 43  
44 44  == 5. Suggested Additional Readings ==
45 45  
46 -* [[Academy>>doc:Main.eMagiz Academy.WebHome||target="blank"]]
47 -* [[Store>>doc:Main.eMagiz Store.WebHome||target="blank"]]
48 -* [[Support>>doc:Main.eMagiz Support.WebHome||target="blank"]]
49 -* [[Release Information>>doc:Main.Release Information.WebHome||target="blank"]]
74 +* [[eMagiz platform - Fundamental>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-introduction.WebHome||target="blank"]]
75 +* [[Academy - Navigation>>doc:Main.eMagiz Academy.WebHome||target="blank"]]
76 +** [[Fundamental - Navigation>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
77 +** [[Crash Courses (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
78 +** [[Novice Level - eMagiz (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
79 +** [[Certification program (Explanation)>>doc:Main.eMagiz Academy.Get Certified.WebHome||target="blank"]]
80 +* [[Store - Navigation>>doc:Main.eMagiz Store.WebHome||target="blank"]]
81 +** [[Store (Fundamental)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-store.WebHome||target="blank"]]
82 +** [[Store - Accelerators (Navigation)>>doc:Main.eMagiz Store.Accelerators.WebHome||target="blank"]]
83 +** [[Store - System Connectors (Navigation)>>doc:Main.eMagiz Store.System Connectors.WebHome||target="blank"]]
84 +* [[Support - Navigation>>doc:Main.eMagiz Support.WebHome||target="blank"]]
85 +** [[Support (Fundamental)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-assistance-needed.WebHome||target="blank"]]
86 +** [[Migration Paths (Navigation)>>doc:Main.eMagiz Support.Migration Paths.WebHome||target="blank"]]
87 +** [[RCA Knowledge Base (Navigation)>>doc:Main.eMagiz Support.RCA Knowledge Base.WebHome||target="blank"]]
88 +* [[Release Information - Navigation>>doc:Main.Release Information.WebHome||target="blank"]]
89 +** [[Release notes (Navigation)>>doc:Main.Release Information.Portal.WebHome||target="blank"]]
90 +** [[Release blogs (Navigation)>>doc:Main.Release Information.Release Blogs.WebHome||target="blank"]]
91 +** [[Runtime Images (Navigation)>>doc:Main.Release Information.Runtime Images.WebHome||target="blank"]]
92 +** [[Cloud Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
93 +** [[documentation portal>>doc:Main.Release Information.Documentation Portal.WebHome||target="blank"]]
50 50  
51 51  )))((({{toc/}}))){{/container}}{{/container}}