Skip to content

Commit

Permalink
Merge pull request #20 from AdobeDocs/chuck-v6
Browse files Browse the repository at this point in the history
Chuck v6
  • Loading branch information
kerrishotts authored Oct 16, 2020
2 parents 76e2981 + a40ce78 commit 731663b
Show file tree
Hide file tree
Showing 23 changed files with 65 additions and 67 deletions.
4 changes: 0 additions & 4 deletions gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,6 @@ module.exports = {
{
title: 'Debugging your Plugins',
path: '/guides/debugging/'
},
{
title: 'Distributing your Plugins',
path: '/guides/distribution/'
}
]
},
Expand Down
6 changes: 3 additions & 3 deletions src/pages/code_samples/batchplay_samples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ These examples demonstrate how to perform some common actions using batchPlay.

### batchPlay sample 1

TBD
Description coming soon.

### batchPlay sample 2

TBD
Description coming soon.

### batchPlay sample 3

TBD
Description coming soon.
2 changes: 1 addition & 1 deletion src/pages/code_samples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ contributors:

Here are some examples of plugins you can create with UXP in Photoshop. On GitHub, they exist as fully formed projects that you can load immediately to get a flavor for how things work; then you can modify the projects so they become more your own code.

The samples are all available on GitHub [here](#) where you can clone or fork them. If you're not familiar with GitHub and just want to download the examples, click on the link above and just click the green `Code` button, then click "Download ZIP."
The samples are all available on GitHub [here](https://github.com/AdobeDocs/uxp-photoshop-plugin-samples) where you can clone or fork them. If you're not familiar with GitHub and just want to download the examples, click on the link above and just click the green `Code` button, then click "Download ZIP."

There are three basic kinds of plugins:

Expand Down
2 changes: 1 addition & 1 deletion src/pages/code_samples/javascript_samples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Plain (also called "Vanilla") JavaScript is JavaScript without any libraries or frameworks. Because of that, it's also the easiest environment in which to show examples.

The examples are described briefly below. You can find the source code for these in GitHub [here](#LINKNEEDED).
The examples are described briefly below. You can find the source code for these in GitHub [here](https://github.com/AdobeDocs/uxp-photoshop-plugin-samples).

## Direct Action ("headless")

Expand Down
4 changes: 2 additions & 2 deletions src/pages/code_samples/react_samples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ If you've never used React, one of the best places to start is with the (React T

## React sample 1

TBD
Description coming soon.

## React sample 2

TBD
Description coming soon.
10 changes: 5 additions & 5 deletions src/pages/code_samples/sample-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,24 +46,24 @@ If you've never used React, one of the best places to start is with the (React T

### React sample 1

TBD
Description coming soon.

### React sample 2

TBD
Description coming soon.

### batchPlay Samples

As of this writing, not all of the Photoshop DOM is exposed to UXP. If an interface for your favorite Photoshop functionality isn't present in UXP, you may be able to use batchPlay to access what you need. These examples demonstrate how to do things using batchPlay.

### batchPlay sample 1

TBD
Description coming soon.

### batchPlay sample 2

TBD
Description coming soon.

### batchPlay sample 3

TBD
Description coming soon.
2 changes: 1 addition & 1 deletion src/pages/code_samples/web_service_example.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Web Service Example

TBD
Description coming soon.
8 changes: 7 additions & 1 deletion src/pages/distribution/distribution-options/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# Distribution Options

TBD
Once you have a packaged plugin, you're ready to distribute it. Here are your options:

* Keep the plugin to yourself. This is OK, but you'll never become a YouTube star that way.
* Give the plugin to your family, friends, and workmates. You can email the `.ccx` file or, more likely, put it on a cloud folder somewhere for them to download. All they need to do is double click the `.ccx` file to install using the Creative Cloud application. It's that easy! Be aware that distributing this way will require them to click through the "do you trust this?" warning dialog boxes that appear after they double-click.
* You can submit it to the Creative Cloud Marketplace, where it can be discovered by millions of potential users. Both paid and free plugins are supported in the Marketplace; you choose which kind your plugin should be.

If you've decided to submit your plugin to the Marketplace, read about the submissions process and review guidelines [here](../submission-checklist/).
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/distribution/images/marketplace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/distribution/images/package-failed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/distribution/images/package-success.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/distribution/images/verify-failed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/distribution/images/what-now.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 6 additions & 1 deletion src/pages/distribution/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Sharing Your Plugin

TBD
Unless you've written a plugin solely for yourself, you're probably going to want to share it with others. This section explains how to take your plugin into the wider world, and let other users know about it.

* [Packaging Your Plugin](./packaging-your-plugin)
* [Options for Distribution](./distribution-options)
* [Submission and Review](./submission-checklist)
* [Marketing Your Plugin](./marketing)
37 changes: 36 additions & 1 deletion src/pages/distribution/packaging-your-plugin/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,38 @@
# Packaging Your Plugin

TBD
Taking your plugin code and packaging it has never been easier.

UXP plugins for Photoshop are distributed in the form of a `.ccx` file. Under the hood, this is a zip file. Unless you have some special requirements, you should not be creating this zip file yourself.

<InlineAlert variant="info" slots="text"/>

**IMPORTANT**:
Before you package your plugin for distribution outside your own computer, make sure you've obtained a valid ID from the [Adobe Developer Console](https://console.adobe.io). Without an id (which goes in the `id` field of your plugin's `manifest.json` file), you won't be able to distribute your plugin in the Creative Cloud Marketplace.

Using the [UXP Developer Toolkit](../guides/uxp-developer-tool), choose `Package` from the Actions menu (the ellipsis on the right side of the Toolkit window, on the same line as your plugin name):

![Package Menu](../images/udt-package-menu.png)

This shows a "Select target directory" dialog. Choose a directory where your built plugin `.ccx` file should reside.

After the `.ccx` file has been created, you should see this message at the bottom of the Toolkit window:

![Package Success](../images/package-success.png)

If instead, you see this:

![Package Failed](../images/package-failed.png)

Click on `Details` to view a window that shows why the packaging failed.

Once your `.ccx` file has been built, you should test it locally before doing anything else. To install a .ccx file into any Creative Cloud application, double click it. This will open the Creative Cloud application, and you'll get a warning that your plugin hasn't been verified by Adobe:

![Verify Failed](../images/verify-failed.png)

Since you wrote the plugin, it's probably safe to install. Click `Install locally` and you'll see another warning:

![Install Warning](../images/install-warning.png)

Since, in this case, *you* are the third-party developer, it's safe to click OK. Obviously, if someone else sends you a `.ccx` file and you get this dialog, you should make sure you trust the person who sent it.

Now that you have your plugin installed, test it again to make sure the packaged version performs correctly. Then move on to [Options for Distribution](../distribution-options) to get your plugin out into the world.
3 changes: 0 additions & 3 deletions src/pages/distribution/publishing/index.md

This file was deleted.

3 changes: 0 additions & 3 deletions src/pages/guides/distribution/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion src/pages/guides/uxp_for_you/uxp_for_newbies/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ The same applies to learning HTML and CSS (Cascading Style Sheets), although bot

An apocryphal quote from Picasso is "good artists borrow, great artists steal" -- which means that, when you get to the point where you're ready to try coding, looking at sample code and putting it in your own projects is usually just fine. Then go through the code at your leisure and make sure you understand what it's doing. And to start you off with some sample code, [look here](../code_samples/).

Finally, _ask questions_. There are many helpful people on the [Adobe forums](#LINKNEEDED), and chances are you'll find answers there.
Finally, _ask questions_. There are many helpful people on the [Adobe forums](https://forums.creativeclouddeveloper.com), and chances are you'll find answers there.
4 changes: 1 addition & 3 deletions src/pages/guides/uxp_guide/uxp-misc/network-io/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,4 @@

Many plugin scenarios require use of the network to fetch or push data, to browse remote resources, and to synchronize content, among other reasons. XD implements a robust network stack.

UXP supports `fetch`, `XHR`, and `WebSockets`.

More content TBD.
UXP supports `fetch`, `XHR` (XML HTTP Request), and `WebSockets`. Of these, the easiest to use is `fetch`.
34 changes: 0 additions & 34 deletions src/pages/guides/uxp_guide/uxp-technology-overview.md

This file was deleted.

4 changes: 1 addition & 3 deletions src/pages/guides/uxp_guide/uxp-toolchain/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ In order to build a UXP-based plugin, you'll need the following pieces of softwa

- __UXP Developer Tool for Windows 10__ - [Download the installer zip file](#LINKNEEDED), unzip it, and run `Set-up.exe` in the unzipped folder.

- __UXP CLI (both Mac and Windows)__ - [Download the repository](https://github.com/adobe-uxp/devtools-cli) from GitHub; the `README.md` file contains complete installation instructions.

- __Node.js__ - Go to the [Node.js download page](https://nodejs.org/en/download/), download the installer for your platform, and run it. This will also install npm.

- __yarn__: In order to install yarn you'll need to have npm installed first (see above). After that, use this command:
Expand All @@ -50,7 +48,7 @@ In order to build React-based plugins, you'll need to know a bit about [NodeJS](
## Useful Utilities and Resources
### Kitchen Sink Example
This is sample code, not actually a tool. But the [uxp-ui-kitchen-sink-plugin](LINKNEEDED#) is very useful in showing the kinds of controls you can use in UXP. It covers both Spectrum and native controls.
This is sample code, not actually a tool. But the [uxp-ui-kitchen-sink-plugin](https://github.com/AdobeDocs/uxp-photoshop-plugin-samples) is very useful in showing the kinds of controls you can use in UXP. It covers both Spectrum and native controls.
### HTML Playground
The [HTML PLayground](https://github.com/adobe-uxp/ps-uxp-html-playground) plugin is designed to make it simple to test out simple HTML layouts in Photoshop using UXP's layout engine. To use this, install the plugin using the UXP Developer Tool.
Expand Down

0 comments on commit 731663b

Please sign in to comment.