Skip to content

Commit 88d3c4f

Browse files
authored
Merge pull request #206 from AdobeXD/console-update-v2
Console update v2
2 parents 03a5ea7 + 632eba7 commit 88d3c4f

10 files changed

+61
-79
lines changed

distribution/how-to-submit-to-plugin-manager.md

Lines changed: 49 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -2,83 +2,90 @@
22

33
The simplest way for Adobe XD users to discover and install plugins is through XD's in-app Plugin Manager.
44

5-
The XD Plugin Manager is accessed through the _Plugins_ menu in the app: go to _Plugins > Discover Plugins..._ to open it:
5+
The XD Plugin Manager is accessed through:
6+
7+
- the _Plugins_ menu in the app's menu bar: go to _Plugins > Discover Plugins..._
8+
- the plus button (+) in the plugins panel on the left-hand side of the app
69

710
![XD Plugin Manager](/images/plugin-manager.png)
811

9-
In order to make your plugin available in the XD Plugin Manager, you'll need to go through our submission and review process.
12+
In order to make your plugin available in the XD Plugin Manager, you'll need to go through our [submission checklist and review process](/distribution/submission-checklist.md).
1013

1114
## Prerequisites
1215

16+
- [Pre-submission checklist](/distribution/submission-checklist.md)
1317
- [A packaged plugin](/distribution/packaging.md)
14-
- Edge is not currently supported for the plugin submission workflow. Please use another browser to submit your XD plugin.
15-
16-
## Pre-submission checklist
1718

18-
Before you submit, be sure to go through this checklist of common reasons for rejection. Doing so now might save you an extra step or two on your way to publishing.
19+
**Note**: Edge is not currently supported for the plugin submission workflow. Please use another browser to submit your XD plugin.
1920

20-
**Checklist**
21+
## Submit your plugin
2122

