Skip to content
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

docs(README): changes proposal #5044

Merged
merged 10 commits into from
Dec 13, 2023
Merged

Conversation

GregoryIvo
Copy link
Contributor

@GregoryIvo GregoryIvo commented Dec 5, 2023

This PR aims to make Kura's readme show off the amazing features it offers to commuters.

Note: We are using the Conventional Commits convention for our pull request titles. Please take a look at the PR title format document for the supported types and scopes.

Brief description of the PR. [e.g. Added null check on object to avoid NullPointerException]

Related Issue: This PR fixes/closes {issue number}

Description of the solution adopted: A more detailed description of the changes made to solve/close one or more issues. If the PR is simple and easy to understand this section can be skipped

Screenshots: If applicable, add screenshots to help explain your solution

Manual Tests: Optional description of the tests performed to check correct functioning of changes, useful for an efficient review

Any side note on the changes made: Description of any other change that has been made, which is not directly linked to the issue resolution [e.g. Code clean up/Sonar issue resolution]

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@salvatore-coppola
Copy link
Contributor

I would add other items about the rest apis and java apis to emphasise the programmability of the platform

@mattdibi mattdibi changed the title README.md changes proposal docs(README): changes proposal Dec 6, 2023
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@GregoryIvo GregoryIvo marked this pull request as ready for review December 8, 2023 16:48
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Comment on lines +24 to +34
* **Kura™ Services:** Provision and set up features to run on your gateway, such as an MQTT broker.
* **Kura™ Networking:** Manage Network connectivity, including
* **Kura™ Wires:** Design data flows and data processing streams effortlessly with a drag-and-drop visual editor.
* **Kura™ Cloud Connectors:** Extendable cloud connector system.
* **Kura™ Drivers:** Extendable service that handles reading data off of external devices.
* **Kura™ Snapshots:** Securely store and re-apply gateway settings for convenience.
* **Kura™ Security**: Easily and safely store your secrets.
* **Kura™ Container Orchestrator**: Manage Docker or Podman containers on your gateway for ultimate flexibility.
* **Kura™ AI Inference**: Run Nvidia Triton Models on the edge.
* **Kura™ Plugins**: Add and Extend the framework by adding your own Services, and Drivers.
* **Kura™ REST Service**: Embed the framework as a backend in your own edge applications.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 Thinking about it, having all these "Kura™"s is a little redundant maybe? What do you think? Is there a better way? We can also leave this as-is...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a tough call. If eclipse actually holds the kura trademark we should definitely actively protect it. (Or else will loose the rights to it).

Having all the TM's really makes the list hurt to look at.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I was talking about the whole "Kura *" stuff... Like, I know it's "Kura Services" we're talking about the Kura project. Would only "Services" or something similar work?

GregoryIvo and others added 2 commits December 12, 2023 16:38
Co-authored-by: Mattia Dal Ben <[email protected]>
Co-authored-by: Mattia Dal Ben <[email protected]>
@mattdibi mattdibi merged commit ab9a34d into eclipse-kura:develop Dec 13, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants