Skip to content

Commit

Permalink
Merge branch 'DDOC-1208-docgen-guide' of github.com:box/developer.box…
Browse files Browse the repository at this point in the history
….com into staging
  • Loading branch information
bszwarc committed Dec 30, 2024
2 parents 85c0c22 + b8f5420 commit a2ac23e
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 12 deletions.
4 changes: 2 additions & 2 deletions content/guides/docgen/docgen-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ related_guides:
# Get started with Box Doc Gen

To start generating documents with Box Doc Gen API you will need a custom application and a developer token to
authenticate your calls. You also need a Doc Gen template that will serve as a input source for your document.
authenticate your calls. You also need a Doc Gen template that will serve as an input source for your document.

## Enable Box Doc Gen

To use Box Doc Gen, make sure it is enabled by an
admin in the Admin Console.
If you are a Box Admin, you will find the necessary information in
[Enterprise Settings: Content & Sharing Tab][settings] documentation
[Enterprise Settings: Content & Sharing Tab][settings] documentation.

## Create and upload a Box Doc Gen template

Expand Down
3 changes: 1 addition & 2 deletions content/guides/docgen/docgen-jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ Box Doc Gen API allows you to get information about the Box Doc Gen jobs.

## Prerequisites

Make sure you followed the steps listed in [getting started Box Doc Gen][docgen-prerequisites] to create a custom app and a Box Doc Gen template.
You can then proceed to use the Box Doc Gen API.
Before you start using Box Doc Gen API, follow the steps listed in [getting started Box Doc Gen][docgen-prerequisites] to create a custom app and a Box Doc Gen template.

## List all Box Doc Gen jobs

Expand Down
3 changes: 1 addition & 2 deletions content/guides/docgen/docgen-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ Box Doc Gen API allows you to retrieve information related to Box Doc Gen templa

## Prerequisites

Make sure you followed the steps listed in [getting started Box Doc Gen][docgen-prerequisites] to create a custom app and a Box Doc Gen template.
You can then proceed to use the Box Doc Gen API.
Before you start using Box Doc Gen API, follow the steps listed in [getting started Box Doc Gen][docgen-prerequisites] to create a custom app and a Box Doc Gen template.

## List Box Doc Gen templates

Expand Down
5 changes: 2 additions & 3 deletions content/guides/docgen/generate-document.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ The `POST /2.0/docgen_batches` endpoint allows you to generate a document using

## Prerequisites

Make sure you followed the steps listed in [getting started Box Doc Gen][docgen-prerequisites] to create a custom app and a Box Doc Gen template.
You can then proceed to use the Box Doc Gen API.
Before you start using Box Doc Gen API, follow the steps listed in [getting started Box Doc Gen][docgen-prerequisites] to create a custom app and a Box Doc Gen template.

## Send a request

Expand Down Expand Up @@ -47,7 +46,7 @@ A sample call looks as follows:

<Samples id='post_docgen_batches' />

When the request is being processed, each entry into `document_generation_data` array is treated as a separate document generation job that Box Doc Gen adds to the document generation queue.
When the request is being processed, each entry in the `document_generation_data` array is treated as a separate document generation job that Box Doc Gen adds to the document generation queue.

Generated documents will be saved in the designated folder.

Expand Down
5 changes: 2 additions & 3 deletions content/guides/docgen/mark-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ You can mark an existing document as a Box Doc Gen template and use it to genera

## Before you start

Make sure you followed the steps listed in [getting started Box Doc Gen][docgen-prerequisites] to create a custom app and a Box Doc Gen template.
You can then proceed to use the Box Doc Gen API.
Before you start using Box Doc Gen API, follow the steps listed in [getting started Box Doc Gen][docgen-prerequisites] to create a custom app and a Box Doc Gen template.

## Send a request

Expand All @@ -26,7 +25,7 @@ provide the mandatory parameters.

### Parameters

To make a call, you need to pass the following parameters.
To make a call you need to pass the following parameters.
Mandatory parameters are in **bold**.

| Parameter |Description | Example |
Expand Down

0 comments on commit a2ac23e

Please sign in to comment.