Skip to content

Commit

Permalink
docs: update documentation links
Browse files Browse the repository at this point in the history
  • Loading branch information
mattdibi committed Sep 27, 2024
1 parent 6c5ba99 commit 498daec
Show file tree
Hide file tree
Showing 7 changed files with 337 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Eclipse Kura™

<div align="center">

[![GitHub Tag](https://img.shields.io/github/v/tag/eclipse/kura?label=Latest%20Tag)](https://github.com/eclipse/kura/tags)
[![GitHub](https://img.shields.io/github/license/eclipse/kura?label=License)](https://github.com/eclipse/kura/blob/develop/LICENSE)
[![GitHub Tag](https://img.shields.io/github/v/tag/eclipse/kura?label=Latest%20Tag)](https://github.com/eclipse-kura/kura/tags)
[![GitHub](https://img.shields.io/github/license/eclipse/kura?label=License)](https://github.com/eclipse-kura/kura/blob/develop/LICENSE)

[![Jenkins](https://img.shields.io/jenkins/build?jobUrl=https:%2F%2Fci.eclipse.org%2Fkura%2Fjob%2Fmultibranch%2Fjob%2Fdevelop&label=Jenkins%20Build&logo=jenkins)](https://ci.eclipse.org/kura/job/multibranch/job/develop/)
[![Jenkins](https://img.shields.io/jenkins/tests?compact_message&failed_label=%E2%9D%8C&jobUrl=https:%2F%2Fci.eclipse.org%2Fkura%2Fjob%2Fmultibranch%2Fjob%2Fdevelop%2F&label=Jenkins%20CI&passed_label=%E2%9C%85&skipped_label=%E2%9D%95&logo=jenkins)](https://ci.eclipse.org/kura/job/multibranch/) <br/>
Expand Down Expand Up @@ -39,14 +39,14 @@ If you want to scale, and manage many instances of Eclipse Kura™, check out [*
Documentation
-------------------

- [**User Documentation**](https://eclipse.github.io/kura/latest/): here you'll find information on how to **use** Eclipse Kura™ i.e. installation instructions, informations on how to use the web UI and tutorials.
- [**Developer Documentation**](https://github.com/eclipse/kura/wiki): the Eclipse Kura™ Github Wiki serves as a reference for **developers** who want to contribute to the Eclipse Kura™ project and/or develop new add-ons. Here you'll find Eclipse Kura™ development/release model, guidelines on how to import internal packages, creating new bundles and development environment tips & tricks.
- [**User Documentation**](https://eclipse-kura.github.io/kura/latest/): here you'll find information on how to **use** Eclipse Kura™ i.e. installation instructions, informations on how to use the web UI and tutorials.
- [**Developer Documentation**](https://github.com/eclipse-kura/kura/wiki): the Eclipse Kura™ Github Wiki serves as a reference for **developers** who want to contribute to the Eclipse Kura™ project and/or develop new add-ons. Here you'll find Eclipse Kura™ development/release model, guidelines on how to import internal packages, creating new bundles and development environment tips & tricks.
- [**Docker Containers Documentation**](https://hub.docker.com/r/eclipse/kura/): the Eclipse Kura™ team also provides Docker containers for the project. Information on how to build and run them are available at the project's Docker Hub page.
- [**Developer Quickstart Guide**](https://github.com/eclipse/kura#build): a quick guide on how to setup the development environment and build the project is also provided in this README.
- [**Developer Quickstart Guide**](https://github.com/eclipse-kura/kura#build): a quick guide on how to setup the development environment and build the project is also provided in this README.

Additionally, we provide two channels for reporting any issue you find with the project
- [**Github Issues**](https://github.com/eclipse/kura/issues): for bug reporting.
- [**Github Discussions**](https://github.com/eclipse/kura/discussions): for receiving feedback, asking questions, making new proposals and generally talking about the project.
- [**Github Issues**](https://github.com/eclipse-kura/kura/issues): for bug reporting.
- [**Github Discussions**](https://github.com/eclipse-kura/kura/discussions): for receiving feedback, asking questions, making new proposals and generally talking about the project.

Install
-------
Expand All @@ -55,7 +55,7 @@ Eclipse Kura™ is compatible with Java 8 and Java 17.

### Target Gateways Installers
Eclipse Kura™ provides pre-built installers for common development boards. Check the following [link](https://www.eclipse.org/kura/downloads.php) to download the desired installers.
Take a look at [our documentation](https://eclipse.github.io/kura/latest/getting-started/install-kura/) for further information on supported platforms and installer types.
Take a look at [our documentation](https://eclipse-kura.github.io/kura/latest/getting-started/install-kura/) for further information on supported platforms and installer types.

### Docker Image
Eclipse Kura™ is also available as a [Docker container](https://hub.docker.com/r/eclipse/kura/).
Expand Down Expand Up @@ -190,8 +190,8 @@ IDE Setups

We currently support two setups for Eclipse Kura™ development:

- [**Eclipse Kura™ Development Environment Setup**](https://eclipse.github.io/kura/latest/java-application-development/development-environment-setup/): This is the full setup allowing you to contribute to the core Eclipse Kura™ project codebase. It will install all the IDE plugins and formatters to have a pleasant development experience and clone the Eclipse Kura™ source code on your workstation.
- [**Add-on Development Environment Setup**](https://eclipse.github.io/kura/latest/java-application-development/kura-workspace-setup/): This setup will allow you to develop applications or bundles running on Eclipse Kura™. It will install only the APIs and the examples and is best suited for developing Eclipse Kura™ add-ons.
- [**Eclipse Kura™ Development Environment Setup**](https://eclipse-kura.github.io/kura/latest/java-application-development/development-environment-setup/): This is the full setup allowing you to contribute to the core Eclipse Kura™ project codebase. It will install all the IDE plugins and formatters to have a pleasant development experience and clone the Eclipse Kura™ source code on your workstation.
- [**Add-on Development Environment Setup**](https://eclipse-kura.github.io/kura/latest/java-application-development/kura-workspace-setup/): This setup will allow you to develop applications or bundles running on Eclipse Kura™. It will install only the APIs and the examples and is best suited for developing Eclipse Kura™ add-ons.

Contributing
------------
Expand Down
17 changes: 17 additions & 0 deletions kura/.vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
// List of extensions which should be recommended for users of this workspace.
"recommendations": [
"redhat.java",
"vscjava.vscode-java-debug",
"vscjava.vscode-java-dependency",
"vscjava.vscode-java-pack",
"vscjava.vscode-java-test",
"vscjava.vscode-maven",
"sonarsource.sonarlint-vscode",
"yaozheng.vscode-pde"
],
// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
"unwantedRecommendations": [

]
}
125 changes: 125 additions & 0 deletions kura/.vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
{
"version": "0.2.0",
"configurations": [
{
"type": "java",
"name": "Remote Kura debug",
"request": "attach",
"hostName": "${input:ipAddress}",
"projectName": "${input:bundleProject}",
"port": 8000
}
],
"inputs": [
{
"id": "ipAddress",
"type": "promptString",
"description": "IP Address of the device running Kura"
},
{
"id": "bundleProject",
"type": "pickString",
"description": "Select the bundle project to be debugged",
"options":[
"org.eclipse.kura.ai.triton.server",
"org.eclipse.kura.api",
"org.eclipse.kura.asset.cloudlet.provider",
"org.eclipse.kura.asset.helper.provider",
"org.eclipse.kura.asset.provider",
"org.eclipse.kura.ble.eddystone.provider",
"org.eclipse.kura.ble.ibeacon.provider",
"org.eclipse.kura.ble.provider",
"org.eclipse.kura.broker.artemis.core",
"org.eclipse.kura.broker.artemis.simple.mqtt",
"org.eclipse.kura.broker.artemis.xml",
"org.eclipse.kura.camel",
"org.eclipse.kura.camel.cloud.factory",
"org.eclipse.kura.camel.xml",
"org.eclipse.kura.cloudconnection.eclipseiot.mqtt.provider",
"org.eclipse.kura.cloudconnection.raw.mqtt.provider",
"org.eclipse.kura.configuration.change.manager",
"org.eclipse.kura.container.orchestration.provider",
"org.eclipse.kura.container.provider",
"org.eclipse.kura.core",
"org.eclipse.kura.core.certificates",
"org.eclipse.kura.core.cloud",
"org.eclipse.kura.core.cloud.factory",
"org.eclipse.kura.core.comm",
"org.eclipse.kura.core.configuration",
"org.eclipse.kura.core.crypto",
"org.eclipse.kura.core.deployment",
"org.eclipse.kura.core.inventory",
"org.eclipse.kura.core.keystore",
"org.eclipse.kura.core.net",
"org.eclipse.kura.core.status",
"org.eclipse.kura.core.system",
"org.eclipse.kura.core.tamper.detection",
"org.eclipse.kura.db.sqlite.provider",
"org.eclipse.kura.deployment.agent",
"org.eclipse.kura.docs",
"org.eclipse.kura.driver.ble.sensortag.provider",
"org.eclipse.kura.driver.ble.xdk",
"org.eclipse.kura.driver.block",
"org.eclipse.kura.driver.eddystone.provider",
"org.eclipse.kura.driver.gpio.provider",
"org.eclipse.kura.driver.helper.provider",
"org.eclipse.kura.driver.ibeacon.provider",
"org.eclipse.kura.driver.opcua.provider",
"org.eclipse.kura.driver.s7plc.provider",
"org.eclipse.kura.event.publisher",
"org.eclipse.kura.hook.file.move.provider",
"org.eclipse.kura.http.server.manager",
"org.eclipse.kura.json.marshaller.unmarshaller.provider",
"org.eclipse.kura.linux.bluetooth",
"org.eclipse.kura.linux.clock",
"org.eclipse.kura.linux.command",
"org.eclipse.kura.linux.debian.provider",
"org.eclipse.kura.linux.gpio",
"org.eclipse.kura.linux.net",
"org.eclipse.kura.linux.position",
"org.eclipse.kura.linux.redhat.provider",
"org.eclipse.kura.linux.systemd.provider",
"org.eclipse.kura.linux.sysv.provider",
"org.eclipse.kura.linux.usb",
"org.eclipse.kura.linux.usb.aarch64",
"org.eclipse.kura.linux.usb.armv6hf",
"org.eclipse.kura.linux.usb.x86_64",
"org.eclipse.kura.linux.watchdog",
"org.eclipse.kura.localization",
"org.eclipse.kura.localization.resources",
"org.eclipse.kura.log.filesystem.provider",
"org.eclipse.kura.misc.cloudcat",
"org.eclipse.kura.net.admin",
"org.eclipse.kura.net.admin.firewall",
"org.eclipse.kura.net.configuration",
"org.eclipse.kura.network.threat.manager",
"org.eclipse.kura.nm",
"org.eclipse.kura.protocol.can",
"org.eclipse.kura.protocol.modbus",
"org.eclipse.kura.request.handler.jaxrs",
"org.eclipse.kura.rest.asset.provider",
"org.eclipse.kura.rest.configuration.provider",
"org.eclipse.kura.rest.network.status.provider",
"org.eclipse.kura.rest.provider",
"org.eclipse.kura.rest.wire.provider",
"org.eclipse.kura.stress",
"org.eclipse.kura.useradmin.store",
"org.eclipse.kura.util",
"org.eclipse.kura.web2",
"org.eclipse.kura.web2.ext",
"org.eclipse.kura.wire.ai.component.provider",
"org.eclipse.kura.wire.camel",
"org.eclipse.kura.wire.component.conditional.provider",
"org.eclipse.kura.wire.component.join.provider",
"org.eclipse.kura.wire.component.provider",
"org.eclipse.kura.wire.db.component.provider",
"org.eclipse.kura.wire.h2db.component.provider",
"org.eclipse.kura.wire.helper.provider",
"org.eclipse.kura.wire.provider",
"org.eclipse.kura.wire.script.filter.provider",
"org.eclipse.kura.wire.script.tools",
"org.eclipse.kura.xml.marshaller.unmarshaller.provider"
]
}
]
}
12 changes: 12 additions & 0 deletions kura/.vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"java.format.settings.url": "setups/formatting/KuraFormatter.xml",
"editor.defaultFormatter": "redhat.java",
"editor.formatOnSave": true,
"java.debug.settings.onBuildFailureProceed": true,
"java.compile.nullAnalysis.mode": "automatic",
"java.configuration.updateBuildConfiguration": "interactive",
"sonarlint.connectedMode.project": {
"connectionId": "eclipse-kura",
"projectKey": "org.eclipse.kura:kura"
}
}
Loading

0 comments on commit 498daec

Please sign in to comment.