From 12e4b63c83de90449b55a6533f3a9baa7328b5f3 Mon Sep 17 00:00:00 2001 From: Davood Sooran <146732918+DavoodSooran@users.noreply.github.com> Date: Wed, 10 Jan 2024 13:32:18 +0100 Subject: [PATCH 01/10] Create GLOSSARY.MD --- GLOSSARY.MD | 1 + 1 file changed, 1 insertion(+) create mode 100644 GLOSSARY.MD diff --git a/GLOSSARY.MD b/GLOSSARY.MD new file mode 100644 index 0000000000..09497f2224 --- /dev/null +++ b/GLOSSARY.MD @@ -0,0 +1 @@ +SFSDFSDFSFSDFSDFSFSDFSDF From be3973e40a788d4243cfb56b6d3506aa2f47c728 Mon Sep 17 00:00:00 2001 From: Davood Sooran <146732918+DavoodSooran@users.noreply.github.com> Date: Wed, 10 Jan 2024 14:08:43 +0100 Subject: [PATCH 02/10] Update GLOSSARY.MD --- GLOSSARY.MD | 52 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 51 insertions(+), 1 deletion(-) diff --git a/GLOSSARY.MD b/GLOSSARY.MD index 09497f2224..b786e10f9f 100644 --- a/GLOSSARY.MD +++ b/GLOSSARY.MD @@ -1 +1,51 @@ -SFSDFSDFSFSDFSDFSFSDFSDF +# OpenSCD Glossary + +This is an opinionated glossary of terms developed by the Alliander team. + +## Serverless Platform +- The platform supports administration, permission and user management associated with the development of [Serverless Services](#serverless-service). + + +## User Account +- A user account represents a single user in the [Serverless Platform](#serverless-platform). +- A user account stores sensitive identifying information such as email, password, username, etc +- A user account is considered the private representation of a user. + + +## User Profile +- A user profile represents the public presentation of a user in the [Serverless Platform](#serverless-platform). +- A user profile stores information that id displayed publicly about a user such as name, bio, github username, etc + + +## Serverless Service +- A Serverless Service consists of source code, a description, and service configuration. +- A service configuration is defined by a single `serverless.yml` + + + + + + + + + + + + + + + + + + + + + + + + + + +Wizard: A wizard is a user-friendly interface that assists individuals in completing complicated tasks by breaking them into simpler, easy-to-follow steps. It typically offers guidance, instructions, and choices, making tasks more manageable and enabling users to accomplish them efficiently. + + From 226b75e9924fb67c6e195fe06ca1a17f554e0517 Mon Sep 17 00:00:00 2001 From: Davood Sooran <146732918+DavoodSooran@users.noreply.github.com> Date: Wed, 10 Jan 2024 14:10:04 +0100 Subject: [PATCH 03/10] Update GLOSSARY.MD --- GLOSSARY.MD | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/GLOSSARY.MD b/GLOSSARY.MD index b786e10f9f..3b3ffc90ef 100644 --- a/GLOSSARY.MD +++ b/GLOSSARY.MD @@ -2,8 +2,9 @@ This is an opinionated glossary of terms developed by the Alliander team. -## Serverless Platform -- The platform supports administration, permission and user management associated with the development of [Serverless Services](#serverless-service). +## Wizard +- A wizard is a user-friendly interface that assists individuals in completing complicated tasks by breaking them into simpler, easy-to-follow steps. It typically offers guidance, instructions, and choices, making tasks more manageable and enabling users to accomplish them efficiently. + ## User Account @@ -46,6 +47,5 @@ This is an opinionated glossary of terms developed by the Alliander team. -Wizard: A wizard is a user-friendly interface that assists individuals in completing complicated tasks by breaking them into simpler, easy-to-follow steps. It typically offers guidance, instructions, and choices, making tasks more manageable and enabling users to accomplish them efficiently. From 9227f0e0d8abd934bd2cf92b9b91c4b71c1ef8bc Mon Sep 17 00:00:00 2001 From: Davood Sooran <146732918+DavoodSooran@users.noreply.github.com> Date: Wed, 10 Jan 2024 14:12:07 +0100 Subject: [PATCH 04/10] Update GLOSSARY.MD --- GLOSSARY.MD | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/GLOSSARY.MD b/GLOSSARY.MD index 3b3ffc90ef..f4fe95efc4 100644 --- a/GLOSSARY.MD +++ b/GLOSSARY.MD @@ -5,22 +5,20 @@ This is an opinionated glossary of terms developed by the Alliander team. ## Wizard - A wizard is a user-friendly interface that assists individuals in completing complicated tasks by breaking them into simpler, easy-to-follow steps. It typically offers guidance, instructions, and choices, making tasks more manageable and enabling users to accomplish them efficiently. - - -## User Account +## Plug-in - A user account represents a single user in the [Serverless Platform](#serverless-platform). -- A user account stores sensitive identifying information such as email, password, username, etc -- A user account is considered the private representation of a user. - -## User Profile +## Distribution - A user profile represents the public presentation of a user in the [Serverless Platform](#serverless-platform). -- A user profile stores information that id displayed publicly about a user such as name, bio, github username, etc +## Validator plug-in +- A Serverless Service consists of source code, a description, and service configuration. + +## Menu plug-in +- A user profile represents the public presentation of a user in the [Serverless Platform](#serverless-platform). -## Serverless Service +## Editor plug-in - A Serverless Service consists of source code, a description, and service configuration. -- A service configuration is defined by a single `serverless.yml` From 388372281f26eb610aa64e62e789d1d2c14f9123 Mon Sep 17 00:00:00 2001 From: Davood Sooran <146732918+DavoodSooran@users.noreply.github.com> Date: Wed, 10 Jan 2024 14:12:22 +0100 Subject: [PATCH 05/10] Update GLOSSARY.MD --- GLOSSARY.MD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GLOSSARY.MD b/GLOSSARY.MD index f4fe95efc4..161e3018ee 100644 --- a/GLOSSARY.MD +++ b/GLOSSARY.MD @@ -3,7 +3,7 @@ This is an opinionated glossary of terms developed by the Alliander team. ## Wizard -- A wizard is a user-friendly interface that assists individuals in completing complicated tasks by breaking them into simpler, easy-to-follow steps. It typically offers guidance, instructions, and choices, making tasks more manageable and enabling users to accomplish them efficiently. +A wizard is a user-friendly interface that assists individuals in completing complicated tasks by breaking them into simpler, easy-to-follow steps. It typically offers guidance, instructions, and choices, making tasks more manageable and enabling users to accomplish them efficiently. ## Plug-in - A user account represents a single user in the [Serverless Platform](#serverless-platform). From 0b7c83f39e6b74908a50ff0ca9f277cb4048ab49 Mon Sep 17 00:00:00 2001 From: Davood Sooran <146732918+DavoodSooran@users.noreply.github.com> Date: Wed, 10 Jan 2024 14:12:45 +0100 Subject: [PATCH 06/10] Update GLOSSARY.MD --- GLOSSARY.MD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GLOSSARY.MD b/GLOSSARY.MD index 161e3018ee..0bc60481f9 100644 --- a/GLOSSARY.MD +++ b/GLOSSARY.MD @@ -2,7 +2,7 @@ This is an opinionated glossary of terms developed by the Alliander team. -## Wizard +### Wizard A wizard is a user-friendly interface that assists individuals in completing complicated tasks by breaking them into simpler, easy-to-follow steps. It typically offers guidance, instructions, and choices, making tasks more manageable and enabling users to accomplish them efficiently. ## Plug-in From 32c9847fd9c04b654515627f16e4aff7d7edde67 Mon Sep 17 00:00:00 2001 From: Davood Sooran <146732918+DavoodSooran@users.noreply.github.com> Date: Wed, 10 Jan 2024 15:00:59 +0100 Subject: [PATCH 07/10] Update GLOSSARY.MD --- GLOSSARY.MD | 41 ++++++++++++----------------------------- 1 file changed, 12 insertions(+), 29 deletions(-) diff --git a/GLOSSARY.MD b/GLOSSARY.MD index 0bc60481f9..2469f1c51d 100644 --- a/GLOSSARY.MD +++ b/GLOSSARY.MD @@ -2,48 +2,31 @@ This is an opinionated glossary of terms developed by the Alliander team. -### Wizard +## Wizard A wizard is a user-friendly interface that assists individuals in completing complicated tasks by breaking them into simpler, easy-to-follow steps. It typically offers guidance, instructions, and choices, making tasks more manageable and enabling users to accomplish them efficiently. ## Plug-in -- A user account represents a single user in the [Serverless Platform](#serverless-platform). +A plug-in is a software module that enhances an already existing application or system by adding particular features or tools. It's crafted to seamlessly merge with the main software, broadening its capabilities without altering its fundamental structure. ## Distribution -- A user profile represents the public presentation of a user in the [Serverless Platform](#serverless-platform). +In software development, distribution is the process of preparing a software application or tool for delivery to end-users. It involves packaging the software in a way that makes it easy to install or use on different platforms or systems. This step ensures the software reaches its intended audience and can be readily deployed for use. ## Validator plug-in -- A Serverless Service consists of source code, a description, and service configuration. +This plug-in is specifically crafted to verify or validate input, data, or code based on predefined rules or standards. Its primary role is to ensure that the information provided meets certain criteria or requirements. In the context of our tool, this plug-in is essential for validating the IEC 61850 SCL file that's either created or modified by the tool. It acts as a quality checker, ensuring the integrity and compliance of the SCL file according to specified guidelines or standards. ## Menu plug-in -- A user profile represents the public presentation of a user in the [Serverless Platform](#serverless-platform). - -## Editor plug-in -- A Serverless Service consists of source code, a description, and service configuration. - - - - - - - - - - - - - - - - - - - - - +Menu Plug-in in OpenSCD refers to the functionalities accessible directly from the main menu of the tool. These options perform specific tasks within the tool without necessarily adding a new module or plug-in to the workspace. For instance: +- **Save Project:** Saves the current project. +- **Open Project:** Opens an existing project. +- **Create Virtual IED:** Adds a new IED (Intelligent Electronic Device). +These options facilitate essential tasks within OpenSCD without altering the tool's interface or adding new components to the workspace. +## Editor plug-in +**Editor Plug-ins** in OpenSCD are accessed through the Extensions section in the Menu. These plug-ins, found in the Editor tab of the Extensions section, are responsible for adding or removing modules within the tool's workspace. For instance: **IED**, **Substation** and **Single Line Diagram** plug-ins. +Editor Plug-ins extend the functionality of OpenSCD by adding modules or components to the workspace, providing users with additional tools and features for more specialized tasks or configurations. From 5c0969bfe18f977a3220c3342276060cb1c3e6c0 Mon Sep 17 00:00:00 2001 From: Davood Sooran <146732918+DavoodSooran@users.noreply.github.com> Date: Wed, 10 Jan 2024 15:57:56 +0100 Subject: [PATCH 08/10] Update GLOSSARY.MD --- GLOSSARY.MD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GLOSSARY.MD b/GLOSSARY.MD index 2469f1c51d..fd75e498fb 100644 --- a/GLOSSARY.MD +++ b/GLOSSARY.MD @@ -1,6 +1,6 @@ # OpenSCD Glossary -This is an opinionated glossary of terms developed by the Alliander team. +This is an opinionated glossary of terms developed by the OpenSCD community. Please note that terms specific to the SCL (Substation Configuration Language) fall outside the scope of this glossary, as they are thoroughly covered and explained by the relevant standards. ## Wizard A wizard is a user-friendly interface that assists individuals in completing complicated tasks by breaking them into simpler, easy-to-follow steps. It typically offers guidance, instructions, and choices, making tasks more manageable and enabling users to accomplish them efficiently. From 0eea9297c949c621adb9a15a00b7a4cae18b013a Mon Sep 17 00:00:00 2001 From: Davood Sooran <146732918+DavoodSooran@users.noreply.github.com> Date: Mon, 29 Jan 2024 15:02:03 +0100 Subject: [PATCH 09/10] Update GLOSSARY.MD --- GLOSSARY.MD | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/GLOSSARY.MD b/GLOSSARY.MD index fd75e498fb..2135e88f76 100644 --- a/GLOSSARY.MD +++ b/GLOSSARY.MD @@ -1,15 +1,15 @@ # OpenSCD Glossary -This is an opinionated glossary of terms developed by the OpenSCD community. Please note that terms specific to the SCL (Substation Configuration Language) fall outside the scope of this glossary, as they are thoroughly covered and explained by the relevant standards. +This is an opinionated glossary of terms developed by the OpenSCD community. Please note that terms specific to the SCL (Substation Configuration Language) fall outside the scope of this glossary, as they are thoroughly covered and explained by the relevant IEC standards; The goal of the glossary is helping to get a common understanding of the terms introduced into the OpenSCD project, with the aim of enhancing communication. ## Wizard A wizard is a user-friendly interface that assists individuals in completing complicated tasks by breaking them into simpler, easy-to-follow steps. It typically offers guidance, instructions, and choices, making tasks more manageable and enabling users to accomplish them efficiently. ## Plug-in -A plug-in is a software module that enhances an already existing application or system by adding particular features or tools. It's crafted to seamlessly merge with the main software, broadening its capabilities without altering its fundamental structure. +A plug-in is a software module that enhances OpenSCD by adding particular features or tools. It's crafted to seamlessly merge with the main OpenSCD-core API, broadening its capabilities without altering its fundamental structure. OpenSCD-core with a selected set of plug-ins and settings (e.g. color scheme). An OpenSCD plug-in allows to extend OpenSCD functionality. E.g. support vendeor/organisational specific needs. ## Distribution -In software development, distribution is the process of preparing a software application or tool for delivery to end-users. It involves packaging the software in a way that makes it easy to install or use on different platforms or systems. This step ensures the software reaches its intended audience and can be readily deployed for use. +An OpenSCD distirbution is openSCD-core with a set of user/organsition selected plug-ins, styling and other environmental variables. An OpenSCD distribution allows to meet organisation/user needs. E.g. selection of open source and 3th party plug-ins or the useage of organisation colors. ## Validator plug-in This plug-in is specifically crafted to verify or validate input, data, or code based on predefined rules or standards. Its primary role is to ensure that the information provided meets certain criteria or requirements. In the context of our tool, this plug-in is essential for validating the IEC 61850 SCL file that's either created or modified by the tool. It acts as a quality checker, ensuring the integrity and compliance of the SCL file according to specified guidelines or standards. From a91c8e11cf21bdae0335da94e47f6c4d9ec90ae9 Mon Sep 17 00:00:00 2001 From: Davood Sooran <146732918+DavoodSooran@users.noreply.github.com> Date: Thu, 1 Feb 2024 16:45:35 +0100 Subject: [PATCH 10/10] Update GLOSSARY.MD --- GLOSSARY.MD | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/GLOSSARY.MD b/GLOSSARY.MD index 2135e88f76..80f56cc5ba 100644 --- a/GLOSSARY.MD +++ b/GLOSSARY.MD @@ -1,18 +1,18 @@ # OpenSCD Glossary -This is an opinionated glossary of terms developed by the OpenSCD community. Please note that terms specific to the SCL (Substation Configuration Language) fall outside the scope of this glossary, as they are thoroughly covered and explained by the relevant IEC standards; The goal of the glossary is helping to get a common understanding of the terms introduced into the OpenSCD project, with the aim of enhancing communication. +This glossary introduces terms that have been developed and collectively endorsed by the OpenSCD community. Please note that terms specific to the SCL (Substation Configuration Language) fall outside the scope of this glossary, as they are thoroughly covered and explained by the relevant IEC standards; The goal of the glossary is helping to get a common understanding of the terms introduced into the OpenSCD project, with the aim of enhancing communication. ## Wizard A wizard is a user-friendly interface that assists individuals in completing complicated tasks by breaking them into simpler, easy-to-follow steps. It typically offers guidance, instructions, and choices, making tasks more manageable and enabling users to accomplish them efficiently. ## Plug-in -A plug-in is a software module that enhances OpenSCD by adding particular features or tools. It's crafted to seamlessly merge with the main OpenSCD-core API, broadening its capabilities without altering its fundamental structure. OpenSCD-core with a selected set of plug-ins and settings (e.g. color scheme). An OpenSCD plug-in allows to extend OpenSCD functionality. E.g. support vendeor/organisational specific needs. +An OpenSCD plug-in allows to extend OpenSCD functionality. E.g. support vendeor/organisational specific needs. It's crafted to seamlessly merge with the main OpenSCD-core API, broadening its capabilities without altering its fundamental structure. OpenSCD-core incorporates a selected set of plug-ins and settings (e.g. color scheme) to enhance its functionality. ## Distribution -An OpenSCD distirbution is openSCD-core with a set of user/organsition selected plug-ins, styling and other environmental variables. An OpenSCD distribution allows to meet organisation/user needs. E.g. selection of open source and 3th party plug-ins or the useage of organisation colors. +An OpenSCD distirbution is openSCD-core with a set of user/organsition selected plug-ins, styling and other environmental variables. An OpenSCD distribution allows to meet organisation/user needs. E.g. selection of open source and 3rd party plug-ins or the useage of organisation colors. ## Validator plug-in -This plug-in is specifically crafted to verify or validate input, data, or code based on predefined rules or standards. Its primary role is to ensure that the information provided meets certain criteria or requirements. In the context of our tool, this plug-in is essential for validating the IEC 61850 SCL file that's either created or modified by the tool. It acts as a quality checker, ensuring the integrity and compliance of the SCL file according to specified guidelines or standards. +The primary role of Validator plug-in is to ensure that the information provided meets certain criteria or requirements. In the context of our tool, this plug-in is essential for validating the IEC 61850 SCL file that's either created or modified by the tool. It acts as a quality checker, ensuring the integrity and compliance of the SCL file according to specified guidelines or standards. ## Menu plug-in Menu Plug-in in OpenSCD refers to the functionalities accessible directly from the main menu of the tool. These options perform specific tasks within the tool without necessarily adding a new module or plug-in to the workspace. For instance: