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

Add links to guides for Micronaut Core #10269

Merged
merged 1 commit into from
Dec 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/main/docs/guide/aop/scheduling.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Like Spring and Grails, the Micronaut framework features a api:scheduling.annotation.Scheduled[] annotation for scheduling background tasks.

TIP: See the guide for https://guides.micronaut.io/latest/micronaut-scheduled.html[Schedule Periodic Tasks inside your Micronaut Applications] to learn more.

== Using the @Scheduled Annotation

The api:scheduling.annotation.Scheduled[] annotation can be added to any method of a bean, and you should set one of the `fixedRate`, `fixedDelay`, or `cron` members.
Expand Down
2 changes: 2 additions & 0 deletions src/main/docs/guide/config/configurationProperties.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -240,3 +240,5 @@ Now a map of properties can be supplied to the `my.engine.sensors` configuration
snippet::io.micronaut.docs.config.mapFormat.VehicleSpec[tags="start",indent=0,title="Use Map Configuration"]

The above example prints: `"Engine Starting V8 [sensors=2]"`

TIP: See the guide for https://guides.micronaut.io/latest/micronaut-configuration.html[@Configuration and @ConfigurationBuilder] to learn more.
2 changes: 2 additions & 0 deletions src/main/docs/guide/httpClient/lowLevelHttpClient.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ The api:http.client.HttpClient[] interface forms the basis for the low-level API
The majority of the methods in the api:http.client.HttpClient[] interface return Reactive Streams rs:Publisher[] instances, which is not always the most useful interface to work against.

Micronaut's Reactor HTTP Client dependency ships with a sub-interface named link:{micronautreactorapi}/io/micronaut/reactor/http/client/ReactorHttpClient.html[ReactorHttpClient]. It provides a variation of the api:http.client.HttpClient[] interface that returns https://projectreactor.io[Project Reactor] reactor:Flux[] types.

TIP: See the guide for https://guides.micronaut.io/latest/micronaut-http-client.html[Micronaut HTTP Client] to learn more.
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@ The ann:http.annotation.Error[] annotation supports defining either an exception
Local error handlers only respond to exceptions thrown as a result of the route being matched to another method in the same controller. Global error handlers can be invoked as a result of any thrown exception. A local error handler is always searched for first when resolving which handler to execute.

TIP: When defining an error handler for an exception, you can specify the exception instance as an argument to the method and omit the exception property of the annotation.

TIP: See the guide for https://guides.micronaut.io/latest/micronaut-error-handling.html[Error Handling] to learn more.

2 changes: 2 additions & 0 deletions src/main/docs/guide/httpServer/serverConfiguration/cors.adoc
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
The Micronaut framework supports CORS (link:https://www.w3.org/TR/cors/[Cross Origin Resource Sharing]) out of the box. By default, CORS requests are rejected.

TIP: See the guide for https://guides.micronaut.io/latest/micronaut-cors.html[Configure CORS in a Micronaut Application] to learn more.
4 changes: 3 additions & 1 deletion src/main/docs/guide/i18n/localizedMessageSource.adoc
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
api:context.LocalizedMessageSource[] is a `@RequestScope` bean which you can inject in your Controllers and which uses <<localeResolution, Micronaut Locale Resolution>> to resolve the localized message for the current HTTP request.
api:context.LocalizedMessageSource[] is a `@RequestScope` bean which you can inject in your Controllers and which uses <<localeResolution, Micronaut Locale Resolution>> to resolve the localized message for the current HTTP request.

TIP: See the guide for https://guides.micronaut.io/latest/localized-message-source.html[Localize your Application] to learn more.
2 changes: 2 additions & 0 deletions src/main/docs/guide/ioc/beans.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,5 @@ The Micronaut framework supports the following types of dependency injection:
* Method parameter injection

NOTE: Classes or particular fields, methods can be excluded by adding an annotation ann:core.annotation.Vetoed[]

TIP: See the guide for https://guides.micronaut.io/latest/micronaut-dependency-injection-types.html[Micronaut Dependency Injection Types] to learn more.
2 changes: 2 additions & 0 deletions src/main/docs/guide/ioc/qualifiers.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,8 @@ If multiple possible candidates are present and no `@Primary` is defined a api:c

In addition to `@Primary`, there is also a api:context.annotation.Secondary[] annotation which causes the opposite effect and allows de-prioritizing a bean.

TIP: See the guide for https://guides.micronaut.io/latest/micronaut-patterns-composite.html[Micronaut Patterns - Composite] to learn more.

== Injecting Any Bean

If you are not particular about which bean gets injected then you can use the ann:context.annotation.Any[] qualifier which will inject the first available bean, for example:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,3 +142,5 @@ The JDBC health indicator determines the health of your application based on the
=== Discovery Client

If your application uses service discovery, a health indicator is included to monitor the health of the discovery client. The data returned can include a list of the services available.

TIP: See the guide for https://guides.micronaut.io/latest/micronaut-health-endpoint.html[Exposing a Health Endpoint for your Micronaut Application] to learn more.
2 changes: 2 additions & 0 deletions src/main/docs/guide/quickStart/creatingServer.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,5 @@ If you start the application and send a `GET` request to the `/hello` URI, the t
$ curl http://localhost:8080/hello
Hello World
----

TIP: See the guide for https://guides.micronaut.io/latest/creating-your-first-micronaut-app.html[Creating your First Micronaut Application] to learn more.
8 changes: 8 additions & 0 deletions src/main/docs/guide/quickStart/deployingApp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,11 @@ Then invoke the `deploy` lifecycle phase specifying the packaging type as either
----
$ ./mvnw deploy -Dpackaging=docker
----

=== Deployment Guides

See the following guides to learn more about deploying Micronaut Applications:

- https://guides.micronaut.io/latest/executable-jar.html[Create an Executable Jar of a Micronaut Application]
- https://guides.micronaut.io/latest/micronaut-creating-first-graal-app.html[Creating Your First Micronaut Graal Application]
- https://guides.micronaut.io/latest/micronaut-docker-image.html[Building a Docker Image of your Micronaut Application]
3 changes: 3 additions & 0 deletions src/main/docs/guide/quickStart/ideSetup/ideaSetup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@ For IntelliJ IDEA, if you plan to use the IntelliJ compiler, enable annotation p
image::intellij-annotation-processors.png[Intellij Settings,1024,768]

Once you have enabled annotation processing in IntelliJ you can run the application and tests directly within the IDE without the need of an external build tool such as Gradle or Maven.

TIP: See the guide for https://guides.micronaut.io/latest/micronaut-intellij-idea-ide-setup.html[Using IntelliJ IDEA to Develop Micronaut Applications] to learn more.

Loading