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

[Main] Clarify vague points in documentation #620

Merged
merged 3 commits into from
Jan 9, 2024
Merged

Conversation

Pante
Copy link
Contributor

@Pante Pante commented Jan 9, 2024

Many thanks for submitting your Pull Request ❤️!

Please make sure that your PR meets the following requirements:

  • You have read the contributors guide
  • Your code is properly formatted according to our code style
  • Pull Request title contains the target branch if not targeting main: [0.9.x] Subject
  • Pull Request contains link to the issue
  • Pull Request contains link to any dependent or related Pull Request
  • Pull Request contains description of the issue
  • Pull Request does not include fixes for issues other than the main ticket
How to backport a pull request to a different branch?

In order to automatically create a backporting pull request please add one or more labels having the following format backport-<branch-name>, where <branch-name> is the name of the branch where the pull request must be backported to (e.g., backport-quarkus2 to backport the original PR to the quarkus2 branch).

NOTE: backporting is an action aiming to move a change (usually a commit) from a branch (usually the main one) to another one, which is generally referring to a still maintained release branch. Keeping it simple: it is about to move a specific change or a set of them from one branch to another.

Once the original pull request is successfully merged, the automated action will create one backporting pull request per each label (with the previous format) that has been added.

If something goes wrong, the author will be notified and at this point a manual backporting is needed.

NOTE: this automated backporting is triggered whenever a pull request on main branch is labeled or closed, but both conditions must be satisfied to get the new PR created.

This pull request clarifies a few vague points in the current documentation.

Firstly, it expands on how to configure a base-package in the Getting Started section. This is currently only vaguely alluded to in the Config Key section.

Secondly, under the logging section, it adds a link to the Maven Configuration guide which elaborates on how to turn off logging without having to specify the option in the CLI each time.

Copy link
Contributor

@hbelmiro hbelmiro left a comment

Choose a reason for hiding this comment

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

Thank you for this contribution @Pante.

@hbelmiro hbelmiro merged commit 2966c0d into quarkiverse:main Jan 9, 2024
11 checks passed
@hbelmiro
Copy link
Contributor

hbelmiro commented Jan 9, 2024

@all-contributors add @Pante for docs.

Copy link
Contributor

@hbelmiro

I've put up a pull request to add @Pante! 🎉

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.

2 participants