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

Fix some issues in getting-started-dev-services #36474

Merged
merged 1 commit into from
Oct 14, 2023
Merged

Fix some issues in getting-started-dev-services #36474

merged 1 commit into from
Oct 14, 2023

Conversation

leo-bogastry
Copy link
Contributor

Fix some issues in getting-started-dev-services

  • Add missing port 8080
  • Fix small error in text format
  • Fix links to docs that result in a 404

About the links that result in a 404, for example for hibernate-orm-panache.adoc the result was https://quarkus.io/guides/.hibernate-orm-panache that results in a 404

gsmet
gsmet requested changes Oct 13, 2023
View reviewed changes
Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

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

Thanks a lot. I suggested a few adjustments (the problems were preexisting though so I can fix them myself if you prefer).

docs/src/main/asciidoc/getting-started-dev-services.adoc Outdated
@@ -142,7 +142,7 @@ public class Greeting extends PanacheEntity {
}
----

The entity makes use of xref:{doc-guides}hibernate-orm-panache.adoc[Panache], a layer on top of Hibernate ORM.
The entity makes use of xref:{doc-guides}/hibernate-orm-panache.adoc[Panache], a layer on top of Hibernate ORM.
Copy link
Member

@gsmet gsmet Oct 13, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

This was incorrect, {doc-guides} shouldn't have been used. Can you fix it here? And maybe check if there are other occurrences in our doc? We shouldn't use it to point to our .adoc files.

Suggested change
The entity makes use of xref:{doc-guides}/hibernate-orm-panache.adoc[Panache], a layer on top of Hibernate ORM.
The entity makes use of xref:hibernate-orm-panache.adoc[Panache], a layer on top of Hibernate ORM.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Happy to fix those yes. I replaced docfile with doc-guides because these seemed to work, so there are a few more

docs/src/main/asciidoc/getting-started-dev-services.adoc Outdated
@@ -215,11 +215,11 @@ you will start seeing failures in the Quarkus logs at this point.
Reading and writing to the database seems to be working well, but that's a bit unexpected.
Where did a PostgreSQL database come from? You didn't set anything up.

The database is being managed using xref:{docfile}/dev-services.adoc[Dev Services].
The database is being managed using xref:{doc-guides}/dev-services.adoc[Dev Services].
Copy link
Member

Choose a reason for hiding this comment

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

Same here, drop {doc-guides}/

docs/src/main/asciidoc/getting-started-dev-services.adoc Outdated
@@ -310,7 +310,7 @@ but have it *only* used in production, so you could still use dev services the r

Add a `%prod.`
prefix to the database configuration. This means the configuration
only applies to the xref:{docfile}/config-reference#profiles[prod profile]
only applies to the xref:{doc-guides}/config-reference.adoc#profiles[prod profile]
Copy link
Member

Choose a reason for hiding this comment

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

Same here.

docs/src/main/asciidoc/getting-started-dev-services.adoc Outdated
Comment on lines 344 to 346
* xref:{doc-guides}dev-services.adoc[Dev Services]
* xref:{doc-guides}/dev-services.adoc[Dev Services]

* xref:{doc-guides}hibernate-orm-panache.adoc[Hibernate ORM with Panache]
* xref:{doc-guides}/hibernate-orm-panache.adoc[Hibernate ORM with Panache]
Copy link
Member

Choose a reason for hiding this comment

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

And same here.

@leo-bogastry
Fix some issues in getting-started-dev-services:
b865f85 
- Add missing port 8080
- Fix small error in text format
- Fix links to docs that result in a 404
@leo-bogastry leo-bogastry force-pushed the fix-doc-getting-started-dev-services-links branch from 0050e56 to b865f85 Compare October 13, 2023 15:54
@leo-bogastry
Copy link
Contributor Author

@gsmet I applied the fixes you requested. Please review again. There are several other docs that use the xref:{doc-guides}. Let me know if you would like those fixed in a separate PR or this one

gsmet added a commit to gsmet/quarkus that referenced this pull request Oct 13, 2023
@gsmet
Get rid of {doc-guides} attribute in documentation
b086173 
It has been mistakenly used in the newest guide that was added as shown in
quarkusio#36474 where we had:
- one invalid link because of a missing /
- one invalid link because an incorrect attribute was used

We see it's risky and it has no more value since
we introduced the downstream archive as we automatically transform the
links there to point to either a local one or one that is upstream.

Note: I haven't handled the getting-started-devservices.adoc here on
purpose as Leonor is working on it. Will handle it if needed once
Leonor's PR is in.
gsmet added a commit to gsmet/quarkus that referenced this pull request Oct 13, 2023
@gsmet
Get rid of {doc-guides} attribute in documentation
a6d4ede 
It has been mistakenly used in the newest guide that was added as shown in
quarkusio#36474 where we had:
- one invalid link because of a missing /
- one invalid link because an incorrect attribute was used

