Skip to content

[GR-60094] Revisit top-level README.md to explain the new repository structure. #334

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

Merged
merged 6 commits into from
Dec 19, 2024

Conversation

olyagpl
Copy link
Member

@olyagpl olyagpl commented Dec 18, 2024

No description provided.

@olyagpl olyagpl requested a review from sachin-pikle December 18, 2024 10:07
@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Dec 18, 2024
@olyagpl olyagpl force-pushed the revisit-repository-readme branch from 1cfbfbd to ff81236 Compare December 18, 2024 10:13
@olyagpl
Copy link
Member Author

olyagpl commented Dec 18, 2024

Having just consulted with @sachin-pikle, and we think it's still good to have a full list of examples on the home page, similar to Spring Boot experience https://github.com/spring-projects/spring-data-examples. Then a visitor can search by a word and find what he looks for. I'll push another commit, hold on with reviewing this PR.

@olyagpl olyagpl force-pushed the revisit-repository-readme branch 2 times, most recently from 29438a8 to 63f3452 Compare December 19, 2024 12:06
@olyagpl olyagpl force-pushed the revisit-repository-readme branch from 63f3452 to 3a84e77 Compare December 19, 2024 12:10
@olyagpl
Copy link
Member Author

olyagpl commented Dec 19, 2024

I have finished rewriting this repository README and listed each actively tested demo in it. Each demo is linked to its source code and has a short description of its purpose.
A reminder of the structure levels:

  • native-image
    • build
    • benchmarks
    • clouds
    • configure
    • containerize
    • debug (there is no Java example app that we can source here yet)
    • microservices (currently only micronaut demos, I'll add Spring demo later)
    • monitor
    • optimize
  • compiler (currently only one demo)
  • archive (polyglot demos and from blogs)

Second, this PR also remove GraalJS, GraalPy, and GraalWasm directories and I added a paragraph in README, at the beginning, where to find Graal Languages Demos.

Lastly, this PR moves /graalvm-demos/clouds/ under /graalvm-demos/native-image/demos, that's why there are so many changed files in this PR (they were only moved).

sachin-pikle
sachin-pikle previously approved these changes Dec 19, 2024
@olyagpl olyagpl merged commit d628f5c into master Dec 19, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants