Home | History | Annotate | Download | only in addlhelp
      1 # -*- coding: utf-8 -*-
      2 # Copyright 2012 Google Inc. All Rights Reserved.
      3 #
      4 # Licensed under the Apache License, Version 2.0 (the "License");
      5 # you may not use this file except in compliance with the License.
      6 # You may obtain a copy of the License at
      7 #
      8 #     http://www.apache.org/licenses/LICENSE-2.0
      9 #
     10 # Unless required by applicable law or agreed to in writing, software
     11 # distributed under the License is distributed on an "AS IS" BASIS,
     12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13 # See the License for the specific language governing permissions and
     14 # limitations under the License.
     15 """Additional help about technical and billing support."""
     16 
     17 from __future__ import absolute_import
     18 
     19 from gslib.help_provider import HelpProvider
     20 
     21 _DETAILED_HELP_TEXT = ("""
     22 <B>TECHNICAL SUPPORT</B>
     23   If you have any questions or encounter any problems with Google Cloud Storage,
     24   please first read the `FAQ <https://developers.google.com/storage/docs/faq>`_.
     25 
     26   If you still have questions please use one of the following methods as
     27   appropriate, providing the details noted below:
     28 
     29   A) For API, tool usage, or other software development-related questions,
     30   please search for and post questions on Stack Overflow, using the official
     31   `google-cloud-storage tag
     32   <http://stackoverflow.com/questions/tagged/google-cloud-storage>`_. Our
     33   support team actively monitors questions to this tag and we'll do our best to
     34   respond.
     35 
     36   B) For questions regarding your account, billing, Terms Of Service, Google
     37   Cloud Console, or other administration-related questions please email
     38   gs-team (at] google.com.
     39 
     40   To help us diagnose any issues you encounter, please provide these details
     41   in addition to the description of your problem:
     42 
     43   - The resource you are attempting to access (bucket name, object name)
     44   - The operation you attempted (GET, PUT, etc.)
     45   - The time and date (including timezone) at which you encountered the problem
     46   - The tool or library you use to interact with Google Cloud Storage
     47   - If you can use gsutil to reproduce your issue, specify the -D option to
     48     display your request's HTTP details. Provide these details with your post
     49     to the forum as they can help us further troubleshoot your issue.
     50 
     51   Warning: The gsutil -d, -D, and -DD options will also print the authentication
     52   header with authentication credentials for your Google Cloud Storage account.
     53   Make sure to remove any "Authorization:" headers before you post HTTP details
     54   to the forum. Note also that if you upload files large enough to use resumable
     55   uploads, the resumable upload IDs are security-sensitive while an upload
     56   is not yet complete, so should not be posted on public forums.
     57 
     58   If you make any local modifications to gsutil, please make sure to use
     59   a released copy of gsutil (instead of your locally modified copy) when
     60   providing the gsutil -D output noted above. We cannot support versions
     61   of gsutil that include local modifications. (However, we're open to user
     62   contributions; see "gsutil help dev".)
     63 
     64 
     65 <B>BILLING AND ACCOUNT QUESTIONS</B>
     66   For questions about billing or account issues, please visit
     67   https://developers.google.com/storage/docs/pricing-and-terms.
     68   If you want to cancel billing, follow the instructions at
     69   `Google Developers Console<https://developers.google.com/console/help/billing>`
     70   Caution: When you disable billing, you also disable the Google Cloud Storage
     71   service. Make sure you want to disable the Google Cloud Storage service
     72   before you disable billing.
     73 """)
     74 
     75 
     76 class CommandOptions(HelpProvider):
     77   """Additional help about technical and billing support."""
     78 
     79   # Help specification. See help_provider.py for documentation.
     80   help_spec = HelpProvider.HelpSpec(
     81       help_name='support',
     82       help_name_aliases=[
     83           'techsupport', 'tech support', 'technical support', 'billing', 'faq',
     84           'questions'],
     85       help_type='additional_help',
     86       help_one_line_summary='Google Cloud Storage Support',
     87       help_text=_DETAILED_HELP_TEXT,
     88       subcommand_help_text={},
     89   )
     90