22-
- Does the plugin ID in your `manifest.json` file match the plugin ID assigned to you on the [I/O Console](https://console.adobe.io/plugins)? [Learn more here](/reference/structure/manifest.md#top-level-metadata).
23-
- Did you use the "Check Plugin Name Availability" tool on your plugin details page of the [I/O Console](https://console.adobe.io/plugins) to confirm the plugin name you've listed in your `manifest.json` file is available to use?
24-
- Is the plugin version number _format_ correct in your `manifest.json` file? [Learn more here](/reference/structure/manifest.md#top-level-metadata).
25-
- Have you picked the appropriate keywords for your plugin in your `manifest.json` file? [Learn more here](/reference/structure/manifest.md#top-level-metadata).
26-
- Do you have labels in all supported languages noted in your `manifest.json` file? [Learn more here](/reference/structure/manifest.md#top-level-metadata).
27-
- Do your website and support URLs follow the standard URL format in your `manifest.json` file? [Learn more here](/reference/structure/manifest.md#top-level-metadata).
28-
- Do you have icons for all 4 required sizes listed in your `manifest.json` file? [Learn more here](/reference/structure/manifest.md#top-level-metadata).
29-
- Is the plugin `host.minVersion` number and (optionally) `host.maxVersion` number _format_ correct in your `manifest.json` file? [Learn more here](/reference/structure/manifest.md#top-level-metadata).
30-
- If this is not your first time submitting this plugin, have you _increased_ the version number in your `manifest.json` file? [Learn more here](/reference/structure/manifest.md#top-level-metadata). You _must_ increment your version number (typically, the patch version; e.g, `1.0.0``1.0.1`) _each time you submit your plugin for review_.
31-
- When packaging your plugin, did you make sure to compress the files (and _not_ the parent folder)? [Learn more here](/distribution/packaging.md#1-compress-your-files-as-a-zip-file).
32-
- Is the .XDX file less than 50MB in size?
33-
- Did you verify the .XDX install on your machine when you double-click it?
34-
- After installing, did you verify that the plugin runs when you select its command(s) from XD's _Plugins_ menu?
23+
You can submit your plugin for review through the I/O Developer Console, the same place you got your [unique plugin ID for your manifest](reference/structure/manifest.md).
3524

36-
Answering "no" to any of these questions will get your submission rejected, requiring you to address the issue in your plugin and submit again.
25+
On the I/O Console, you can provide your packaged plugin. The I/O Console will automatically validate your package and its [manifest file](/reference/structure/manifest.md). Then, you will be asked to provide more information about your plugin on the Console.
3726

38-
## Submit your plugin
39-
40-
You can submit your plugin for review through the I/O Console, where you can provide your packaged plugin. The I/O Console will automatically validate your package and its `manifest.json` file. Once validation is passed, you'll have an opportunity to review the listing data we extract from your manifest. If everything looks good, you can then submit your plugin and our CC Integrations Review team will review your plugin.
27+
If everything looks good, you can then submit your plugin and our CC Integrations Review team will review it.
4128

4229
We'll walk you through the workflow below.
4330

44-
### 1. Read the submission guidelines
31+
### 1. Read the submission checklist
4532

46-
All plugins are reviewed by our CC Integrations Review team. Please make sure to read our [Creative Cloud Developer Submission Guidelines](https://partners.adobe.com/exchangeprogram/creativecloud/build/dev-submission-guidelines.html) before submitting to ensure a smooth path to publishing your plugin. Plugins violating the guidelines may be rejected.
33+
All plugins are reviewed by our CC Integrations Review team. Make sure to thoroughly read [the submission checklist](/distribution/submission-checklist.md) before submitting to ensure a smooth path to publishing your plugin. Plugins violating these checklist items will be rejected, requiring you to address the issues and resubmit.
4734

4835
### 2. Begin your submission
4936

50-
To begin the submission for your plugin, visit the [I/O Console](https://console.adobe.io/plugins) and select your plugin from your list of plugin projects.
37+
To begin the submission for your plugin, visit the [Developer Console](https://console.adobe.io/plugins) and select your plugin from your list of plugin projects.
38+
39+
This will take you to your plugin's "Project Overview" page, which shows your plugin ID, a download link for your starter project, and more.
40+
41+
In the left-hand navbar, you'll see a "Distribute" page.
5142

52-
This will take you to your plugin's details page, which shows your plugin ID, a download link for your starter project, and a blue button that says "Submit for Review".
43+
![Distribute your plugin](/images/submit.png)
5344

54-
Before clicking on the "Submit for Review" button, make sure to click on the "Check Plugin Name Availability" button to check the availability of your plugin name, which you have indicated in [your manifest.json file](/reference/structure/manifest.md#top-level-metadata). Note that this plugin name is the one that will be displayed in the XD Plugin Manager. Do not confuse this name with your I/O Console _project name_, which is only visible to you and is managed directly on the Console.
45+
You can begin creating your listing from this page.
5546

56-
When ready, click "Submit For Review".
47+
### 3. Submit plugin for review - Listing Information
48+
The "Submit plugin for review" page has two tabs: "Listing information" and "Plugin file". As the first step, you are asked to provide some facts about you, the publisher, and your plugin. Make sure that the plugin name in your [manifest file](/reference/structure/manifest.md) and the plugin name you provide here match.
5749

58-
### 3. Upload your XD plugin
50+
![Publisher and plugin info](/images/plugin-and-publisher-info.png)
5951

60-
On this page, attach your .XDX file and click on "Next". Note that your .XDX file size must be under 50MB to upload it for submission.
52+
Next, indicate whether your plugin requires installations of another application or use of a third party service. Also, include release notes for this version. This information will be displayed in the plugin manager to help users onboard your plugin.
6153

62-
The I/O Console will then process the upload and extract information from your `manifest.json` file.
54+
![Publisher and plugin info](/images/connect-and-version-details.png)
6355

64-
### 4. Review your listing information
56+
Next, you are asked to provide three plugin icons (48 x 48 px, 96 x 96 px, and 192 x 192 px). These icons will be used for display in the Plugin Manager listing.
6557

66-
On this page, review the validation results on all required fields for [your manifest.json file](/reference/structure/manifest.md#top-level-metadata).
58+
> **Info**
59+
> Note that, separately, you are required to include additional icons in your plugin package and include them in [the manifest](/reference/structure/manifest.md). These icons can be different from the ones that you use in Console and they will be used to show icons in the plugins panel within the application.
6760
68-
Note that any changes must be made in your original files. When all necessary changes are made, re-package your plugin and upload the plugin again.
61+
You must also provide at least one screenshot of your plugin, which will be included in your Plugin Manager listing when published. Please take a look at [the screenshot requirements](https://adobexdplatform.com/plugin-docs/distribution/how-to-submit-to-plugin-manager.html).
6962

70-
### 5. Submit your plugin
63+
![Publisher and plugin info](/images/plugin-icons-and-screenshots.png)
7164

72-
If your plugin passed all validation checks by the I/O Console, write notes (if any) to the CC Integrations Review team and click on "Submit for Review".
65+
Finally, if you have a message for our reviewers, write it here.
7366

74-
Congratulations! We can't wait for you to join our growing community of published plugins.
67+
> **Info**
68+
> Note that if your plugin requires a paid account, license number, or other such credentials to use all features of the plugin, you must provide test credentials in the "Note to Adobe reviewers" field so Adobe can review the plugin. If we need credentials from you and they have not been shared in this field, your plugin submission will be rejected.
69+
70+
![Note to reviewer](/images/note-to-reviewers.png)
71+
72+
### 4. Submit plugin for review - Plugin File
73+
74+
Once you have provided all required information about your plugin, including icons and screenshots, you will be asked to attach your plugin package. Make sure to properly [package your plugin](/distribution/packaging.md) into an `.xdx` file.
75+
76+
When your plugin passes all validation checks by the I/O Console, the "Submit" button will be activated for you to click.
77+
78+
Congratulations on your submission! We can't wait to have a look at what you've created!
7579

7680
## CC Integrations Review
7781

78-
After you submit, the CC Integrations Review team will review your plugin. Depending on current submission volume, it can take up to 10 business days before you hear a response. Thank you for being patient with us.
82+
After you submit, the CC Integrations Review team will review your plugin. Depending on current submission volume, it can take up to 10 business days before you hear a response. Thank you for being patient with us.
83+
84+
> **Info**
85+
> Many of the items our reviewers check for when reviewing a plugin are noted in the [submission checklist](/distribution/submission-checklist.md).
7986
8087
Once your submission has been reviewed, we’ll reach out letting you know if it has been approved or rejected, and provide any next steps.
8188

82-
## Next steps
89+
## Marketing your plugin
8390

84-
No matter how you plan to distribute, be sure to see our [plugin marketing tutorial](./marketing) to learn about the ins and outs of marketing an Adobe XD plugin.
91+
No matter how you plan to distribute, be sure to see our [plugin marketing guide](./marketing) to learn about the ins-and-outs of marketing an Adobe XD plugin.

distribution/options.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ If you distribute a .XDX file, installation is as simple as one double-click.
2727
>
2828
> - Outlook fails silently; the message disappears into the void, without being delivered to the recipient.
2929
> - Gmail notifies the sender that the message will be blocked.
30+
>
31+
> If you also have the same listing in the Plugin Manager, make sure the `name` field in the manifest matches the same field in the Plugin Manager listing. If there is a discrepancy, the name in the Plugin Manager will be used.
3032
3133

3234
## Next steps

distribution/submission-checklist.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Submission Checklist
2+
3+
Coming soon..
106 KB
Loading

images/note-to-reviewers.png

49 KB
Loading

images/plugin-and-publisher-info.png

223 KB
Loading

images/plugin-icon-submission.png

108 KB
Loading
167 KB
Loading

images/submit.png

50.8 KB
Loading

0 commit comments

Comments
 (0)