Skip to content

Commit f34d10c

Browse files
committed
documentation
1 parent fe6c72c commit f34d10c

File tree

4 files changed

+45
-16
lines changed

4 files changed

+45
-16
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,12 @@ The Async Lib provides easy way for managing asynchronous processes in Salesforc
2020

2121
For more details and examples, please look into this [post](https://blog.beyondthecloud.dev/blog/apex-queueable-processing-framework).
2222

23+
## Documentation
24+
25+
Visit https://async.beyondthecloud.dev/ to view the full documentation.
26+
2327
## Features
28+
2429
- **Queueable Chain**: Eliminate the issues with "Too many queueable jobs" by using the `Async.queueable()` method to enqueue jobs in both synchronous and asynchronous context.
2530
- Framework will automatically handle the chaining of jobs, allowing you to enqueue multiple jobs without hitting the limit, in the same time using as many jobs as possible.
2631
- Each job will get its own Custom Job ID, which can be used to track the job status.

website/.vitepress/config.mts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ export default defineConfig({
1616
{
1717
text: 'Introduction',
1818
items: [
19-
{ text: 'Getting Started', link: '/getting-started' }
19+
{ text: 'Getting Started', link: '/getting-started' },
20+
{ text: 'Installation', link: '/introduction/installation' }
2021
]
2122
},
2223
{
@@ -32,7 +33,6 @@ export default defineConfig({
3233
socialLinks: [
3334
{ icon: 'github', link: 'https://github.com/beyond-the-cloud-dev/async-lib' },
3435
{ icon: 'linkedin', link: 'https://www.linkedin.com/company/beyondtheclouddev' }
35-
3636
]
3737
}
3838
})

website/getting-started.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,20 +57,6 @@ Async Lib is a powerful Salesforce Apex framework that provides an elegant solut
5757
- **⚙️ Configuration-Driven**: Control job behavior through custom metadata without code changes
5858
- **🔗 Support Finalizers**: Execute cleanup logic after job completion with full context
5959

60-
## Installation
61-
62-
Deploy to your Salesforce org using the deploy button:
63-
64-
<a href="https://githubsfdeploy.herokuapp.com?owner=beyond-the-cloud-dev&repo=async-lib&ref=main">
65-
<img alt="Deploy to Salesforce" src="https://raw.githubusercontent.com/afawcett/githubsfdeploy/master/deploy.png">
66-
</a>
67-
68-
Or clone the repository and deploy using SFDX:
69-
70-
```bash
71-
git clone https://github.com/beyond-the-cloud-dev/async-lib.git
72-
cd async-lib
73-
sf project deploy start -p force-app -u your-org-alias
7460
```
7561
7662
## Core Concepts
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
outline: deep
3+
---
4+
5+
# Installation <Badge type="tip" text="v1.0.0" />
6+
7+
## Install via Package
8+
9+
Install the SOQL Lib unmanaged package to your Salesforce environment:
10+
11+
12+
`/packaging/installPackage.apexp?p0=04tP6000001w95Z`
13+
14+
<a href="https://test.salesforce.com/packaging/installPackage.apexp?p0=04tP6000001w95Z" target="_blank">
15+
<p>Install on Sandbox</p>
16+
</a>
17+
18+
<a href="https://login.salesforce.com/packaging/installPackage.apexp?p0=04tP6000001w95Z" target="_blank">
19+
<p>Install on Production</p>
20+
</a>
21+
22+
## Deploy via Button
23+
24+
Deploy to your Salesforce org using the deploy button:
25+
26+
<a href="https://githubsfdeploy.herokuapp.com?owner=beyond-the-cloud-dev&repo=async-lib&ref=main">
27+
<img alt="Deploy to Salesforce" src="https://raw.githubusercontent.com/afawcett/githubsfdeploy/master/deploy.png">
28+
</a>
29+
30+
## Copy and Deploy
31+
32+
Or clone the repository and deploy using SFDX:
33+
34+
```bash
35+
git clone https://github.com/beyond-the-cloud-dev/async-lib.git
36+
cd async-lib
37+
sf project deploy start -p force-app -u your-org-alias
38+
```

0 commit comments

Comments
 (0)