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

Documentation is not updated #27076

Closed
wants to merge 55 commits into from
Closed

Documentation is not updated #27076

wants to merge 55 commits into from

Conversation

newur
Copy link
Contributor

@newur newur commented Aug 2, 2022

Hello,

there is a difference between the latest public docu and the content of the .adoc files on github.

For instance I checked

So I assume the docu in general was not updated?

Side note: I think the new feature introduced during #25289 misses any mention in the docu?! Maybe the new command property should be explained with an example on https://github.com/quarkusio/quarkus/blob/main/docs/src/main/asciidoc/databases-dev-services.adoc ? Right now it is rather hard to find in the Configuration Reference section...

/update
I messed up the branch selection during PR creation. Sorry about that.

yrodiere and others added 30 commits July 19, 2022 20:08
Signed-off-by: Michal Maléř <[email protected]>
(cherry picked from commit 14a528f)
Co-authored-by: Guillaume Smet <[email protected]>
(cherry picked from commit 89f38ad)
(cherry picked from commit 053a39f)
…first

Presumably the `preClientSendHandler` was added to support observability/telemetry but it has not been working.

The `preClientSendHandler` was previosuly ordered _after_ the request filters but the telemetry is reported using a filter (e.g. `OpenTelemetryClientFilter`). Given that setup the  client’s route template was not set on the context until after the telemeetry was reported.

This simply rearranges the `preClientSendHandler` to run first, before any other handlers, including filters.

(cherry picked from commit fc78635)
(cherry picked from commit 7fd3a7f)
(cherry picked from commit cdf39a4)
(cherry picked from commit 906ebcb)
Bumps [kotlinx-coroutines-bom](https://github.com/Kotlin/kotlinx.coroutines) from 1.6.3 to 1.6.4.
- [Release notes](https://github.com/Kotlin/kotlinx.coroutines/releases)
- [Changelog](https://github.com/Kotlin/kotlinx.coroutines/blob/master/CHANGES.md)
- [Commits](Kotlin/kotlinx.coroutines@1.6.3...1.6.4)

---
updated-dependencies:
- dependency-name: org.jetbrains.kotlinx:kotlinx-coroutines-bom
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
(cherry picked from commit 2a29f64)
Signed-off-by: Phillip Kruger <[email protected]>
(cherry picked from commit 48787de)
…he process id.

Without, it takes the process id from the build time.

(cherry picked from commit 5a34f3f)
Despite being part of the recorder, it is called statically at build
time. We need to be extremely careful about it.

Fixes #26773

(cherry picked from commit d125cd8)
…e from contributing guide.

Also: De-emphasise instructions for setting up DOCKER_HOST, make it clear Windows should work.
Co-Authored-By: Jason T. Greene <[email protected]>
Co-Authored-By: Guillaume Smet <[email protected]>
(cherry picked from commit 078c44f)
This will succeed even if the `.keep` file already exists.

Closes #26476

(cherry picked from commit 65270ab)
Bumps `apicurio-registry.version` from 2.2.4.Final to 2.2.5.Final.

Updates `apicurio-registry-client` from 2.2.4.Final to 2.2.5.Final
- [Release notes](https://github.com/apicurio/apicurio-registry/releases)
- [Commits](Apicurio/apicurio-registry@2.2.4.Final...2.2.5.Final)

Updates `apicurio-registry-serdes-avro-serde` from 2.2.4.Final to 2.2.5.Final

---
updated-dependencies:
- dependency-name: io.apicurio:apicurio-registry-client
  dependency-type: direct:production
  update-type: version-update:semver-patch
- dependency-name: io.apicurio:apicurio-registry-serdes-avro-serde
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
(cherry picked from commit bffd538)
@quarkus-bot
Copy link

quarkus-bot bot commented Aug 2, 2022

@geoand
Copy link
Contributor

geoand commented Aug 2, 2022

The documentation on the website should match the source found in the 2.11.1.Final tag. Can you check please?

Copy link
Member

@yrodiere yrodiere left a comment

Choose a reason for hiding this comment

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

It is true that the documentation on the website is not up-to-date. @gsmet is it a known release problem?

EDIT: See for example https://github.com/quarkusio/quarkus/blob/2.11/docs/src/main/asciidoc/rabbitmq-dev-services.adoc#access-the-management-ui, that section is missing at https://quarkus.io/guides/rabbitmq-dev-services, despite being introduced in 2.11.0.CR1: 516230f


Regardless, this PR is not necessary as all the relevant changes have already been backported:

https://quarkus.io/guides/rabbitmq-dev-services and it misses the part about the Management UI as desribed here https://github.com/quarkusio/quarkus/blob/main/docs/src/main/asciidoc/rabbitmq-dev-services.adoc#access-the-management-ui

It's already in 2.11: https://github.com/quarkusio/quarkus/blob/2.11/docs/src/main/asciidoc/rabbitmq-dev-services.adoc#access-the-management-ui

https://quarkus.io/guides/databases-dev-services misses the new part about how to connect to the database as described here https://github.com/quarkusio/quarkus/blob/main/docs/src/main/asciidoc/databases-dev-services.adoc#connect-to-database-run-as-a-dev-service

It's already in 2.11: https://github.com/quarkusio/quarkus/blob/2.11/docs/src/main/asciidoc/databases-dev-services.adoc#connect-to-database-run-as-a-dev-service

Side note: I think the new feature introduced during #25289 misses any mention in the docu?! Maybe the new command property should be explained with an example on https://github.com/quarkusio/quarkus/blob/main/docs/src/main/asciidoc/databases-dev-services.adoc ? Right now it is rather hard to find in the Configuration Reference section...

As you pointed out, the configuration property is documented in the configuration reference. The argument "it's hard to find" is hardly valid: if we accepted it, it would only lead to adding a section about every single configuration property, regardless of how exotic/rarely used it is, and then what's the point of the configuration reference? We can only reasonably add a section for the most important properties; I can't personally say whether this one is important enough, but others will probably chime in.

In any case, that's unrelated to the problem at hand: please open a separate issue/pull request so that you can have that discussion.

Though obviously it's not in 2.11, but that's the same problem as the other pieces of documentation.

@gsmet
Copy link
Member

gsmet commented Aug 2, 2022

The documentation publication script got broken here: 086c7bb#diff-d00c67fd13e9b811f6decf2a12b17ab690e3ff209c5712331d631d739c1a6657R12 .

Thanks for raising the issue, I will republish everything. But this PR is doing nothing good. Closing it.

@gsmet gsmet closed this Aug 2, 2022
@quarkus-bot quarkus-bot bot added the triage/invalid This doesn't seem right label Aug 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/config area/core area/dependencies Pull requests that update a dependency file area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/documentation area/elasticsearch area/gradle Gradle area/graphql area/grpc gRPC area/hibernate-orm Hibernate ORM area/hibernate-search Hibernate Search area/hibernate-validator Hibernate Validator area/liquibase area/logging area/maven area/oidc area/panache area/persistence OBSOLETE, DO NOT USE area/platform Issues related to definition and interaction with Quarkus Platform area/reactive-messaging area/redis area/smallrye area/spring Issues relating to the Spring integration area/testing area/tracing area/websockets triage/invalid This doesn't seem right
Projects
None yet
Development

Successfully merging this pull request may close these issues.