-
Notifications
You must be signed in to change notification settings - Fork 13
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
Updated JNLP runner docs for new release #210
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
--- | ||
import Shell from "@leaningtech/astro-theme/layouts/Shell.astro"; | ||
import { products } from "@leaningtech/astro-theme/products"; | ||
import { Image } from "astro:assets"; | ||
import { type Product } from "../../../../packages/astro-theme/lib/nav.ts"; | ||
|
||
interface Props { | ||
productId: Product; | ||
formUrl: string; | ||
} | ||
|
||
const { productId, formUrl } = Astro.props; | ||
const product = products[productId]; | ||
--- | ||
|
||
<Shell title=`${product.name} Payment`> | ||
<main | ||
class="flex flex-col justify-center items-center flex-grow w-full max-w-screen-2xl mx-auto px-6 py-10 overflow-hidden" | ||
> | ||
<div class="flex justify-between items-center w-4/5 max-w-6xl p-4"> | ||
<div class="w-1/2 p-4 box-border"> | ||
<div class="mb-6"> | ||
<a href={product.href} target="_blank"> | ||
<Image src={product.logotype} alt={product.name} class="w-4/5" /> | ||
</a> | ||
</div> | ||
<h2 class="text-3xl font-bold mb-4">Purchase Your License</h2> | ||
<p class="text-base"> | ||
Complete the purchase to get your license key. Once you have completed | ||
the purchase, you will receive an email with the license key. | ||
</p> | ||
<br /> | ||
<p class="text-base"> | ||
Activate your license key | ||
<a | ||
href="chrome-extension://aklbimhnkloeefmeobindhkbpncelbmg/license.html" | ||
target="_blank" | ||
class="text-white hover:text-gray-300 font-bold">here.</a | ||
> | ||
</p> | ||
</div> | ||
<div class="w-1/2 p-4 box-border"> | ||
<!-- <iframe class="w-full h-[600px] border-none" src={formUrl}> </iframe> --> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Comment can be removed. |
||
<script | ||
id="fsc-api" | ||
src="https://sbl.onfastspring.com/sbl/1.0.1/fastspring-builder.min.js" | ||
type="text/javascript" | ||
data-storefront={formUrl.toString()}></script> | ||
<div id="fsc-embedded-checkout-container"></div> | ||
<script type="text/javascript"> | ||
fastspring.builder.add("cheerpj-jnlp-runner"); | ||
</script> | ||
</div> | ||
</div> | ||
</main> | ||
</Shell> |
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think it is important to explain at the beginning of this guide that there are two ways to do the license activation and that they are mutually exclusive. Then direct the user to the section that they need to follow. Otherwise they may think it is required to do both methods. |
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should also add a section on the popup and that you can drag and drop a jnlp file there. |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,14 +3,24 @@ title: Using the extension for the first time | |
description: Tutorial for first-time users | ||
--- | ||
|
||
This tutorial will guide you on the basic functionalities of the JNLP Runner extension. We assume you have installed the extension on [Chrome](/cheerpj-jnlp-runner/getting-started/install-chrome) or [Edge](/cheerpj-jnlp-runner/getting-started/install-edge) and you have already [activated your license](/cheerpj-jnlp-runner/getting-started/licensing). | ||
This tutorial will guide you on the basic functionalities of the JNLP Runner extension. We assume you have installed the extension on [Chrome](/cheerpj-jnlp-runner/getting-started/install-chrome) or [Edge](/cheerpj-jnlp-runner/getting-started/install-edge). | ||
|
||
### Before using the extension | ||
|
||
The first time you launch a JNLP file to run a Java application, the JNLP Runner will automatically detect it and it will start running. The first screen you will see is the license agreement. Please read this carefully and if you agree with the terms and conditions, click on _**Accept license**_. | ||
|
||
<div class="mx-24"></div> | ||
Comment on lines
+6
to
+12
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should also link to the actual license here -> https://cheerpj.com/cheerpj-jnlp-runner-end-user-licence-agreement/ |
||
|
||
## The home screen | ||
|
||
When the JNLP Runner extension detects that a JNLP file has been triggered it will show the screen below in a new tab. This screen displays a few options alongside the license's owner and the JNLP filename. | ||
|
||
<div class="mx-24"></div> | ||
|
||
### Manage license button | ||
|
||
Click on this button to activate your license key or token. For more information, check the [Activate your license](/cheerpj-jnlp-runner/getting-started/activate-license) tutorial. | ||
|
||
Comment on lines
+20
to
+23
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would change the wording of button to link, since it currently does not really look like a button. |
||
### Start application button | ||
|
||
If this button is selected, the JNLP Runner will start executing your Java application, you will see a loading screen and after just a few seconds you will see your application running in the browser. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. At the end of the licensing part we should also link to the licensing agreement -> https://cheerpj.com/cheerpj-jnlp-runner-end-user-licence-agreement/ |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
title: Licensing | ||
--- | ||
|
||
The CheerpJ JNLP Runner extension is free to use for non-business purposes on public-network JNLP applications. | ||
|
||
- **Free** usage applies to: | ||
- Individuals using the extension for personal or non-commercial projects. | ||
- Publicly accessible JNLP applications that are not associated with a business or organisation. | ||
- Business, corporate, and public-sector organisations: | ||
- Free for [technical evaluations](#technical-evaluations) or testing purposes. | ||
- Requires a [commercial license][licensing] for any other use. | ||
- Academic and non-profit organisations: [please enquire for eligibility][contact] | ||
|
||
## Examples | ||
|
||
- Example 1: You are an individual using the extension to run a public-facing educational JNLP application. **Free license**. | ||
- Example 2: You are a student using the extension to run JNLP applications for a personal project. **Free license**. | ||
- Example 3: You are an individual within a company, using the extension to access an internal or customer-facing JNLP application. [Requires a commercial license][licensing]. | ||
- Example 4: You are working within a public-sector organisation, and using the extension to access an internal applet. [Requires a commercial license][licensing]. | ||
- Example 5: You are a developer in a company evaluating the extension for future use of CheerpJ. **Free license (evaluation only).** | ||
- Example 6: You are a business that wants to self-host the CheerpJ JNLP Runner instead of relying on the hosted service. [Requires a self-hosting license][contact]. | ||
|
||
## Technical evaluations | ||
|
||
A technical evaluation refers to any scenario where the JNLP application is not actively being used in production, such as: | ||
|
||
- Testing JNLP applications on non-public systems. | ||
- Evaluating compatibility with the extension for a potential project. | ||
|
||
This does not include: | ||
|
||
- Active use of the extension in internal systems by employees or users. | ||
|
||
## Self-hosting | ||
|
||
If you wish to self-host CheerpJ JNLP Runner, you will need a dedicated license. [Contact us][contact] for more information. | ||
|
||
### System Integrators (SIs), Resellers, Distributors, and OEMs | ||
|
||
Please [contact us directly][contact] to discuss OEM or Reseller licences. | ||
|
||
--- | ||
|
||
If you are not sure whether you require a license, [contact us][contact]. | ||
|
||
[licensing]: /cheerpj-jnlp-runner/getting-started/licensing | ||
[contact]: https://cheerpj.com/contact/ |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
import ExtensionPayment from "../components/ExtensionPayment.astro"; | ||
--- | ||
|
||
<ExtensionPayment | ||
productId="cheerpj-jnlp-runner" | ||
formUrl="leaningtech.onfastspring.com/embedded-storefront" | ||
/> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Careful here, the url points to a local installation of the JNLPRunner and not the version in the webstore. In general I don't think it's a smart idea to link to an extension page like this. We could say something like, enter the key in the "manage license" section of the installed JNLPRunner extension and also link to the docs that explain how to activate a license.