Commit 91195d6d authored by RieksJ's avatar RieksJ
Browse files

Refer to the framework on github

parent 4727b38d
Pipeline #49354 passed with stages
in 7 minutes and 7 seconds
......@@ -78,7 +78,7 @@ The workflow in the framework repository, has the following jobs:
These checks run on all the branches but `master`
- `gh-release` [job](https://github.com/essif-lab/framework/blob/master/.github/workflows/framework.yml#L25): takes care of the deployment
The release job runs **only** when another branch gets merged to `master` and the changes affect the artifact of the deployment
> :exclamation: The branch that the website will be deployed to, defaults to `gh-pages`. The result of the release job (`build` directory)
......@@ -91,37 +91,37 @@ In order to deploy a new version of the website, follow the procedure below:
</summary>
1. Create locally a new branch from `master` (ex. `feature-gh-branch` branch)
2. Add and commit your changes locally
3. Push your changes to the remote `feature-gh-branch` branch
4. To create a Pull Request to `master`, go to the repository's page on Github, in the [Pull requests tab](https://github.com/essif-lab/framework/pulls), and click `New pull request`
5. In the `compare:` dropdown list, choose the branch you want to merge with `master` (in this case with `feature-gh-branch`), and review the changes
![Github compare branches](static/images/github/github-compare-branches.png)
Then, click `Create Pull Request` button to proceed
6. You will get prompted to the pull request page, where the *checks* of the PR are launched automatically, as part of the workflow
![Github PR checks](static/images/github/github-pr-checks.png)
When the PR passes all the checks and it has no conflicts with the `master` branch, you can click the `Merge pull request` button, to merge the changes
![Github PR page](static/images/github/github-pr-page.png)
Once the merging is over, the PR will change status from *Open* to *Merged*
![Github PR merged](static/images/github/github-merged-branch.png)
7. In the [Actions page](https://github.com/essif-lab/framework/actions) you can review all the running workflows.
![Github PR merged](static/images/github/github-workflows.png)
Now that the `feature-gh-branch` got merged to `master`, the release job started running, to update the website.
![Github PR merged](static/images/github/github-release-workflow.png)
</details>
......
......@@ -8,8 +8,8 @@ date: 20210601
import useBaseUrl from '@docusaurus/useBaseUrl'
:::info Editor's note
*This section is work in progress.*
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/essifLab-fw-bus-arch).
:::
## 1. Purpose
......
......@@ -8,8 +8,8 @@ date: 20210601
import useBaseUrl from '@docusaurus/useBaseUrl'
:::info Editor's note
*This section is work in progress.*
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/essifLab-fw-func-arch).
:::
## 1. Purpose
......
......@@ -8,6 +8,10 @@ date: 20210601
import useBaseUrl from '@docusaurus/useBaseUrl'
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/essifLab-fw).
:::
:::info Editor's note
*This section is work in progress.*
:::
......
......@@ -7,6 +7,10 @@ hoverText: "The purpose of the eSSIF-Lab is to specify, develop and validate tec
date: 20210601
---
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/essifLab-objectives).
:::
## Purpose
The purpose of the eSSIF-Lab is to specify, develop and validate technological and non-technological (e.g. governance) means that support people, businesses and governments to think about, design, adapt, and operate their (information) processes such that they can negotiate and conduct %%business transactions|transaction%% with one another using the electronic support provided by the various SSI technologies.
......
......@@ -6,6 +6,10 @@ scopeid: essifLab
date: 20210908
---
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/essifLab-pattern-list).
:::
Within eSSIF-Lab, we maintain a set of [mental models](https://en.wikipedia.org/wiki/Mental_model), which we also call %%patterns|pattern%%, which are descriptions, both casual and formal, of sets of %%concepts|concept%% (ideas), relations between them, and constraints, that together form a coherent and consistent 'viewpoint', or 'way of thinking' about a certain topic. They have been crafted so that they may serve as a basis for architecting, desiging, and implementing IT components and their governance processes.
One might think that everyone has their own mental models, and uses them to make decisions, make sense of the world, etc. Any mental model that helps a person cope in the world is ok. For example, the ancient Greeks had a mental model that said [the earth is at the center of the universe](https://oxfordre.com/planetaryscience/view/10.1093/acrefore/9780190647926.001.0001/acrefore-9780190647926-e-46#acrefore-9780190647926-e-46-div2-2), and the sun and planets somehow revolve around it. Further development of the model allowed them to compute planetary positions, which played a role in fortune telling and therefore was considered important. Doing this is [very complex](https://www.nature.com/articles/s41598-021-84310-w). In the 16th century, [Copernic revolutionized science](https://www.britannica.com/topic/Copernican-Revolution) by stating that the sun, rather than the earth, was at the centre of the universe. It wasn't like he changed the universe itself - he only changed the frame of reference, the perspective, i.e. the mental model that he used to look at, reason with, and explain the universe. Copernic showed in a dramatic way that changing one's perspective can have very profound consequences.
......
......@@ -8,6 +8,10 @@ date: 20210601
import useBaseUrl from '@docusaurus/useBaseUrl'
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/essifLab-principles).
:::
The dialogue about what Self-Sovereign Identity (SSI) really is, that was started in the blog "[The Path to Self-Sovereign Identity](http://www.lifewithalacrity.com/2016/04/the-path-to-self-soverereign-identity.html)" by Christopher Allen in 2016, has not resulted in a consensus today. While some see the ten principles of SSI that Allen proposed as the definition of SSI, they have been formulated as "a departure point to provoke a discussion about what's truly important".
From the [perspective of eSSIF-Lab](essifLab-vision) this "what's truly important" relates to electronically supporting %%parties|party%% as they negotiate and execute %%(business) transactions|transaction%%. From this perspective, it seems reasonable to have the term %%SSI|self-sovereign-identity%% refer to all concepts/ideas, architectures, processes and technologies that aim to support (autonomous) %%parties|party%% as they negotiate and execute electronic %%(business) transactions|transaction%% with one another.
......
......@@ -24,6 +24,10 @@ The eSSIF-Lab project [seeks to fund (EU) SME's](https://essif-lab.eu/open-calls
The eSSIF-Lab project also contributes to the design, maintenance and validation of the [eSSIF-Lab framework](essifLab-fw), its [Business architecture](essifLab-fw-bus-arch) and its [Functional architecture](essifLab-fw-func-arch).
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/essifLab-project).
:::
## Background
The current situation (2020/2021) is that electronic support for such transactions is very limited. In most cases, people have to type in data, most of which already exists in electronic form but isn't readily available for (re)use. People may need to copy data from papers, or scan papers and upload these scans. On the provider side, this data has to be %%verified|verify%% and %%validated|validate%%, which takes time and effort, often from human employees.
......
......@@ -6,6 +6,10 @@ scopeid: essifLab
date: 20210601
---
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/essifLab-terminology).
:::
When %%parties|party%% from various backgrounds (and cultures) work together, it is inevitable that misunderstandings occur, i.e. texts (written or spoken) are easily interpreted in ways other than what the author intended. More often than not, such misunderstandings go undetected, and rightfully so, as in most cases it doesn't cause serious problems.
In the context of [eSSIF-Lab](essifLab) we expect people from such various backgrounds (and cultures) to work together in order to realize its [objectives](essifLab-Objectives). Because of its nature, we must expect misunderstandings to become problematic. In order to prevent them, and also to efficiently and effectively resolve those that do occur, we provide mechanisms to detect such misunderstandings, develop %%terminologies|terminology%% that reduce the likelihood of them occurring, and resolve problems/disputes that may occur around %%terms|term%% and %%definitions|definition%%. Using these mechanisms is not compulsory - they may be used (or not) as participants like.
......
......@@ -10,6 +10,10 @@ The European Self-Sovereign Identity Lab ([eSSIF-Lab](essifLab)) views itself as
In its pursuit of this aim, [eSSIF-Lab](essifLab) is developing a [way of thinking and reasoning](essifLab-pattern-list) for the purpose of making it easier to determine what artifacts are needed, how to design them, etc. In the descriptions we provide, we use the eSSIF-Lab %%terminology|terminology%% as provided in the [eSSIF-Lab Glossary](essifLab-glossary). As the meaning of these terms has been [carefully defined](./terms/terminology), they should not be interpreted in another way than as they are %%defined|definition%%. %%Terms|term%% that are defind in the context of eSSIF-Lab are highlighted, and hovering over them shows you their definitions. If you want to dive deeper into the its meaning, just click it.
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/essifLab-vision).
:::
## Context - the eSSIF-Lab World Model
The basic concepts that you as a reader need to be aware of in order to understand what the eSSIF-Lab vision and [its framework](essifLab-fw) are about, are those that describe the %%eSSIF-Lab world model|pattern-world-model%%, and constitute its context.
......
......@@ -6,6 +6,10 @@ scopeid: essifLab
date: 20210601
---
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/essifLab).
:::
The European Self-Sovereign Identity Lab ([eSSIF-Lab](https://essif-lab.eu/)) views itself as an %%ecosystem|ecosystem%% of %%parties|party%% that work together to make existing (and new) %%Self-Sovereign Identity (SSI)|self-sovereign-identity%% technology into a scalable and interoperable %%infrastructure|ssi-infrastructure%% that businesses can use very easily for negotiation and execution of %%(business) transactions|transaction%% with other organizations and individuals alike, as further described in the [eSSIF-Lab Vision](essifLab-vision).
To learn more, we have a description on the following topics:
......
......@@ -6,6 +6,10 @@ scopeid: essifLab
date: 20210601
---
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/essifLab-governance).
:::
## Purpose
The [eSSIF-Lab functional architecture](essifLab-fw-func-arch) identifies and describes a variety of generic SSI functions (capabilities), such as %%holder|holder%%, %%verifier|verifier%%, %%issuer|issuer%%, %%wallet|wallet%%, and more. An %%actor|actor%% that can provide such (generic) capabilities can only _actually_ provide them for a %%party|party%% if it knows how to to comply with the %%rules, working-instructions, preferences and other guidance|policy%% of that %%party|party%%.
......
......@@ -6,6 +6,10 @@ date: 20210601
import useBaseUrl from '@docusaurus/useBaseUrl'
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/essifLab).
:::
This document provides an overview of the notations and conventions being used within eSSIF-Lab.
### RFC 2119
......
......@@ -10,6 +10,10 @@ glossaryText: "something that is actually done/executed - by a single %%actor^ac
date: 20210601
---
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/terms/action).
:::
### Short Description
An **Action** is something that is actually done/executed by a %%actor|actor%% in some context (i.e. in a specific place, at a specific time). During the time interval in which the action is executed, the actor may still execute other actions in other execution-contexts (multi-tasking). An action is executed on behalf of a specific %%party|party%%, which means that the primary guidance for executing the action, e.g. how to execute it, boundary conditions within which the execution must take place, etc., comes from a %%policy|policy%% that this %%party|party%% has established for actions of that kind. The actor is assumed to have appropriate access to that policy.
......
......@@ -9,6 +9,11 @@ hoverText: "Actor: Entity that can act (do things), e.g. people, machines, but n
glossaryText: "Entity that can act (do things), e.g. people, machines, but not %%organizations^organization%%."
date: 20210601
---
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/terms/actor).
:::
### Short Description
An **Actor** is someone or something that can actually do things, such as people or machines. Actors will generally do things, i.e. execute %%actions|action%% in different ways, depending on the context, or the %%party|party%% for whom they do this.
......
......@@ -10,6 +10,10 @@ glossaryText: "an %%actor^actor%% that is executing an %%action^action%% on beha
date: 20210601
---
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/terms/agent).
:::
### Short Description
An **Agent** is an %%actor|actor%% that is executing an action %%action|action%% on behalf of some %%party|party%% (which we call the %%principal|principal%% of that agent). During the time interval in which the action is executed, the actor may execute other actions in other execution-contexts, on behalf of the same or another %%party|party%%. However, for the execution of a single %%action|action%%, the actor is an agent for precisely one principal. It is assumed that the principal provides its agents with the %%policies|policy%% that provide the agents with the rules, working-instructions, preferences and other guidance that they need to comply with when exeucting the action.
......
......@@ -10,6 +10,10 @@ glossaryText: "a declaration/statement, made by a specific %%party^party%%, that
date: 20210601
---
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/terms/assertion).
:::
### Short Description
An **Assertion** is a declaration/statement that is made by one specific %%party|party%% (which we refer to as its %%owner|owner%%)[^1]. Such a statement may or may not reflect what that %%party|party%% holds or %%knows|knowledge%% to be true - %%parties|party%% may lie.
......
......@@ -10,6 +10,10 @@ glossaryText: "%%Data^data%%, that represents a characteristic that a %%party^pa
date: 20210821
---
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/terms/attribute).
:::
### Short Description
An **Attribute** is %%data|data%%, that represents a characteristic that a %%party|party%% (the %%owner|owner%% of the %%attribute|attribute%%) has attributed to an %%entity|entity%%. An attribute is a form of %%assertion|assertion%% (or claim), that states the attribution of that characteristic to its %%subject|subject%%.
......
......@@ -10,6 +10,10 @@ glossaryText: "a %%party^party%% of which certain decisions, ideas, rules etc. a
date: 20210601
---
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/terms/authority).
:::
### Short Description
An **Authority** is a %%party|party%% of which certain decisions, ideas, rules etc. are followed by other %%parties|party%%. We distinguish between two kinds of authority:
- centralized authority, also known as the power or right to give orders, make decisions that other parties must follow, and enforce obedience. This kind of authority ignores the natural autonomy of other %%parties|party%%.
......
......@@ -14,6 +14,10 @@ date: 20210601
TNO (or others) to provide the content of this file.
:::
:::caution
This page has been moved to the [eSSIF-Lab Framework on Github](https://essif-lab.github.io/framework/docs/terms/colleague).
:::
### Purpose
The ability to distinguish between (non) colleagues allows us to reason and communicate about the set of (digital and non-digital) %%actors|actor%% that are %%agents|agent%% for a **principal|principal%%. This is relevant in situations where different %%agents|agent%% excute %%actions|action%% in a single %%business transaction|transaction%% on behalf of the same %%principal|principal%%
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment