Skip to content

Commit

Permalink
[documentation] Fix syntax error on tiered storage documentation
Browse files Browse the repository at this point in the history
 ### Motivation

There is a syntax error in tiered storage doc introduced by apache#2152.

```
Liquid Exception: Invalid syntax for include tag: type="warning" content="Driver names are case-insensitive for driver's name. There is a third driver type, "s3", which is identical to "aws-s3", though it requires that you specify an endpoint url using `s3ManagedLedgerOffloadServiceEndpoint`. This is useful if using a S3 compatible data store, other than AWS." Valid syntax: {% include file.ext param='value' param2='value' %} in docs/latest/cookbooks/tiered-storage.md
```

 ### Changes

Fix the syntax error.
  • Loading branch information
sijie committed Aug 8, 2018
1 parent 0260df0 commit b594d69
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion site/docs/latest/cookbooks/tiered-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Offloading is configured in ```broker.conf```.
At a minimum, the administrator must configure the driver, the bucket and the authenticating credentials. There is also some other knobs to configure, like the bucket region, the max block size in backed storage, etc.

Currently we support driver of types: { "aws-s3", "google-cloud-storage" },
{% include admonition.html type="warning" content="Driver names are case-insensitive for driver's name. There is a third driver type, "s3", which is identical to "aws-s3", though it requires that you specify an endpoint url using `s3ManagedLedgerOffloadServiceEndpoint`. This is useful if using a S3 compatible data store, other than AWS." %}
{% include admonition.html type="warning" content="Driver names are case-insensitive for driver's name. There is a third driver type, \"s3\", which is identical to \"aws-s3\", though it requires that you specify an endpoint url using `s3ManagedLedgerOffloadServiceEndpoint`. This is useful if using a S3 compatible data store, other than AWS." %}

```conf
managedLedgerOffloadDriver=aws-s3
Expand Down

0 comments on commit b594d69

Please sign in to comment.