Skip to content

fix: folder structure by removing the draft folder #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dansan566 merged 2 commits into from
Feb 25, 2025
Merged

fix: folder structure by removing the draft folder #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd36d1e
fix: folder structure by removing the draft folder
jdsika Feb 25, 2025
d967d63
Update README.md
dansan566 Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions EVES/drafts/EVES-001/eves-001.md → EVES/EVES-001/eves-001.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**:
Expand Down Expand Up @@ -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)
4 changes: 2 additions & 2 deletions EVES/drafts/EVES-002/eves-002.md → EVES/EVES-002/eves-002.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
- 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).

Check failure on line 67 in EVES/EVES-002/eves-002.md

View workflow job for this annotation

GitHub Actions / vale

[vale] EVES/EVES-002/eves-002.md#L67 

[Vale.Spelling] Did you really mean 'NFTs'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'NFTs'?", "location": {"path": "EVES/EVES-002/eves-002.md", "range": {"start": {"line": 67, "column": 13}}}, "severity": "ERROR"}
- **Standards**:
- FA2.1 compliance for token creation and ticket-based interoperability.

Expand Down Expand Up @@ -144,7 +144,7 @@
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)

Check notice on line 147 in EVES/EVES-002/eves-002.md

View workflow job for this annotation

GitHub Actions / vale

[vale] EVES/EVES-002/eves-002.md#L147 

[Google.Acronyms] Spell out 'EVES', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'EVES', if it's unfamiliar to the audience.", "location": {"path": "EVES/EVES-002/eves-002.md", "range": {"start": {"line": 147, "column": 5}}}, "severity": "INFO"}
6. [Gaia-X Trust Framework](https://docs.gaia-x.eu/policy-rules-committee/compliance-document/24.11/)

## Implementation
Expand Down
0 EVES/drafts/EVES-003/eves-003.md → EVES/EVES-003/eves-003.md
View file
Open in desktop
File renamed without changes.
0 EVES/drafts/EVES-003/metadata/Readme.md → EVES/EVES-003/metadata/Readme.md
View file
Open in desktop
File renamed without changes.
0 ...trxpyvruur42t55bfmtcldyb74l2ob22kjjdu.zip → ...trxpyvruur42t55bfmtcldyb74l2ob22kjjdu.zip
View file
Open in desktop
File renamed without changes.
0 ...S-003/metadata/tzip21_asset_manifest.json → ...S-003/metadata/tzip21_asset_manifest.json
View file
Open in desktop
File renamed without changes.
0 ...etadata/tzip21_token_metadata-schema.json → ...etadata/tzip21_token_metadata-schema.json
View file
Open in desktop
File renamed without changes.
0 ...S-003/metadata/tzip21_token_metadata.json → ...S-003/metadata/tzip21_token_metadata.json
View file
Open in desktop
File renamed without changes.
0 EVES/drafts/EVES-004/eves-004.md → EVES/EVES-004/eves-004.md
View file
Open in desktop
File renamed without changes.
0 EVES/drafts/EVES-005/eves-005.md → EVES/EVES-005/eves-005.md
View file
Open in desktop
File renamed without changes.
0 EVES/drafts/EVES-006/eves-006.md → EVES/EVES-006/eves-006.md
View file
Open in desktop
File renamed without changes.
33 changes: 10 additions & 23 deletions EVES/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@
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)*

Check failure on line 17 in EVES/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] EVES/README.md#L17 

[Vale.Spelling] Did you really mean 'Editiors'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Editiors'?", "location": {"path": "EVES/README.md", "range": {"start": {"line": 17, "column": 53}}}, "severity": "ERROR"}

Check failure on line 17 in EVES/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] EVES/README.md#L17 

[Vale.Spelling] Did you really mean 'Approvers'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Approvers'?", "location": {"path": "EVES/README.md", "range": {"start": {"line": 17, "column": 66}}}, "severity": "ERROR"}

📁 `resources/`
*-> Contains additional files such as schemas, templates, and reference implementations related to specific EVES.*
Expand All @@ -24,9 +24,9 @@

### Folder Structure Details

#### Drafts Folder
#### Root Folder

Check warning on line 27 in EVES/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] EVES/README.md#L27 

[Google.Headings] 'Root Folder' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Root Folder' should use sentence-style capitalization.", "location": {"path": "EVES/README.md", "range": {"start": {"line": 27, "column": 6}}}, "severity": "WARNING"}

📁 `drafts/`
📁 `./`

- 📁 `EVES-001/`
- 📄 `EVES-001.md` *(Specification in Draft stage)*
Expand All @@ -37,19 +37,6 @@
- 📄 `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/`
Expand All @@ -62,12 +49,12 @@
## 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 failure on line 52 in EVES/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] EVES/README.md#L52 

[Vale.Repetition] 'specifications' is repeated!
Raw output 
{"message": "[Vale.Repetition] 'specifications' is repeated!", "location": {"path": "EVES/README.md", "range": {"start": {"line": 52, "column": 58}}}, "severity": "ERROR"}
- 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**:
Expand Down
12 changes: 6 additions & 6 deletions EVES/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Check notice on line 9 in EVES/SUMMARY.md

View workflow job for this annotation

GitHub Actions / vale

[vale] EVES/SUMMARY.md#L9 

[Google.Acronyms] Spell out 'EVES', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'EVES', if it's unfamiliar to the audience.", "location": {"path": "EVES/SUMMARY.md", "range": {"start": {"line": 9, "column": 4}}}, "severity": "INFO"}
* [EVES-002: ENVITED-X Data Space Architecture Overview](./EVES-002/eves-002.md)

Check notice on line 10 in EVES/SUMMARY.md

View workflow job for this annotation

GitHub Actions / vale

[vale] EVES/SUMMARY.md#L10 

[Google.Acronyms] Spell out 'EVES', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'EVES', if it's unfamiliar to the audience.", "location": {"path": "EVES/SUMMARY.md", "range": {"start": {"line": 10, "column": 4}}}, "severity": "INFO"}
* [EVES-003: ENVITED-X Asset Definition and Upload Process](./EVES-003/eves-003.md)

Check notice on line 11 in EVES/SUMMARY.md

View workflow job for this annotation

GitHub Actions / vale

[vale] EVES/SUMMARY.md#L11 

[Google.Acronyms] Spell out 'EVES', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'EVES', if it's unfamiliar to the audience.", "location": {"path": "EVES/SUMMARY.md", "range": {"start": {"line": 11, "column": 4}}}, "severity": "INFO"}
* [EVES-004: ENVITED-X Roles and Responsibilities of EVES Editors](./EVES-004/eves-004.md)

Check notice on line 12 in EVES/SUMMARY.md

View workflow job for this annotation

GitHub Actions / vale

[vale] EVES/SUMMARY.md#L12 

[Google.Acronyms] Spell out 'EVES', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'EVES', if it's unfamiliar to the audience.", "location": {"path": "EVES/SUMMARY.md", "range": {"start": {"line": 12, "column": 4}}}, "severity": "INFO"}

Check notice on line 12 in EVES/SUMMARY.md

View workflow job for this annotation

GitHub Actions / vale

[vale] EVES/SUMMARY.md#L12 

[Google.Acronyms] Spell out 'EVES', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'EVES', if it's unfamiliar to the audience.", "location": {"path": "EVES/SUMMARY.md", "range": {"start": {"line": 12, "column": 54}}}, "severity": "INFO"}
* [EVES-005: ENVITED-X Contract Negotiation Process](./EVES-005/eves-005.md)

Check notice on line 13 in EVES/SUMMARY.md

View workflow job for this annotation

GitHub Actions / vale

[vale] EVES/SUMMARY.md#L13 

[Google.Acronyms] Spell out 'EVES', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'EVES', if it's unfamiliar to the audience.", "location": {"path": "EVES/SUMMARY.md", "range": {"start": {"line": 13, "column": 4}}}, "severity": "INFO"}
* [EVES-006: ENVITED-X Scaling Architecture](./EVES-006/eves-006.md)

Check notice on line 14 in EVES/SUMMARY.md

View workflow job for this annotation

GitHub Actions / vale

[vale] EVES/SUMMARY.md#L14 

[Google.Acronyms] Spell out 'EVES', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'EVES', if it's unfamiliar to the audience.", "location": {"path": "EVES/SUMMARY.md", "range": {"start": {"line": 14, "column": 4}}}, "severity": "INFO"}
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/).

Check warning on line 4 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L4 

[write-good.TooWordy] 'It is' is too wordy.
Raw output 
{"message": "[write-good.TooWordy] 'It is' is too wordy.", "location": {"path": "README.md", "range": {"start": {"line": 4, "column": 1}}}, "severity": "WARNING"}

Check notice on line 4 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L4 

[Google.Contractions] Use 'it's' instead of 'It is'.
Raw output 
{"message": "[Google.Contractions] Use 'it's' instead of 'It is'.", "location": {"path": "README.md", "range": {"start": {"line": 4, "column": 1}}}, "severity": "INFO"}

Check notice on line 4 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L4 

[write-good.E-Prime] Try to avoid using 'is'.
Raw output 
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "README.md", "range": {"start": {"line": 4, "column": 4}}}, "severity": "INFO"}

Check failure on line 4 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L4 

[Google.Spacing] 'e.V' should have one space.
Raw output 
{"message": "[Google.Spacing] 'e.V' should have one space.", "location": {"path": "README.md", "range": {"start": {"line": 4, "column": 70}}}, "severity": "ERROR"}

Check notice on line 4 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L4 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "README.md", "range": {"start": {"line": 4, "column": 75}}}, "severity": "INFO"}

Check notice on line 4 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L4 

[Google.Acronyms] Spell out 'ASCS', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'ASCS', if it's unfamiliar to the audience.", "location": {"path": "README.md", "range": {"start": {"line": 4, "column": 76}}}, "severity": "INFO"}

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).

Check warning on line 9 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L9 

[Google.OxfordComma] Use the Oxford comma in 'The process on how to write, submit or'.
Raw output 
{"message": "[Google.OxfordComma] Use the Oxford comma in 'The process on how to write, submit or'.", "location": {"path": "README.md", "range": {"start": {"line": 9, "column": 1}}}, "severity": "WARNING"}

## 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 |