pulsar-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From si...@apache.org
Subject [incubator-pulsar] branch master updated: [documentation] Fix syntax error on tiered storage documentation (#2345)
Date Wed, 08 Aug 2018 21:13:47 GMT
This is an automated email from the ASF dual-hosted git repository.

sijie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new 3b3f541  [documentation] Fix syntax error on tiered storage documentation (#2345)
3b3f541 is described below

commit 3b3f541c6dc0d66a3ecaf7a0557fc31e9c8d4dfd
Author: Sijie Guo <guosijie@gmail.com>
AuthorDate: Wed Aug 8 14:13:44 2018 -0700

    [documentation] Fix syntax error on tiered storage documentation (#2345)
    
    ### Motivation
    
    There is a syntax error in tiered storage doc introduced by #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.
---
 site/docs/latest/cookbooks/tiered-storage.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/site/docs/latest/cookbooks/tiered-storage.md b/site/docs/latest/cookbooks/tiered-storage.md
index 88cb1a3..84d2716 100644
--- a/site/docs/latest/cookbooks/tiered-storage.md
+++ b/site/docs/latest/cookbooks/tiered-storage.md
@@ -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


Mime
View raw message