Merge branch 'versione-corrente' into issjti

italia · Sep 1, 2023 · 8dd1512 · 8dd1512
2 parents 746f477 + 58c8309
commit 8dd1512
Show file tree

Hide file tree

Showing 21 changed files with 994 additions and 674 deletions.
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -4,23 +4,27 @@ name: gh-pages
 
 on:
   push:
-    branches: ["versione-corrente"]
+    branches: ["*"]
     paths-ignore:
       - README.md
       - CONTRIBUTING.md
       - LICENSE.md
       - .gitignore
   pull_request:
-    branches: [ "*" ]
+    branches: ["*"]
     paths-ignore:
       - README.md
       - CONTRIBUTING.md
       - LICENSE.md
       - .gitignore
+  release:
+    types:
+      - created
+      - edited
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
-
+  
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
   # This workflow contains a single job called "build"
@@ -44,17 +48,17 @@ jobs:
 
       - name: Build branch
         run: |-
-          sphinx-build -b html docs/it/  html/${GITHUB_HEAD_REF}/it
-          sphinx-build -b html docs/en/  html/${GITHUB_HEAD_REF}/en
-
-      - name: Install deps
-        run: |-
-            python -m pip install -r requirements-dev.txt
-
-      - name: Build branch
-        run: |-
-          sphinx-build -b html docs/it/ html/${GITHUB_HEAD_REF}/it
-          sphinx-build -b html docs/en/ html/${GITHUB_HEAD_REF}/en
+          if [[ "$GITHUB_REF" = /refs/tags/* ]]; then
+            TAG=$(echo "$GITHUB_REF" | sed "s/\/refs\/tags\///")
+            SUBPATH="v$TAG/" # note the trailing slash
+            echo "Building for TAG: $SUBPATH"
+          else
+            SUBPATH=$(echo "$GITHUB_REF" | sed "s/refs\/heads\///") # "${GITHUB_HEAD_REF}/" # note the trailing slash
+            echo "Building for PR: $SUBPATH"
+          fi
+          echo "Publishing $SUBPATH"
+          sphinx-build -b html docs/it/  html/$SUBPATH/it
+          sphinx-build -b html docs/en/  html/$SUBPATH/en
 
       # Runs a single command using the runners shell
       - name: Create GH page index
@@ -63,11 +67,11 @@ jobs:
           echo '
           <html>
           <head>
-            <title>Italian eIDAS Wallet Technical Specifications</title>
+            <title>EUDI Wallet docs</title>
             <meta name="viewport" content="initial-scale=1.0">
           </head>
           <body>
-          <h1>Italian eIDAS Wallet Technical Specifications</h1>
+          <h1>EUDI Wallet docs</h1>
 
           <ul>
             <li><a href="it/">Italian version</a></li>

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Italian eIDAS Wallet Technical Specifications
+# EUDI Wallet Technical Specifications
 
 [![GitHub release](https://img.shields.io/github/release/italia/eidas-it-wallet-docs.svg?style=plastic)](https://github.com/italia/eidas-it-wallet-docs/releases)
 [![Get invited](https://slack.developers.italia.it/badge.svg)](https://slack.developers.italia.it/)
@@ -18,20 +18,28 @@
 
 ## Intro
 
-This repository hosts the sphinx project tree of Italian eIDAS Wallet Technical Specifications.
+This repository hosts the sphinx project tree of EUDI Wallet Technical Specifications.
 
 > This repository may contain contents to be considered experimental until the publication of the first release.
 
 ## Preview
 
 The stable release in different languages is published at the link below:
 
- - [English](https://italia.github.io/eidas-it-wallet-docs/en)
- - [Italian](https://italia.github.io/eidas-it-wallet-docs/it)
+ - [English](https://italia.github.io/eudi-wallet-it-docs/versione-corrente/en/)
+ - [Italian](https://italia.github.io/eudi-wallet-it-docs/versione-corrente/it/)
+
+### Preview of a branch
 
 Preview of other branches can be navigated by adding the branch name in the webpath, as follows:
 
- - https://italia.github.io/eidas-it-wallet-docs/trust-model/en
+ - https://italia.github.io/eudi-wallet-it-docs/$branch-name/en
+
+### Preview of released versions
+
+Released versions can be navigated by adding the tag in the webpath leaded by a _v_, as follows:
+
+ - https://italia.github.io/eudi-wallet-it-docs/v0.4.1/en
 
 
 ## Documentation
@@ -74,6 +82,8 @@ Furthermore, this project uses the git *branches* and *tags* in the following wa
 * The [release page](https://github.com/italia/publiccode.yml/releases) of
   GitHub contains all the released versions of the standard. For the sake of coherence, the *releases* are made according to the tag names.
 
+Each time a release is created or edited, a preview is built based on the tag the release refers to. See [the preview section](preview-of-released-versions) for more.
+
 ## How to contribute
 
 Feel free to open [Pull Requests and to present a problem with an Issue](CONTRIBUTING.md).

diff --git a/docs/common/common_definitions.rst b/docs/common/common_definitions.rst
@@ -57,5 +57,6 @@
 .. _DPOP: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-dpop
 .. _RFC 7519: https://www.rfc-editor.org/rfc/rfc7519
 .. _OAUTH2: https://www.rfc-editor.org/rfc/rfc6749
+.. _OPENID4VC-HAIP: https://vcstuff.github.io/oid4vc-haip-sd-jwt-vc/draft-oid4vc-haip-sd-jwt-vc.html
 
 
diff --git a/docs/common/standards.rst b/docs/common/standards.rst
@@ -54,4 +54,6 @@ Technical References
     * - :rfc:`6749`
       - The OAuth 2.0 Authorization Framework
     * - `DPOP`
-      - TBD
+      - D. Fett, B. Campbell, J. Bradley, T. Lodderstedt, M. Jones, D. Waite, "OAuth 2.0 Demonstrating Proof-of-Possession at the Application Layer (DPoP)"
+    * - `OPENID4VC-HAIP`
+      - Lodderstedt, T., K. Yasuda, "OpenID4VC High Assurance Interoperability Profile with SD-JWT VC"
diff --git a/docs/en/contribute.rst b/docs/en/contribute.rst
@@ -2,7 +2,15 @@
 
 .. _contribute.rst:
 
-contribute.rst
+How to contribute
 +++++++++++++++++++++++++++
 
-Instruction to join in the development here.
+The IT Wallet project, including this document, follows an **open development process**. This approach ensures the development process is accessible to all, inviting all interested parties to participate.
+
+Consequently, stakeholders, national and international community members are not only encouraged but also heartily welcomed to contribute to the refinement of these technical rules.
+
+Below are several methods available for contributing to this project:
+
+- **GitHub issues**. By opening an issue, you can seek clarification, propose enhancements, or report editorial typos. If you are working on an issue, we encourage you to open a draft pull request and link it.
+- **Pull requests**. Pull requests represent active contributions to the project, typically, but not always following issue-based discussions. Once a pull request is initiated, it facilitates discussion and review of the proposed changes before they are merged into the main branch (`versione-corrente`).
+- **Developers Italia Slack channel**. Slack is a messaging application designed for businesses, connecting people to the information they need. *Developers Italia* is an open community based on contributions and participation from public administrations, developers, technicians, students, and citizens. *Developers Italia* has initiated a Slack channel that [everyone can join for free](https://slack.developers.italia.it/), where you can learn about all their activities and partake in discussions.
diff --git a/docs/en/defined-terms.rst b/docs/en/defined-terms.rst
@@ -2,6 +2,13 @@
 
 .. _defined-terms.rst:
 
+
+Normative Language and Conventions
+++++++++++++++++++++++++++++++++++
+
+The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
+
+
 Defined Terms
 +++++++++++++
 
@@ -40,6 +47,8 @@ Below are the description of acronyms and definitions which are useful for furth
      - Electronic attestation of an entity's compliance with the national regulatory framework, which is cryptographically verifiable and cannot be repudiated over time by the entity that issued it. A Trust Attestation is always related to a particular Trust Framework.
    * - Trust Layer
      - An architectural component that enables IT Wallet system participants to establish trust, in terms of reliability and compliance of all participants with the regulatory framework governing the digital identity system.
+   * - Level of Assurance
+     - The degree of confidence in the vetting process used to establish the identity of the User and the degree of confidence that the User who presents the credential is the same User to whom the credential was issued.
 
 Acronyms
 --------
@@ -60,4 +69,6 @@ Acronyms
     - Verifiable Presentation
   * - **API**
     - Application Programming Interface
+  * - **LoA**
+    - Level of Assurance
 
diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -60,13 +60,13 @@ Index of content
 ----------------
 
 .. toctree:: 
-   :maxdepth: 2
+   :maxdepth: 3
 
    ssi-introduction.rst
    defined-terms.rst
    trust.rst
-   pid-data-model.rst
-   pid-issuance.rst
+   pid-eaa-data-model.rst
+   pid-eaa-issuance.rst
    wallet-solution.rst
    wallet-instance-attestation.rst
    relying-party-solution.rst