Skip to content

Commit

Permalink
links, links, and more links
Browse files Browse the repository at this point in the history
  • Loading branch information
kerrishotts committed Oct 14, 2018
1 parent 3ea54e1 commit 3b343d9
Show file tree
Hide file tree
Showing 40 changed files with 174 additions and 890 deletions.
2 changes: 1 addition & 1 deletion ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This is an issue regarding:

- [ ] The guides contained within this repo.
- [ ] The tutorials contained within this repo.
- [ ] The samples contained within this repo.


Expand Down
2 changes: 1 addition & 1 deletion PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

This is a pull request for:

- [ ] A guide contained within this repo.
- [ ] A tutorial contained within this repo.
- [ ] A sample contained within this repo.
- [ ] Something new that I have already discussed with Adobe in a GitHub issue. Issue link:

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

XD plugins extend the capabilities of [Adobe XD](https://www.adobe.com/products/xd.html) by adding new features to the app, automating workflows, connecting the app to external services, and more.

On this page, we'll give you a quick overview of **what you can create** and **what skills you need to bring**.
On this page, we'll give you a quick overview of **what you can create** and **what skills you need to bring**.

From there, you can **choose your own adventure**: build a "Hello, World" plugin in our [Quick Start guide](/guides/quick-start-guide), follow our [tutorials](/guides/index.md), try code-complete [sample plugins](https://github.com/AdobeXD/plugin-samples), or browse the [API references](/reference/how-to-read.md).
From there, you can **choose your own adventure**: build a "Hello, World" plugin in our [Quick Start tutorial](/tutorials/quick-start), follow our [tutorials](/tutorials/index.md), try code-complete [sample plugins](https://github.com/AdobeXD/plugin-samples), or browse the [API references](/reference/how-to-read.md).

Oh, and be sure to [join the developer community](/community.md) while you're here! We want you to say hi (we'll say hi back).

Expand All @@ -24,17 +24,17 @@ XD plugins appear to the user in one of two ways, as a _Plugins_ menu item that:
1. Runs with **no UI** (like a script), or
2. Opens a custom **modal UI** where the user can interact with the plugin

You can learn more about the API surfaces available to you in [our tutorials](/guides/index.md), as well as in our [API References](/reference/how-to-read.md).
You can learn more about the API surfaces available to you in [our tutorials](/tutorials/index.md), as well as in our [API References](/reference/how-to-read.md).


## What skills do you need?

Below are the prerequisite skills you'll need to build a plugin. It's a short list! And even if you're new to coding, we think you'll be able to build your skills as you go.

##### Required
**JavaScript**: XD plugins are written in JavaScript. The XD plugin APIs support ES6+ JavaScript features, and ES5 is perfectly fine too.
**JavaScript**: XD plugins are written in JavaScript. The XD plugin APIs support ES6+ JavaScript features, and ES5 is perfectly fine too.

If you've never worked with JavaScript before, we recommend taking a moment to get familiar with the language first. But come back quickly; you don't need to be a JavaScript rock star to get started building XD plugins. The [Quick Start tutorial](/guides/quick-start-guide/README.md) and [API feature tutorials](/guides) you'll find in the documentation will help get you on your way.
If you've never worked with JavaScript before, we recommend taking a moment to get familiar with the language first. But come back quickly; you don't need to be a JavaScript rock star to get started building XD plugins. The [Quick Start tutorial](/tutorials/quick-start/README.md) and [API feature tutorials](/tutorials) you'll find in the documentation will help get you on your way.

##### Recommended
**HTML/CSS**: If you plan to offer a UI for your plugin, some familiarity with HTML and CSS is recommended. XD plugin APIs support a _subset_ of HTML and CSS for creating plugin UI.
Expand All @@ -49,7 +49,7 @@ There are lots of ways to journey through the documentation on your way to build

Here are some highlights you won't want to miss:

1. **Get Started**: To begin, try our [Quick Start tutorial](/guides/quick-start-guide), then follow along with [the API feature tutorials](./guides/index.md).
1. **Get Started**: To begin, try our [Quick Start tutorial](/tutorials/quick-start), then follow along with [the API feature tutorials](./tutorials/index.md).
1. **Go deep**: Read up on [the structure of a plugin](./reference/structure/index.md), expand your reach with [advanced concepts](/reference/index.md), and then dig into the [API reference](/reference/how-to-read.md).
1. **See code**: If you prefer to learn from working code, we have a [samples repo on GitHub](https://github.com/AdobeXD/Plugin-Samples) for you to take a look at.
1. **Join the community**: We want to hear from you, know who you are, keep you up to date with the latest info, and grow together. See our [Community page](/community.md) to learn about how to connect.
32 changes: 16 additions & 16 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,31 @@

* [Overview](./README.md)

* [Quick start](./guides/quick-start-guide/index.md)
* [Debugging plugins](./guides/debugging-guide/readme.md)
* [Quick start](./tutorials/quick-start/index.md)
* [Debugging plugins](./tutorials/debugging/readme.md)
* [Plugin structure](./reference/structure/index.md)
* [Plugin location](./reference/structure/location.md)
* [Folder structure](./reference/structure/folder-structure.md)
* [manifest.json](./reference/structure/manifest.md)
* [main.js](./reference/structure/handlers.md)

## Tutorials
* [About the tutorials](./guides/index.md)
* [Working with content](./guides/content-index.md)
* [How to draw lines](./guides/how-to-draw-lines-guide/index.md)
* [How to create paths](./guides/how-to-create-paths-guide/index.md)
* [How to style text](./guides/how-to-style-text-guide/index.md)
* [Working with a SceneNodeList](./guides/how-to-work-with-scenenodelist-guide/index.md)
* [About the tutorials](./tutorials/index.md)
* [Working with content](./tutorials/content-index.md)
* [How to draw lines](./tutorials/how-to-draw-lines/index.md)
* [How to create paths](./tutorials/how-to-create-paths/index.md)
* [How to style text](./tutorials/how-to-style-text/index.md)
* [Working with a SceneNodeList](./tutorials/how-to-work-with-scenenodelist/index.md)

* [Working with I/O](./guides/io-index.md)
* [How to export a rendition](./guides/how-to-export-a-rendition-guide/index.md)
* [How to read a file](./guides/how-to-read-a-file-guide/index.md)
* [How to make network requests](./guides/how-to-make-network-requests-guide/index.md)
* [How to integrate with OAuth](./guides/how-to-integrate-with-OAuth-guide/index.md)
* [Working with I/O](./tutorials/io-index.md)
* [How to export a rendition](./tutorials/how-to-export-a-rendition/index.md)
* [How to read a file](./tutorials/how-to-read-a-file/index.md)
* [How to make network requests](./tutorials/how-to-make-network-requests/index.md)
* [How to integrate with OAuth](./tutorials/how-to-integrate-with-OAuth/index.md)

* [Building user interfaces](./guides/ui-index.md)
* [How to show an alert](./guides/how-to-show-an-alert-guide/index.md)
* [Asking user for confirmation](./guides/how-to-ask-user-for-confirmation-guide/index.md)
* [Building user interfaces](./tutorials/ui-index.md)
* [How to show an alert](./tutorials/how-to-show-an-alert/index.md)
* [Asking user for confirmation](./tutorials/how-to-ask-user-for-confirmation/index.md)

## Advanced Concepts
* [About advanced concepts](./reference/index.md)
Expand Down
2 changes: 1 addition & 1 deletion book.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title": "Adobe XD Plugin Reference",
"description": "Documentation, guides, how-tos, and technical reference for building Adobe XD Plugins",
"description": "Documentation, tutorials, how-tos, and technical reference for building Adobe XD Plugins",
"author": "Adobe",
"pdf": {
"fontFamily": "Georgia"
Expand Down
2 changes: 1 addition & 1 deletion changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ The following has changed in this release.

### Export Renditions

For an example of using export renditions, [see this guide](./guides/how-to-generate-an-export-rendition-guide).
For an example of using export renditions, [see this tutorial](./tutorials/how-to-generate-an-export-rendition).

### File I/O Improvements

Expand Down
6 changes: 3 additions & 3 deletions distribution/how-to-submit-to-plugin-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In order to make your plugin available in the XD plugin manager, you'll need to

## Prerequisite

- [A packaged plugin](/guides/how-to-package-a-plugin/index.md)
- [A packaged plugin](/tutorials/how-to-package-a-plugin/index.md)


## Pre-submission checklist
Expand Down Expand Up @@ -42,7 +42,7 @@ We'll walk you through the workflow below.
### 1. Read the submission guidelines

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.
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-submissionlines.html) before submitting to ensure a smooth path to publishing your plugin. Plugins violating the guidelines may be rejected.


### 2. Begin your submission
Expand Down Expand Up @@ -95,4 +95,4 @@ Once your submission has been reviewed, we’ll reach out letting you know if it

## Next steps

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.
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.
2 changes: 1 addition & 1 deletion distribution/marketing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ No matter how you plan to distribute your XD plugin, your marketing must follow

For details, make sure to read the [Adobe Creative Cloud Developer Brand Guide](https://partners.adobe.com/content/dam/tep_assets/public/public_1/documents/Adobe-Creative-Cloud-Developer-Brand-Guide.pdf).

The brand guide includes best practices for brand assets in marketing, press releases, and social media, and is the best spot to get our most up to date assets. You’ll also find information for how to publicize and promote your plugin once it’s approved.
The brand tutorial includes best practices for brand assets in marketing, press releases, and social media, and is the best spot to get our most up to date assets. You’ll also find information for how to publicize and promote your plugin once it’s approved.
8 changes: 4 additions & 4 deletions distribution/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ Once you have a packaged plugin, you're ready to distribute. You can make your p

## Prerequisite

- [A packaged plugin](/guides/how-to-package-a-plugin/index.md)
- [A packaged plugin](/tutorials/how-to-package-a-plugin/index.md)

## The XD plugin manager

The XD plugin manager lets users discover and install XD plugin right from within the app. Installation is as easy as a single click.

![](/images/plugin-manager.png)

To learn how to publish your plugin on the XD plugin manager, [see our publishing guide](./publishing).
To learn how to publish your plugin on the XD plugin manager, [see our publishing tutorial](./publishing).


## Direct distribution
Expand All @@ -30,5 +30,5 @@ If you distribute a .XDX file, installation is as simple as one double-click.

## Next steps

- If you plan to publish on the XD plugin manager, see our [publishing guide](./publishing)
- No matter how you plan to distribute, be sure to see our [plugin marketing guide](./marketing)
- If you plan to publish on the XD plugin manager, see our [publishing tutorial](./publishing)
- No matter how you plan to distribute, be sure to see our [plugin marketing tutorial](./marketing)
12 changes: 6 additions & 6 deletions distribution/packaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

Before you share your plugin, you'll need to package it up.

This guide describes how to package the files of an XD plugin. It's a simple process that can be summarized in three words: _compress_, _rename_, and _verify_.
This tutorial describes how to package the files of an XD plugin. It's a simple process that can be summarized in three words: _compress_, _rename_, and _verify_.


## Prerequisite
- A code-complete plugin (if you don't have one yet, try our [Quick Start Tutorial](/guides/quick-start-guide))
- A code-complete plugin (if you don't have one yet, try our [Quick Start Tutorial](/tutorials/quick-start))


## Workflow
Expand All @@ -28,7 +28,7 @@ If you plan to distribute via the XD plugin manager, make sure your .ZIP file is

### 2. Rename the .ZIP extension to .XDX

Adobe XD recognizes the .XDX file extension as an XD plugin.
Adobe XD recognizes the .XDX file extension as an XD plugin.

By using this file extension, your plugin automactically gets the "double-click to install" feature, meaning that if you share your plugin directly to users, all they have to do is double-click to install the plugin to Adobe XD.

Expand All @@ -37,13 +37,13 @@ If you plan to submit your plugin for distribution via the XD plugin manager, re

### 3. Verify the packaging worked

Try double-clicking your .XDX file. It should prompt you to install the plugin:
Try double-clicking your .XDX file. It should prompt you to install the plugin:

<img src="/images/readme-assets/package-plugin-steps/install.png" width="50%" height="50%">
<img src="/plugin-docs/images/readme-assets/package-plugin-steps/install.png" width="50%" height="50%">

Click install:

<img src="/images/readme-assets/package-plugin-steps/installed.png" width="50%" height="50%">
<img src="/plugin-docs/images/readme-assets/package-plugin-steps/installed.png" width="50%" height="50%">

You'll get a success message upon installation, after which the plugin will show up in XD.

Expand Down
108 changes: 0 additions & 108 deletions guides/how-to-ask-user-for-confirmation-guide/README.md

This file was deleted.

Loading

0 comments on commit 3b343d9

Please sign in to comment.