eclipse / Microprofile

// // Copyright (c) 2017-2018 Contributors to the Eclipse Foundation // // See the NOTICE file(s) distributed with this work for additional // information regarding copyright ownership. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // // SPDX-License-Identifier: Apache-2.0

image:https://badges.gitter.im/eclipse/microprofile.svg[link="https://gitter.im/eclipse/microprofile"]

= MicroProfile Documentation The link:https://projects.eclipse.org/projects/technology.microprofile[MicroProfile project] has several sources of information and collaboration. Since there is a large volume of activity, there is a need for important decisions to be recorded in one place for future reference. This is the aim of this repository.

== Current Resources The MicroProfile project is community-focused at its heart and aims to engage and encourage lively discussion through as many channels as possible.

=== Umbrella Specification This repository is used to house the top-level link:https://github.com/eclipse/microprofile/blob/master/spec/src/main/asciidoc/architecture.asciidoc[umbrella MicroProfile specification].

=== Maven bill-of-materials POM This repository also houses the link:https://github.com/eclipse/microprofile/blob/master/pom.xml[Maven bill-of-materials POM]. This POM declares transitive dependencies on all the Java EE and MicroProfile artifacts covered by the umbrella specification and can be used in one of two ways:

. To declare a dependency on the entire MicroProfile stack: + [source,xml]

org.eclipse.microprofile microprofile 4.0 pom provided ---- . To import the transitive dependencies for selective use: + [source,xml] ---- org.eclipse.microprofile microprofile 4.0 import pom org.eclipse.microprofile.health microprofile-health-api provided

<dependency>
    <groupId>org.eclipse.microprofile.metrics</groupId>
    <artifactId>microprofile-metrics-api</artifactId>
    <scope>provided</scope>
</dependency>

<dependency>
    <groupId>jakarta.ws.rs</groupId>
    <artifactId>jakarta.ws.rs-api</artifactId>
    <scope>provided</scope>
</dependency>

----

=== Code, code, code Several Eclipse github repos exist for the development of MicroProfile features...

link:https://github.com/eclipse/microprofile[MicroProfile] -- Top-level repo used for the umbrella MicroProfile specifications and other MicroProfile-related information (this repo) + link:https://github.com/eclipse/microprofile-config[MicroProfile Config] -- MicroProfile application configuration + link:https://github.com/eclipse/microprofile-health[MicroProfile Health Check] -- MicroProfile simple health check + link:https://github.com/eclipse/microprofile-metrics[MicroProfile Metrics] -- MicroProfile metrics + link:https://github.com/eclipse/microprofile-fault-tolerance[MicroProfile Fault Tolerance] -- MicroProfile fault tolerance + link:https://github.com/eclipse/microprofile-rest-client[MicroProfile Rest Client] -- MicroProfile type-safe REST client + link:https://github.com/eclipse/microprofile-open-api[MicroProfile Open API] -- MicroProfile OpenAPI and annotations + link:https://github.com/eclipse/microprofile-jwt-auth[MicroProfile JWT Authentication] -- MicroProfile JWT authentication propagation + link:https://github.com/eclipse/microprofile-opentracing[MicroProfile OpenTracing] -- MicroProfile OpenTracing integration + link:https://github.com/eclipse/microprofile-graphql[MicroProfile GraphQL] -- Microprofile GraphQL Specification + link:https://github.com/eclipse/microprofile-conference[MicroProfile Conference App] -- "Architectural Application" to demonstrate MicroProfile on a variety of vendors

A complete list of MicroProfile-related repositories within the Eclipse github organization can be found link:https://github.com/eclipse?utf8=%E2%9C%93&q=microprofile[via this link].

Some of the repositories are hosted under the link:https://github.com/microprofile[MicroProfile github organization], including the following repos:

link:https://github.com/microprofile/microprofile-blog[MicroProfile.io blogs] -- Easy mechanism for updating the entries on the link:http://microprofile.io/blog[MicroProfile blog site] + link:https://github.com/microprofile/microprofile-site[MicroProfile.io site] -- source code of the application that powers the link:http://microprofile.io[microprofile.io] site +

=== MicroProfile and MicroProfile.io The MicroProfile community has two portals to information. The main site is the link:https://projects.eclipse.org/projects/technology.microprofile[MicroProfile project]. In addition to this portal to our community at Eclipse, we will continue to maintain our external site at link:http://microprofile.io[MicroProfile.io]. Both sites will be maintained to promote the development and use of MicroProfile in the industry.

=== Wiki

The https://wiki.eclipse.org/MicroProfile[MicroProfile wiki] contains up-to-date information about the project development, tools and other documentation.

=== Google Group The link:https://groups.google.com/forum/#!forum/microprofile[MicroProfile Google Group] is the preferred place for discussions to take place.

=== Mailing Lists Besides the Google Group threads (main source of communication), there is also an link:https://dev.eclipse.org/mailman/listinfo/microprofile-dev[microprofile-dev mailing list] which should be used for conversation specific to the Eclipse way of doing things. By using this mailing list, the Eclipse team can more quickly recognize and respond to our requests. +

Since the link:https://projects.eclipse.org/projects/technology.microprofile[MicroProfile project] is still in incubation, another useful mailing list is the link:https://dev.eclipse.org/mailman/listinfo/incubation[incubation mailing list] for asking general Eclipse process questions.

== Notable Contributors There is a very large number of people and vendors already involved in the link:https://projects.eclipse.org/projects/technology.microprofile[MicroProfile project]. The complete list of contributors can be found at our link:https://microprofile.io/contributors[microprofile.io site]. Specific to our Eclipse efforts, another page is automatically maintained at link:https://projects.eclipse.org/projects/technology.microprofile/who[MicroProfile] for the Eclipse committers and project leads.