-
Couldn't load subscription status.
- Fork 61
Aligned with eiffel-community repository guidelines #193
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.
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
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| <!--- | ||
| Copyright 2017 Ericsson AB. | ||
| Copyright 2017-2018 Ericsson AB. | ||
| For a full list of individual contributors, please see the commit history. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
|
|
@@ -15,16 +15,24 @@ | |
| limitations under the License. | ||
| ---> | ||
|
|
||
| # Eiffel | ||
| The Eiffel framework enables technology agnostic enterprise scale continuous integration and delivery with maintained scalability, flexibility and traceability. Eiffel is based on the concept of decentralized real time messaging, both to drive the continuous integration and delivery system and to document it. | ||
| <img src="./images/eiffel-protocol-logo.png" alt="Eiffel Protocol" width="350"/> | ||
|
|
||
| This repository contains the Eiffel framework vocabulary, descriptions, guides and schemas along with links to relevant implementation repositories. For news, discussions and questions, please visit the [Eiffel Community Google group](https://groups.google.com/forum/#!forum/eiffel-community). | ||
| # Eiffel Protocol | ||
| The Eiffel protocol enables technology agnostic enterprise scale continuous integration and delivery with maintained scalability, flexibility and traceability. Eiffel is based on the concept of decentralized real time messaging, both to drive the continuous integration and delivery system and to document it. | ||
|
|
||
| Eiffel is licensed under the [Apache License 2.0](./LICENSE). | ||
| This repository contains the Eiffel protocol vocabulary, descriptions, guides and schemas. For implementations, implementations, architecture and community resources, visit the [Eiffel Community](https://eiffel-community.github.io). | ||
|
|
||
| __IMPORTANT NOTICE:__ The contents of this repository currectly reflect a __DRAFT__. The Eiffel framework has been used in production within Ericsson for several years to great effect; what is presented here is a revision and evolution of that framework - an evolution that is currently ongoing. In other words, anything in this repository should be regarded as tentative and subject to change. It is published here to allow early access and trial and to solicit early feedback. | ||
| # About this repository | ||
| The contents of this repository are licensed under the [Apache License 2.0](./LICENSE). | ||
|
|
||
| ## Contents | ||
| To get involved, please see [Code of Conduct](./CODE_OF_CONDUCT.md) and [contribution guidelines](./CONTRIBUTING.md). | ||
|
|
||
| # About Eiffel | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think the Eiffel Protocol above and this section 'About Eiffel' does not really make the distinction between Eiffel and the Eiffel Protocol clear enough, instead it adds to the confusion betweem them. The Eiffel Community manages a protocol and a set of implementations enabling the use of that protocol. Now, some text in 'Eiffel Protocol' above is duplicated but slightly reformulated in this 'About Eiffel' section. I think this 'About Eiffel' section is redundant and can be removed, while some of its details or phrasing could possibly be moved to the 'Eiffel Protocol' section above. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You're right. I would solve it differently, though. The "About Eiffel" section is copy-pasted from the eiffel-community repository template, and there's a point to being consistent across repositories. Instead I removed the redundant statements in the first paragraph. What do you think, does that work? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Works fine |
||
| This repository forms part of the Eiffel Community. Eiffel is a protocol for technology agnostic machine-to-machine communication in continuous integration and delivery pipelines, aimed at securing scalability, flexibility and traceability. Eiffel is based on the concept of decentralized real time messaging, both to drive the continuous integration and delivery system and to document it. | ||
|
|
||
| Visit [Eiffel Community](https://eiffel-community.github.io) to get started and get involved. | ||
|
|
||
| # Contents | ||
| 1. [Introduction](./introduction/introduction.md) | ||
| 1. [How to Propose Changes and Contribute](./CONTRIBUTING.md) | ||
| 1. [Code of Conduct](./CODE_OF_CONDUCT.md) | ||
|
|
@@ -71,12 +79,5 @@ __IMPORTANT NOTICE:__ The contents of this repository currectly reflect a __DRAF | |
| 1. Customization | ||
| 1. [Custom Events](./customization/custom-events.md) | ||
| 1. [Custom Data](./customization/custom-data.md) | ||
| 1. Implementations | ||
| 1. [Event Persistence](./implementations/event-persistence.md) | ||
| 1. [Event Aggregation and Analysis](./implementations/event-aggregation-and-analysis.md) | ||
| 1. Activity Orchestration | ||
| 1. Event Transport and Routing | ||
| 1. [Event Dispatch](./implementations/event-dispatch.md) | ||
| 1. [Visualization](./implementations/visualization.md) | ||
| 1. Extensions | ||
| 1. [Eiffel Operations Extension](https://github.com/Ericsson/eiffel-operations-extension) | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is probably the only (?) reference to old Ericsson labeled stuff in this repository. I understand it is not feasible to move that to eiffel-community within this PR, but maybe the link should have an accompanying comment stating that it is planned to be moved to eiffel-community in due time? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I disagree. Sure, we can move the operations extension to eiffel-community if those involved in it wish to do so (although that would actual active maintainers). That's beside the point, though - extensions could be provided by John Doe and his second cousins and be published wherever for all I care. This one just happens to be hosted by the Ericsson organization. Does that make sense? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Accepted |
||
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
repetition...
implementations, implementations
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Fixed.