Skip to content

Commit 432bd9f

Browse files
author
William Pelrine
committed
Merge branch 'pro'
2 parents 301323e + 3b5e720 commit 432bd9f

14 files changed

Lines changed: 398 additions & 46 deletions
210 KB
Loading
231 KB
Loading
242 KB
Loading
-2.04 KB
Loading
106 KB
Loading
75.6 KB
Loading

‎src/components/docs-menu/docs-menu-map.ts‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,14 @@ export const main = {
6767

6868
export const pro = {
6969
'Home': '/docs',
70-
'Introduction': '/docs/pro',
70+
'Introduction': {
71+
'Getting Started': '/docs/pro',
72+
'Git Workflow': '/docs/pro/basics/git'
73+
},
74+
'Builds': {
75+
'Build Types': '/docs/pro/builds/intro',
76+
'Build Environments': '/docs/pro/builds/environments'
77+
},
7178
'Deploy': {
7279
'Introduction': '/docs/pro/deploy/intro',
7380
'Installation': '/docs/pro/deploy/setup',
@@ -85,9 +92,6 @@ export const pro = {
8592
'Manage': '/docs/pro/automation/create',
8693
'Webhooks': '/docs/pro/automation/webhooks'
8794
},
88-
'Environments': {
89-
'Introduction': '/docs/pro/environments/intro'
90-
}
9195
};
9296

9397
export const outbound = {

‎src/components/docs-menu/docs-menu.tsx‎

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,18 @@ export class DocsMenu {
9090

9191
@Watch('path')
9292
setActiveItemFromPath(path) {
93-
const topLevelKeys = Object.keys(menuMap.main);
93+
// Decide if we should look at the Pro or Framework doc maps
94+
let keyMap: any = menuMap.main;
95+
if (path.includes('/pro')) {
96+
keyMap = menuMap.pro;
97+
}
98+
99+
// Find the URL we're at
100+
const topLevelKeys = Object.keys(keyMap);
94101
const activeKey = topLevelKeys.find(key => {
95-
const items = menuMap.main[key];
96-
if (items === path) return true;
97-
return Object.keys(items).some(itemKey => items[itemKey] === path);
102+
const items = keyMap[key];
103+
if (typeof(items) === 'string' && items.split('#')[0] === path) return true;
104+
return Object.keys(items).some(itemKey => items[itemKey].split('#')[0] === path);
98105
});
99106
this.setActiveItem(activeKey);
100107
}
@@ -182,6 +189,19 @@ export class DocsMenu {
182189
return renderer(key, val, onClick);
183190
})}
184191
</ul>,
192+
<ul>
193+
<li style={{ marginTop: '1.5rem' }}>
194+
<stencil-route-link
195+
class="menu__item menu__item--outbound migration-pill"
196+
url="/docs/building/migration"
197+
exact>
198+
v4 Migration Guide
199+
<svg viewBox="0 0 16 24">
200+
<path d="M3 2l10 10L3 22" stroke-width="3" fill="none" fill-rule="evenodd"/>
201+
</svg>
202+
</stencil-route-link>
203+
</li>
204+
</ul>
185205
];
186206
case 'framework':
187207
default:
Lines changed: 15 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,25 @@
1-
# Managing Automations
1+
# Using Automations
22

3-
Creating new automations is simple. To get started, simply navigate to the `Automate` tab within the desired app:
3+
## Managing Automations
44

5-
<img style="width: 230px" src="/docs/assets/img/pro/ss-automations-automate-tab.png" class="browser" />
5+
Creating and customizing automations is simple. To get started, simply navigate to the `Automate` tab within the desired app.
66

7-
## Creating Automations
7+
To **create a new automation**, click the `New Automation` button on the top right of the `Automate` dashboard. When clicked, the automation customization form will appear, which has several fields available to customize the automation (Read more about these [below](#customizing-automations)).
88

9-
To create a new automation, click the `New Automation` button on the top right of the `Automate` dashboard.
9+
To **edit an automation**, click the three dots next to the one you'd like to modify.
1010

11-
<img src="/docs/assets/img/pro/ss-automations-dashboard-new.png" class="browser" />
11+
## Customizing Automations
1212

13-
## Editing Automations
14-
15-
To edit an automation, click the three dots next to the one you'd like to modify.
16-
17-
<img src="/docs/assets/img/pro/ss-automations-dashboard-settings.png" class="browser" />
18-
19-
## Automation Fields
13+
There are a number of customizations available to specify the specific behavior of a given automation. They are shown on the create/edit automation form below.
2014

2115
<img src="/docs/assets/img/pro/ss-automations-automate-form.png" class="browser" />
2216

23-
### Name
24-
25-
A name to remember your automation by.
26-
27-
### Git Branch
28-
29-
The branch which will trigger your automation. This will run your build any time someone makes a `git push` to the specified branch.
30-
31-
### Target Platform
32-
33-
The platform you're targeting, can be Android or iOS (for either Xcode 8 or 9)
34-
35-
### Build Type
36-
37-
The type of build you'd like to create. Options depend on the selected platform.
38-
39-
### Security Profile
40-
41-
Which security profile you'd like to use. If you have no profiles set up, you can learn more about them [here](/docs/pro/package/profiles.html).
42-
43-
### Webhook
17+
### Fields
4418

45-
(optional) If specified, we'll send a POST with information about completed builds to a webhook of your choice. You can learn more about their content [here](/docs/pro/automation/webhooks).
19+
* **Name:** A name to identify the automation task.
20+
* **Git Branch:** The branch which will trigger the automation. This will run a build any time a `git push` is made to the specified branch.
21+
* **Environment:** The [custom build environment](/docs/pro/builds/environments#custom-environments) (if any) to use when this automations is triggered.
22+
* **Target Platform:** The platform being targeted, can be Android or iOS (for either Xcode 8 or 9)
23+
* **Build Type:** The type of build to create. Options depend on the selected platform.
24+
* **Security Profile:** Which security profile to use. Learn more about them [here](/docs/pro/package/profiles.html).
25+
* **Webhook:** (optional) If specified, a POST with information about completed builds will be sent to the entered URL. Learn more about their content [here](/docs/pro/automation/webhooks).

‎src/content/pro/automation/intro.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
Ionic Pro's automation features let you generate deliverable native builds whenever you need them. Webhooks with secure, signed download URL's and build information are also easily configurable and updatable, ensuring your app gets in the necessary hands quickly and automatically.
44

55

6-
## Ionic Package
6+
## Before Starting
77

8-
In order to take full advantage of automation, you first need to configure the package service. If you haven't yet, [learn more about it here](/docs/pro/package/intro).
8+
To take advantage of the full power of automations, an app must be configured to use [Package Builds](/docs/pro/package/intro), as this feature is leveraged to deliver native code.
99

10-
## Get started
10+
## Using Automation
1111

1212
* [Creating Automations](/docs/pro/automation/create)
1313
* [Understanding Webhooks](/docs/pro/automation/webhooks)

0 commit comments

Comments
 (0)