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

4.x : Updates links to examples that are in documentation to point to the helidon-examples repository. #9094

Merged
merged 4 commits into from
Aug 2, 2024

Conversation

barchetta
Copy link
Member

Description

Updates the links to examples that are in documentation to point to the helidon-examples repository.

Also places a small README in the (now empty) examples directory.

Documentation

Docs updated.

@barchetta barchetta self-assigned this Aug 2, 2024
@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Aug 2, 2024
Copy link
Member

@tjquinno tjquinno left a comment

Choose a reason for hiding this comment

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

Small suggestion for a future enhancement. Looks good.


:sourcedir: {rootdir}/../java/io/helidon/docs

ifeval::["{helidon-version-is-release}" != "true"]
:helidon-github-tree-url: https://github.com/oracle/helidon/tree/main
:helidon-github-examples-url: https://github.com/helidon-io/helidon-examples/tree/helidon-4.x/examples
Copy link
Member

Choose a reason for hiding this comment

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

Not super-important, but at some point the helidon-4.x part of this could be an attribute like helidon-version that is used a few lines below and declared right next to it so someone who revises this for 5.x would be more likely to update both correctly.


# Helidon Examples

Helidon 4 examples have moved to the [helidon-examples](https://github.com/helidon-io/helidon-examples/tree/helidon-4.x) repository.
Copy link
Member

Choose a reason for hiding this comment

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

Another candidate for using the hypothetical new attribute for the last part of the path.

@barchetta barchetta merged commit 30088db into helidon-io:main Aug 2, 2024
13 checks passed
@barchetta barchetta deleted the 4.x-fix-example-links branch November 12, 2024 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4.x Version 4.x docs examples 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