Skip to content

Commit

Permalink
Editorial update (#193)
Browse files Browse the repository at this point in the history
** Editorial Updates **

- Editorial Update Section 1
- Editorial Update Section 2
- Editorial Update Section 3.1
- Editorial Update Section 3.2
- Editorial Update Section 3.3
- Editorial Update Section 3.3
- Editorial Update Section 3.4
- Editorial Update Section 3.5
- Editorial Update Section 4.1
- Editorial Update Section 4.2
- Editorial Update Section 4.3
- Adding Front Matter
   - License CC-BY 4.0
   - Update Authors, Contributors, Maintainers
- Structural references in README files
- fixing links
- appending styles for headings and figures
  • Loading branch information
ssteinbuss authored Oct 17, 2022
1 parent 54ee564 commit 16e656d
Show file tree
Hide file tree
Showing 121 changed files with 1,772 additions and 1,190 deletions.
80 changes: 33 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,55 @@
# IDS RAM 4.0 (Public preview)
# IDS RAM 4.0 #

Welcome to the IDS RAM 4.0 repository of the [IDSA](../../../idsa). This repository is the working
version of the IDS RAM 4.0. It was initialized with [IDS RAM 3.0](https://internationaldataspaces.org/download/16630/).
Welcome to the IDS RAM 4.0 repository of the [IDSA](../../../idsa).

Most relevant content is already added to this repository, but some aspects are still in progress. You can today:
- Read the [current version in Markdown](https://github.com/International-Data-Spaces-Association/IDS-RAM_4_0/tree/main/documentation)
- Raise an [issue](https://github.com/International-Data-Spaces-Association/IDS-RAM_4_0/issues) on existing content or new content
- Check the open [pull requests](https://github.com/International-Data-Spaces-Association/IDS-RAM_4_0/pulls)



_Please note that this is not yet the official and approved version of the IDS RAM 4.0._

## Overview
## Overview ##

Please consider the following information:

- [Code of Conduct](./CODE_OF_CONDUCT.md),
- [How to Contribute](./CONTRIBUTING.md),
- [License](./LICENSE.md),
- [Changelog](./CHANGELOG.md),
- [Changelog](./CHANGELOG.md),

and check the open [issues](https://github.com/International-Data-Spaces-Association/IDS-RAM_4_0/issues)
and [pull requests](https://github.com/International-Data-Spaces-Association/IDS-RAM_4_0/pulls).

The [IDS-G](https://github.com/International-Data-Spaces-Association/IDS-G) provides additional
information to the IDS RAM.

## Schedule
The IDS RAM 4.0 should be released end of April 2022.

Regular touchpoints will be conducted starting from October 25th 2021:
- Mondays 4 pm to 4:30 pm (weekly)


## Scope
## Scope ##

The IDS RAM is complemented with additional documents and repositories. Most relevant in this
context is the IDS-G (including IDS-G-pre).
context is the [IDS-G](https://github.com/International-Data-Spaces-Association/IDS-G).

In general, the IDS RAM contains the conceptual level including technology-agnostic specifications.
The general outline of the IDS RAM is based on the five layers and the three perspectives. Each
layer should reflect the main components and aspects of the IDS.

The IDS-G contains specific details on specifications, e.g. APIs and their descriptions.

The IDS RAM 4.0 will be created as an online document and does not target a printed document, at first.
This enables the use of linking contents more easily, e.g. creating references to the IDS-G.
After that, a printable White Paper of the IDS RAM should be generated from this repository.
There, the main outline of the concepts shall be described.

## Structure

The [content](./content.md) describes the target structure of the document.
The following list provides direct links to the existing chapters.

### Sections of the RAM
// TODO to be completed
- [Section 1: Introduction](./documentation/1_Introduction/)
- [Section 2: Context of IDS](./documentation/2_Context_of_the_International_Data_Spaces/)
- [Section 3: Layers of the RAM ](./documentation/3_Layers_of_the_Reference_Architecture_Model/)
- [Section 3.1: Business Layer](./documentation/3_Layers_of_the_Reference_Architecture_Model/3_1_Business_Layer/)
- [Section 3.2: Functional Layer](./documentation/3_Layers_of_the_Reference_Architecture_Model/3_2_Functional_Layer/)
- [Section 3.3: Process Layer](./documentation/3_Layers_of_the_Reference_Architecture_Model/3_3_Process_Layer/)
- [Section 3.4: Information Layer](./documentation/3_Layers_of_the_Reference_Architecture_Model/3_4_Information_Layer/)
- [Section 3.5: System Layer](./documentation/3_Layers_of_the_Reference_Architecture_Model/3_5_System_Layer/)
- [Section 4: Perspectives of the RAM](./documentation/4_Perspectives_of_the_Reference_Architecture_Model/)
- [Section 4.1: Security Perspective](./documentation/4_Perspectives_of_the_Reference_Architecture_Model/4_1_Security_Perspective/)
- [Section 4.2: Certification Perspective](./documentation/4_Perspectives_of_the_Reference_Architecture_Model/4_2_Certification_Perspective/)
- [Section 4.3: Governance Perspective](./documentation/4_Perspectives_of_the_Reference_Architecture_Model/4_3_Government_Perspective/)
## Structure ##

- [Front Matter](./documentation/FrontMatter.md)
- [Section 1: Introduction](./documentation/1_Introduction/README.md)
- [Section 2: Context of IDS](./documentation/2_Context_of_the_International_Data_Spaces/README.md)
- [Section 3: Layers of the RAM](./documentation/3_Layers_of_the_Reference_Architecture_Model/README.md)
- [Section 3.1: Business Layer](./documentation/3_Layers_of_the_Reference_Architecture_Model/3_1_Business_Layer/README.md)
- [Section 3.2: Functional Layer](./documentation/3_Layers_of_the_Reference_Architecture_Model/3_2_Functional_Layer/README.md)
- [Section 3.3: Information Layer](./documentation/3_Layers_of_the_Reference_Architecture_Model/3_3_Information_Layer/README.md)
- [Section 3.4: Process Layer](./documentation/3_Layers_of_the_Reference_Architecture_Model/3_4_Process_Layer/README.md)
- [Section 3.5: System Layer](./documentation/3_Layers_of_the_Reference_Architecture_Model/3_5_System_Layer/README.md)
- [Section 4: Perspectives of the RAM](./documentation/4_Perspectives_of_the_Reference_Architecture_Model/README.md)
- [Section 4.1: Security Perspective](./documentation/4_Perspectives_of_the_Reference_Architecture_Model/4_1_Security_Perspective/README.md)
- [Section 4.2: Certification Perspective](./documentation/4_Perspectives_of_the_Reference_Architecture_Model/4_2_Certification_Perspective/README.md)
- [Section 4.3: Governance Perspective](./documentation/4_Perspectives_of_the_Reference_Architecture_Model/4_3_Governance_Perspective/README.md)

**Appendix**

- [Glossary](https://github.com/International-Data-Spaces-Association/IDS-G/tree/main/Glossary)

## Previous Versions ##

- [IDS RAM 3.0](https://internationaldataspaces.org/download/16630/)
- [IDS RAM 2.0](https://internationaldataspaces.org/download/16641/)
- [IDS RAM 1.0](https://internationaldataspaces.org/download/16652/)
273 changes: 0 additions & 273 deletions content.md

This file was deleted.

Loading

0 comments on commit 16e656d

Please sign in to comment.