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: Added note about newer Eclipse IDE version #5034

Closed
wants to merge 6 commits into from

Conversation

salvatore-coppola
Copy link
Contributor

@mattdibi do you know how to have a better note box like the following ?

Note box

@salvatore-coppola salvatore-coppola changed the title docs: Update README.md docs: Added note about newer Eclipse IDE version Nov 30, 2023
@mattdibi
Copy link
Contributor

@salvatore-coppola I wouldn't put this info in the main readme: the main readme should contain minimal information for the setup. I would add this to the Wiki (or to the missing extensive DevEnv setup guide)...

Anyway like this:

Warning

TEST

Code:

> [!WARNING]  
TEST

@salvatore-coppola
Copy link
Contributor Author

salvatore-coppola commented Nov 30, 2023

@salvatore-coppola I wouldn't put this info in the main readme: the main readme should contain minimal information for the setup. I would add this to the Wiki (or to the missing extensive DevEnv setup guide)...

Anyway like this:

Warning

TEST

Code:

> [!WARNING]  
TEST

in a previous meeting with @MMaiero we decide to put this in the main README beucase it's too important make the users quickly able to work on Kura with Eclipse IDE, but maybe I remember wrongly

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@salvatore-coppola salvatore-coppola force-pushed the add-new-eclipse-ide-settings branch from eda6aa5 to 8dd2e65 Compare December 4, 2023 15:35
@GregoryIvo
Copy link
Contributor

GregoryIvo commented Dec 6, 2023

Warning

TEST

@@ -160,6 +160,35 @@ mvn -f kura/distrib/pom.xml clean install -DbuildAllContainers
After this command runs, images can be found in your preferred container engine image list.

### Eclipse IDE

> [!WARNING]
> If you DON'T use Oomph Setup, to make Kura work with newer versions of Eclipse you need to make the following changes in your workspace configuration:
Copy link
Contributor

@mattdibi mattdibi Dec 6, 2023

Choose a reason for hiding this comment

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

Which following lines? The content of the XML is not following this statement

Copy link
Contributor

@mattdibi mattdibi left a comment

Choose a reason for hiding this comment

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

I agree on the content and the need for it, but it's too much stuff to put in the main README file. I would add a Warning (if we really need to) and a link to another page where you write all that content.

A better way to handle this would be to have a full guide on how to setup the environment without Oomph. I think we only document Oomph though, isn't it?

@salvatore-coppola
Copy link
Contributor Author

the infromation wil be provided in the official Kura documentation

@mattdibi mattdibi deleted the add-new-eclipse-ide-settings branch December 6, 2023 16:08
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