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.

Sign up for GitHub

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

Jump to bottom

Improve the documentation #540

Merged
merged 4 commits into from
Nov 24, 2023
Merged

Improve the documentation #540

merged 4 commits into from
Nov 24, 2023

Conversation

albertattard
Copy link
Contributor

Improve the documentation

  1. Replace the deprecated goals with the recommended alternatives
  2. Updates the dependencies to the latest versions
  3. Includes further examples to make it clear where the changes needs to be made
  4. Fix some minor issues

@oracle-contributor-agreement Oracle Contributor Agreement
Copy link

Thank you for your pull request and welcome to our community! To contribute, please sign the Oracle Contributor Agreement (OCA).
The following contributors of this PR have not signed the OCA:

To sign the OCA, please create an Oracle account and sign the OCA in Oracle's Contributor Agreement Application.

When signing the OCA, please provide your GitHub username. After signing the OCA and getting an OCA approval from Oracle, this PR will be automatically updated.

If you are an Oracle employee, please make sure that you are a member of the main Oracle GitHub organization, and your membership in this organization is public.

@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Required At least one contributor does not have an approved Oracle Contributor Agreement. label Nov 23, 2023
olyagpl
olyagpl requested changes Nov 23, 2023
View reviewed changes
docs/src/docs/asciidoc/maven-plugin-quickstart.adoc
@@ -102,7 +132,7 @@ public class Fortune {
}
----
. Copy and paste the following file,
https://raw.githubusercontent.com/graalvm/graalvm-demos/master/fortune-demo/fortune/src/main/resources/fortunes.json[fortunes.json] under _resources/_.
Copy link
Member

@olyagpl olyagpl Nov 23, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

By convention, paths to files, directories and file names should be italicized. These are not code blocks or commands. It's better to revert to _ name _ everywhere, for consistency with our documentation.

@olyagpl olyagpl requested a review from melix November 23, 2023 12:16
melix
melix approved these changes Nov 23, 2023
View reviewed changes
Copy link
Collaborator

@melix melix left a comment

Choose a reason for hiding this comment

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

LGTM! Did you check that the new instructions with updated plugin versions actually work?

@albertattard
Copy link
Contributor Author

@melix, yes I tested the code as shown in the updated version and it works. I've updated the native tests command and included the -Dagent as this was missing. In such case, the tests will only work if the agent is enabled in the pom.xml.

@olyagpl olyagpl mentioned this pull request Nov 24, 2023
Merged
@oracle-contributor-agreement oracle-contributor-agreement bot added OCA Verified All contributors have signed the Oracle Contributor Agreement. and removed OCA Required At least one contributor does not have an approved Oracle Contributor Agreement. labels Nov 24, 2023
@melix melix merged commit eaa3e46 into graalvm:master Nov 24, 2023
1 check passed
melix pushed a commit to melix/native-build-tools that referenced this pull request Sep 10, 2024
@albertattard @melix
Improve the documentation (graalvm#540)
0362728 
* Bump dependencies versions

* Fix formatting error

* Fix documentation mistakes

* Align with convention (italics for paths)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@olyagpl olyagpl olyagpl approved these changes

@melix melix melix approved these changes

Assignees
No one assigned
Labels
OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@albertattard @melix @olyagpl