We see it's risky and it has no more value since
we introduced the downstream archive as we automatically transform the
links there to point to either a local one or one that is upstream.

IIRC, Michelle already removed some and I don't think it's recommended
nowadays.

Note: I haven't handled the getting-started-devservices.adoc here on
purpose as Leonor is working on it. Will handle it if needed once
Leonor's PR is in.
@gsmet gsmet mentioned this pull request Oct 13, 2023
Merged
@gsmet
Copy link
Member

gsmet commented Oct 13, 2023

@LeonorLunatech I took care of the other occurrences there: #36477 .

gsmet
gsmet approved these changes Oct 13, 2023
View reviewed changes
Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

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

Perfect, thanks, let's get this in once CI is green!

@gsmet gsmet added the triage/waiting-for-ci Ready to merge when CI successfully finishes label Oct 13, 2023
@github-actions
Copy link

github-actions bot commented Oct 13, 2023 •
edited
Loading

🙈 The PR is closed and the preview is expired.

@gsmet gsmet merged commit d23917b into quarkusio:main Oct 14, 2023
5 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.6 - main milestone Oct 14, 2023
@quarkus-bot quarkus-bot bot removed the triage/waiting-for-ci Ready to merge when CI successfully finishes label Oct 14, 2023
@gsmet
Copy link
Member

gsmet commented Oct 14, 2023

Thanks!

