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

Fixes #3866 - Import Getting Started page from piranha-website project #3867

Merged
merged 1 commit into from
Aug 28, 2024
Merged

Fixes #3866 - Import Getting Started page from piranha-website project #3867

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 20 additions & 7 deletions docs/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,35 @@

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>cloud.piranha</groupId>
<groupId>cloud.piranha.docs</groupId>
<version>24.9.0-SNAPSHOT</version>

<artifactId>doc</artifactId>
<artifactId>project</artifactId>
<packaging>pom</packaging>

<name>Piranha</name>

<url>https://github.com/piranhacloud/piranha</url>
<organization>
<name>Piranha Cloud</name>
<url>https://piranha.cloud</url>
</organization>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>3.12.1</version>
<version>3.20.0</version>
</plugin>
</plugins>
</build>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>3.6.2</version>
<reportSets>
<reportSet/>
</reportSets>
</plugin>
</plugins>
</reporting>
</project>
49 changes: 49 additions & 0 deletions docs/src/site/markdown/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Getting Started

## Quickstart using Piranha Web Profile

Download a version of Piranha Web Profile from [Maven Central](https://repo1.maven.org/maven2/cloud/piranha/dist/piranha-dist-webprofile/).

Run your web application using:

```shell
java -jar piranha-webprofile-X.Y.Z.jar --war-file your-webapplication.war
```

## What other distributions can I use?

The short answer is that it depends on your needs.

If you want to embed Piranha into your application you can pick Piranha Embedded
to start embedding Piranha directly into your own application. If you are
looking for a lean REST runtime then you should pick Piranha Core Profile.

If you are looking for a traditional Servlet container, similar to Tomcat and
Jetty, then Piranha Server or Piranha Servlet are your best bet. For hosting
multiple web applications on the same distribution use Piranha Server. For
hosting just a single web application pick Piranha Servlet.

If you are wondering what Jakarta EE or Micro Profile specification each of the
distribution supports see our [Jakarta EE / Micro Profile matrix](https://piranha.cloud/getting-started/matrix.html)

## Distribution specific documentation

* [Piranha Core Profile](https://piranha.cloud/core-profile/index.html)
* [Piranha Embedded](https://piranha.cloud/embedded/index.html)
* [Piranha Servlet](https://piranha.cloud/servlet/index.html)
* [Piranha Server](https://piranha.cloud/server/index.html)
* [Piranha Web Profile](https://piranha.cloud/web-profile/index.html)

## Maven Plugin documentation

If you are using Maven and want to use our convenient Maven plugin for a quick iterative development cycle, see the [Piranha Maven plugin documentation](../maven/piranha-maven-plugin/index.html).

## Extending Piranha

You can extend the capability of a Piranha distribution by means of extensions.

## How do you run Piranha in a container

Piranha images are available from the [GitHub container registry](https://github.com/orgs/piranhacloud/packages), on a best effort basis. If you desire commercially supported images we suggest you contact our commercial partner [OmniFish](https://omnifish.ee/contact-us/).

[Up](../)
29 changes: 29 additions & 0 deletions docs/src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>

<project name="Piranha">
<body>
<menu name="Overview">
<item name="Getting Started" href="getting-started.html"/>
</menu>
</body>
<custom>
<fluidoSkin>
<copyrightClass>pull-right</copyrightClass>
<gitHub>
<projectId>piranhacloud/piranha</projectId>
<ribbonOrientation>right-bottom</ribbonOrientation>
<ribbonColor>black</ribbonColor>
</gitHub>
<twitter>
<user>piranha_cloud</user>
</twitter>
</fluidoSkin>
</custom>
<publishDate position="right"/>
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-fluido-skin</artifactId>
<version>2.0.0-M10</version>
</skin>
<version position="left"/>
</project>
1 change: 1 addition & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
<module>cli</module>
<module>core</module>
<module>dist</module>
<module>docs</module>
<module>embedded</module>
<module>extension</module>
<module>feature</module>
Expand Down
Loading