diff --git a/EVES/drafts/EVES-001/eves-001.md b/EVES/EVES-001/eves-001.md similarity index 96% rename from EVES/drafts/EVES-001/eves-001.md rename to EVES/EVES-001/eves-001.md index 86a4adc..07b299e 100644 --- a/EVES/drafts/EVES-001/eves-001.md +++ b/EVES/EVES-001/eves-001.md @@ -46,7 +46,7 @@ Each EVES must pass through the following stages: 1. **Draft** - Created via a Pull Request (PR). - - Must follow the [EVES template](../../resources/eves-template.md) and meet the requirements in the [Style Guide](../../resources/style-guide.md). + - Must follow the [EVES template](../resources/eves-template.md) and meet the requirements in the [Style Guide](../resources/style-guide.md). - Open for initial community feedback. 2. **Review**: @@ -171,13 +171,13 @@ This process introduces new clarity regarding EVES stages, references, and roles ## 10. References 1. **EVES-004: Roles and Responsibilities of EVES Editors** - [https://github.com/ASCS-eV/EVES/blob/main/drafts/EVES-004/EVES-004.md](../EVES-004/eves-004.md) + [../EVES-004/EVES-004.md](../EVES-004/eves-004.md) 2. **RFC 2119: Key Words for Use in RFCs to Indicate Requirement Levels** [https://www.rfc-editor.org/rfc/rfc2119](https://www.rfc-editor.org/rfc/rfc2119) 3. **EVES Template & Style Guide** - [../../resources/](../../resources) + [../resources/](../resources) 4. **OpenMSL Governance Rules** [https://openmsl.github.io/doc/OpenMSL/organization/governance_rules.html](https://openmsl.github.io/doc/OpenMSL/organization/governance_rules.html) diff --git a/EVES/drafts/EVES-002/eves-002.md b/EVES/EVES-002/eves-002.md similarity index 96% rename from EVES/drafts/EVES-002/eves-002.md rename to EVES/EVES-002/eves-002.md index cbf5bab..99068b9 100644 --- a/EVES/drafts/EVES-002/eves-002.md +++ b/EVES/EVES-002/eves-002.md @@ -64,7 +64,7 @@ The ENVITED-X Data Space is built on the following core modules: - Ensure compliance with the TZIP-21 metadata standard to use open source libraries of the greater Tezos ecosystem. - **Key Features**: - Whitelisting through the registry contract's "view" entry point. - - Minting NFTs representing simulation assets defined in [EVES-003](https://github.com/ASCS-eV/EVES/blob/main/drafts/EVES-003/EVES-003.md). + - Minting NFTs representing simulation assets defined in [EVES-003](../EVES-003/eves-003.md). - **Standards**: - FA2.1 compliance for token creation and ticket-based interoperability. @@ -144,7 +144,7 @@ Future EVES will provide detailed specifications for each module. 2. [Altme Wallet](https://altme.io) 3. [Tezos FA2.1 Standard](https://gitlab.com/tzip/tzip/-/blob/master/proposals/tzip-21/tzip-21.md) 4. [Etherlink Bridge](https://www.etherlinkbridge.com/bridge) -5. [EVES-003: ENVITED Asset Definition and Upload Process](https://github.com/ASCS-eV/EVES/blob/main/drafts/EVES-003/EVES-003.md) +5. [EVES-003: ENVITED Asset Definition and Upload Process](../EVES-003/eves-003.md) 6. [Gaia-X Trust Framework](https://docs.gaia-x.eu/policy-rules-committee/compliance-document/24.11/) ## Implementation diff --git a/EVES/drafts/EVES-003/eves-003.md b/EVES/EVES-003/eves-003.md similarity index 100% rename from EVES/drafts/EVES-003/eves-003.md rename to EVES/EVES-003/eves-003.md diff --git a/EVES/drafts/EVES-003/metadata/Readme.md b/EVES/EVES-003/metadata/Readme.md similarity index 100% rename from EVES/drafts/EVES-003/metadata/Readme.md rename to EVES/EVES-003/metadata/Readme.md diff --git a/EVES/drafts/EVES-003/metadata/bafybeidhmknqn4cofjlphtrxpyvruur42t55bfmtcldyb74l2ob22kjjdu.zip b/EVES/EVES-003/metadata/bafybeidhmknqn4cofjlphtrxpyvruur42t55bfmtcldyb74l2ob22kjjdu.zip similarity index 100% rename from EVES/drafts/EVES-003/metadata/bafybeidhmknqn4cofjlphtrxpyvruur42t55bfmtcldyb74l2ob22kjjdu.zip rename to EVES/EVES-003/metadata/bafybeidhmknqn4cofjlphtrxpyvruur42t55bfmtcldyb74l2ob22kjjdu.zip diff --git a/EVES/drafts/EVES-003/metadata/tzip21_asset_manifest.json b/EVES/EVES-003/metadata/tzip21_asset_manifest.json similarity index 100% rename from EVES/drafts/EVES-003/metadata/tzip21_asset_manifest.json rename to EVES/EVES-003/metadata/tzip21_asset_manifest.json diff --git a/EVES/drafts/EVES-003/metadata/tzip21_token_metadata-schema.json b/EVES/EVES-003/metadata/tzip21_token_metadata-schema.json similarity index 100% rename from EVES/drafts/EVES-003/metadata/tzip21_token_metadata-schema.json rename to EVES/EVES-003/metadata/tzip21_token_metadata-schema.json diff --git a/EVES/drafts/EVES-003/metadata/tzip21_token_metadata.json b/EVES/EVES-003/metadata/tzip21_token_metadata.json similarity index 100% rename from EVES/drafts/EVES-003/metadata/tzip21_token_metadata.json rename to EVES/EVES-003/metadata/tzip21_token_metadata.json diff --git a/EVES/drafts/EVES-004/eves-004.md b/EVES/EVES-004/eves-004.md similarity index 100% rename from EVES/drafts/EVES-004/eves-004.md rename to EVES/EVES-004/eves-004.md diff --git a/EVES/drafts/EVES-005/eves-005.md b/EVES/EVES-005/eves-005.md similarity index 100% rename from EVES/drafts/EVES-005/eves-005.md rename to EVES/EVES-005/eves-005.md diff --git a/EVES/drafts/EVES-006/eves-006.md b/EVES/EVES-006/eves-006.md similarity index 100% rename from EVES/drafts/EVES-006/eves-006.md rename to EVES/EVES-006/eves-006.md diff --git a/EVES/README.md b/EVES/README.md index b736e8a..0b25886 100644 --- a/EVES/README.md +++ b/EVES/README.md @@ -4,17 +4,17 @@ Welcome to the [ENVITED Ecosystem Specifications (EVES) repository](https://gith This repository contains the official specifications for the ENVITED-X Data Space, maintained by the Automotive Solution Center for Simulation e.V. (ASCS). These specifications define and document implementation decisions, processes, and standards for the ecosystem. -For more details on the EVES process, refer to [EVES-001](https://ascs-ev.github.io/EVES/drafts/EVES-001/eves-001.html). +For more details on the EVES process, refer to [EVES-001](https://ascs-ev.github.io/EVES/EVES-001/eves-001.html). ## Repository Structure The repository is organized into the following structure: -📁 `drafts/` -*-> Contains EVES in the Draft stage. Each proposal is under active discussion and subject to change.* +📁 `./` +*-> Contains EVES in the all stages indicated by the status in the header of the specification document.* -📁 `final/` -*-> Contains EVES that have been approved and finalized. These are the official and adopted specifications.* +📁 `protocols/` +*-> contains the meeting minutes for decisions from Editiors and Approvers according to [EVES-004](https://ascs-ev.github.io/EVES/EVES-004/eves-004.html)* 📁 `resources/` *-> Contains additional files such as schemas, templates, and reference implementations related to specific EVES.* @@ -24,9 +24,9 @@ The repository is organized into the following structure: ### Folder Structure Details -#### Drafts Folder +#### Root Folder -📁 `drafts/` +📁 `./` - 📁 `EVES-001/` - 📄 `EVES-001.md` *(Specification in Draft stage)* @@ -37,19 +37,6 @@ The repository is organized into the following structure: - 📄 `EVES-002.md` - 📄 `diagram.png` *(Optional: Diagrams or illustrations for the EVES)* -#### Final Folder - -📁 `final/` - -- 📁 `EVES-001/` - - - 📄 `EVES-001.md` *(Finalized specification)* - - 📄 `reference_implementation.zip` *(Optional: Associated reference implementation)* - -- 📁 `EVES-002/` - - 📄 `EVES-002.md` - - 📄 `schema.json` - #### Resources Folder 📁 `resources/` @@ -62,12 +49,12 @@ The repository is organized into the following structure: ## How to Use This Repository 1. **Explore Specifications**: - - Navigate to `final/` to view adopted specifications. - - Check `drafts/` for work in progress and contribute to discussions. + - Navigate to `SUMMARY.md` to view an overview of the specifications specifications. + - Check the EVES `status` for work in progress and contribute to discussions. 2. **Propose a New EVES**: - Use the template in `resources/eves-template.md` to draft your proposal. - - Follow the guidelines and [contribution rules](https://openmsl.github.io/doc/OpenMSL/organization/index.html) to submit your EVES as a pull request. + - Follow the guidelines and [general contribution rules](https://openmsl.github.io/doc/OpenMSL/organization/index.html) to submit your EVES as a pull request. - Follow the style guidelines. 3. **Contribute to Drafts**: diff --git a/EVES/SUMMARY.md b/EVES/SUMMARY.md index ddba65a..da503f1 100644 --- a/EVES/SUMMARY.md +++ b/EVES/SUMMARY.md @@ -6,9 +6,9 @@ ## EVES -* [EVES-001: ENVITED-X Ecosystem Specification Process](drafts/EVES-001/eves-001.md) -* [EVES-002: ENVITED-X Data Space Architecture Overview](drafts/EVES-002/eves-002.md) -* [EVES-003: ENVITED-X Asset Definition and Upload Process](drafts/EVES-003/eves-003.md) -* [EVES-004: ENVITED-X Roles and Responsibilities of EVES Editors](drafts/EVES-004/eves-004.md) -* [EVES-005: ENVITED-X Contract Negotiation Process](drafts/EVES-005/eves-005.md) -* [EVES-006: ENVITED-X Scaling Architecture](drafts/EVES-006/eves-006.md) +* [EVES-001: ENVITED-X Ecosystem Specification Process](./EVES-001/eves-001.md) +* [EVES-002: ENVITED-X Data Space Architecture Overview](./EVES-002/eves-002.md) +* [EVES-003: ENVITED-X Asset Definition and Upload Process](./EVES-003/eves-003.md) +* [EVES-004: ENVITED-X Roles and Responsibilities of EVES Editors](./EVES-004/eves-004.md) +* [EVES-005: ENVITED-X Contract Negotiation Process](./EVES-005/eves-005.md) +* [EVES-006: ENVITED-X Scaling Architecture](./EVES-006/eves-006.md) diff --git a/README.md b/README.md index 72c5afe..ef8c9a2 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ # ENVITED Ecosystem Specifications (EVES) The goal of the EVES project is to specify and provide high-quality documentation for developing, distributing and using standard-compliant co-simulation artifacts and data. -It is an initiative of the Automotive Solution Center for Simulation e.V. (ASCS) targeting the ecosystem around the [ENVITED-X Data Space](https://envited-x.net/). +It is an initiative of the Automotive Solution Center for Simulation e.V. (ASCS) targeting the ecosystem around the [ENVITED-X Data Space](https://staging.envited-x.net/). The specifications itself are written as independent documents based on so-called "improvement protocols" typically used in de-centralized standardization efforts, e.g. in blockchain domains. These individual specification documents stand for themselves but can inherit from one another by reference. All EVES documents are written in markdown format, sequentially numbered and stored in the [EVES folder](./EVES/). -The process on how to write, submit or change specifications in defined in [EVES-001](./EVES/drafts/EVES-001/eves-001.md). +The process on how to write, submit or change specifications in defined in [EVES-001](./EVES/EVES-001/eves-001.md). ## EVES Overview -| Number | Title | Type | Status | -| ----------------------------------------- | ---------------------------------------------------- | --------- | ------ | -| [001](./EVES/drafts/EVES-001/eves-001.md) | ENVITED-X Ecosystem Specification Process | Process | Review | -| [002](./EVES/drafts/EVES-002/eves-002.md) | ENVITED-X Data Space Architecture Overview | Standards | Draft | -| [003](./EVES/drafts/EVES-003/eves-003.md) | ENVITED-X Asset Definition and Upload Process | Standards | Review | -| [004](./EVES/drafts/EVES-004/eves-004.md) | ENVITED-X Roles and Responsibilities of EVES Editors | Process | Review | -| [005](./EVES/drafts/EVES-005/eves-005.md) | ENVITED-X Contract Negotiation Process | Process | Review | -| [006](./EVES/drafts/EVES-006/eves-006.md) | ENVITED-X Scaling Architecture | Process | Draft | +| Number | Title | Type | Status | +| ---------------------------------- | ---------------------------------------------------- | --------- | ------ | +| [001](./EVES/EVES-001/eves-001.md) | ENVITED-X Ecosystem Specification Process | Process | Review | +| [002](./EVES/EVES-002/eves-002.md) | ENVITED-X Data Space Architecture Overview | Standards | Draft | +| [003](./EVES/EVES-003/eves-003.md) | ENVITED-X Asset Definition and Upload Process | Standards | Review | +| [004](./EVES/EVES-004/eves-004.md) | ENVITED-X Roles and Responsibilities of EVES Editors | Process | Review | +| [005](./EVES/EVES-005/eves-005.md) | ENVITED-X Contract Negotiation Process | Process | Review | +| [006](./EVES/EVES-006/eves-006.md) | ENVITED-X Scaling Architecture | Process | Draft |