@gsmet gsmet modified the milestones: 3.6 - main, 3.5.0 Oct 17, 2023
benkard pushed a commit to benkard/mulkcms2 that referenced this pull request Nov 12, 2023
Update all non-major dependencies (mulk/mulkcms2!42)
f6a7236 
This MR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [flow-bin](https://github.com/flowtype/flow-bin) ([changelog](https://github.com/facebook/flow/blob/master/Changelog.md)) | devDependencies | minor | [`^0.219.0` -> `^0.220.0`](https://renovatebot.com/diffs/npm/flow-bin/0.219.0/0.220.0) |
| [org.jsoup:jsoup](https://jsoup.org/) ([source](https://github.com/jhy/jsoup)) | compile | patch | `1.16.1` -> `1.16.2` |
| [io.quarkus:quarkus-maven-plugin](https://github.com/quarkusio/quarkus) | build | minor | `3.4.3` -> `3.5.0` |
| [io.quarkus:quarkus-universe-bom](https://github.com/quarkusio/quarkus-platform) | import | minor | `3.4.3` -> `3.5.0` |

---

### Release Notes

<details>
<summary>flowtype/flow-bin</summary>

### [`v0.220.0`](flow/flow-bin@f7f3f3f...030bfc6)

[Compare Source](flow/flow-bin@f7f3f3f...030bfc6)

### [`v0.219.5`](flow/flow-bin@f16a6c7...f7f3f3f)

[Compare Source](flow/flow-bin@f16a6c7...f7f3f3f)

### [`v0.219.4`](flow/flow-bin@9f67075...f16a6c7)

[Compare Source](flow/flow-bin@9f67075...f16a6c7)

### [`v0.219.3`](flow/flow-bin@80dcea5...9f67075)

[Compare Source](flow/flow-bin@80dcea5...9f67075)

### [`v0.219.2`](flow/flow-bin@c184c5d...80dcea5)

[Compare Source](flow/flow-bin@c184c5d...80dcea5)

</details>

<details>
<summary>quarkusio/quarkus</summary>

### [`v3.5.0`](https://github.com/quarkusio/quarkus/releases/tag/3.5.0)

[Compare Source](quarkusio/quarkus@3.4.3...3.5.0)

##### Complete changelog

-   [#&#8203;36527](quarkusio/quarkus#36527) - Start MongoDB 4.4 instead of 4.0
-   [#&#8203;36523](quarkusio/quarkus#36523) - Minor OIDC Auth0 updates
-   [#&#8203;36518](quarkusio/quarkus#36518) - Allow for setting logging scope programmatically
-   [#&#8203;36517](quarkusio/quarkus#36517) - Use Mandrel 23.1 in windows CI
-   [#&#8203;36501](quarkusio/quarkus#36501) - Let custom OIDC token propagation filters customize the exchange status
-   [#&#8203;36495](quarkusio/quarkus#36495) - Support external OTel exporters in CDI
-   [#&#8203;36490](quarkusio/quarkus#36490) - Take ReaderInterceptor into account when reading SSE events
-   [#&#8203;36487](quarkusio/quarkus#36487) - Upgrade to Liquibase 4.24.0
-   [#&#8203;36485](quarkusio/quarkus#36485) - Fix typo in gradle-tooling.adoc
-   [#&#8203;36474](quarkusio/quarkus#36474) - Fix some issues in getting-started-dev-services
-   [#&#8203;36465](quarkusio/quarkus#36465) - Be more consistent in guides when creating projects/adding extensions
-   [#&#8203;36464](quarkusio/quarkus#36464) - HTTP reference guide - HTTP/2 section update, drop JDK 8 note
-   [#&#8203;36459](quarkusio/quarkus#36459) - Let custom OIDC token propagation filters provide client name
-   [#&#8203;36457](quarkusio/quarkus#36457) - Update builder images to jdk-21
-   [#&#8203;36453](quarkusio/quarkus#36453) - Upgrade Oracle JDBC driver to 23.3.0.23.09
-   [#&#8203;36452](quarkusio/quarkus#36452) - Fix doc extension-add.adoc
-   [#&#8203;36451](quarkusio/quarkus#36451) - Adjust extension name for consistency with rest of Quarkus
-   [#&#8203;36446](quarkusio/quarkus#36446) - Regression: Liquibase fails to migrate on Quarkus start, crashing the application
-   [#&#8203;36445](quarkusio/quarkus#36445) - Updates to Infinispan 14.0.19.Final
-   [#&#8203;36442](quarkusio/quarkus#36442) - Use default content type when X-SSE header not set
-   [#&#8203;36436](quarkusio/quarkus#36436) - Upgrade to Hibernate ORM 6.2.13.Final
-   [#&#8203;36432](quarkusio/quarkus#36432) - Hibernate Reactive Panache: improve error message
-   [#&#8203;36420](quarkusio/quarkus#36420) - Allow parallel execution of blocking health checks
-   [#&#8203;36419](quarkusio/quarkus#36419) - Blocking Health Checks should be executed in parallel, not sequentially/ordered
-   [#&#8203;36417](quarkusio/quarkus#36417) - Reduce timeout of the doc build to 60 minutes
-   [#&#8203;36413](quarkusio/quarkus#36413) - Simplify virtual threads guide by pushing users to 21
-   [#&#8203;36412](quarkusio/quarkus#36412) - Drop Optaplanner from the documentation
-   [#&#8203;36411](quarkusio/quarkus#36411) - Drop panache topic from Hibernate Reactive guide
-   [#&#8203;36410](quarkusio/quarkus#36410) - Add compatibility topic to Spring guides
-   [#&#8203;36407](quarkusio/quarkus#36407) - Register RuntimeOverrideConfigSource in STATIC_INIT
-   [#&#8203;36406](quarkusio/quarkus#36406) - AssembleDownstreamDocumentation - print guide name
-   [#&#8203;36400](quarkusio/quarkus#36400) - Add topics and extensions metadata to guides
-   [#&#8203;36367](quarkusio/quarkus#36367) - Bump org.wiremock:wiremock-standalone from 3.1.0 to 3.2.0
-   [#&#8203;36365](quarkusio/quarkus#36365) - Bump de.flapdoodle.embed:de.flapdoodle.embed.mongo from 4.7.0 to 4.9.2
-   [#&#8203;36360](quarkusio/quarkus#36360) - Drop the old Dev UI guide
-   [#&#8203;36337](quarkusio/quarkus#36337) - Upgrade maven to version 3.9.5
-   [#&#8203;36236](quarkusio/quarkus#36236) - No Panache session in REST endpoints defined by an interface
-   [#&#8203;35931](quarkusio/quarkus#35931) - Add OIDC Auth0 extended tutorial
-   [#&#8203;33548](quarkusio/quarkus#33548) - Pick random debug port when the configured one is taken
-   [#&#8203;33363](quarkusio/quarkus#33363) - allow quarkus dev to pick random debug port

</details>

<details>
<summary>quarkusio/quarkus-platform</summary>

### [`v3.5.0`](quarkusio/quarkus-platform@3.4.3...3.5.0)

[Compare Source](quarkusio/quarkus-platform@3.4.3...3.5.0)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever MR is behind base branch, or you tick the rebase/retry checkbox.

👻 **Immortal**: This MR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4yNC4wIiwidXBkYXRlZEluVmVyIjoiMzQuMjQuMCJ9-->
holly-cummins pushed a commit to holly-cummins/quarkus that referenced this pull request Feb 8, 2024
@gsmet @holly-cummins
Get rid of {doc-guides} attribute in documentation
c205857 
It has been mistakenly used in the newest guide that was added as shown in
quarkusio#36474 where we had:
- one invalid link because of a missing /
- one invalid link because an incorrect attribute was used

We see it's risky and it has no more value since
we introduced the downstream archive as we automatically transform the
links there to point to either a local one or one that is upstream.

IIRC, Michelle already removed some and I don't think it's recommended
nowadays.

Note: I haven't handled the getting-started-devservices.adoc here on
purpose as Leonor is working on it. Will handle it if needed once
Leonor's PR is in.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gsmet gsmet gsmet approved these changes

Assignees
No one assigned
Labels
area/documentation
Projects
Quarkus Documentation
Status: Done
Milestone
3.5.0
Development

Successfully merging this pull request may close these issues.
2 participants
@leo-bogastry @gsmet