Doc fragments to plugins (#50172)

* promote doc_fragments into actual plugins

  change tests hardcoded path to doc fragments
  avoid sanity in fragments
  avoid improper testing of doc_fragments
  also change runner paths
 fix botmeta
 updated comment for fragments
 updated docs
This commit is contained in:
Brian Coca 2019-01-23 20:03:47 -05:00 committed by GitHub
commit 96b3ef5553
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
106 changed files with 51 additions and 31 deletions

View file

@ -0,0 +1,42 @@
# -*- coding: utf-8 -*-
# Copyright (C) 2018 Yanis Guenane <yanis+ansible@guenane.org>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
class ModuleDocFragment(object):
# Standard documentation fragment
DOCUMENTATION = '''
options:
api_token:
description:
- Scaleway OAuth token.
aliases: ['oauth_token']
api_url:
description:
- Scaleway API URL
default: 'https://api.scaleway.com'
aliases: ['base_url']
api_timeout:
description:
- HTTP timeout to Scaleway API in seconds.
default: 30
aliases: ['timeout']
query_parameters:
description:
- List of parameters passed to the query string
type: dict
default: {}
validate_certs:
description:
- Validate SSL certs of the Scaleway API.
default: yes
type: bool
notes:
- Also see the API documentation on U(https://developer.scaleway.com/)
- If C(api_token) is not set within the module, the following
environment variables can be used in decreasing order of precedence
C(SCW_TOKEN), C(SCW_API_KEY), C(SCW_OAUTH_TOKEN) or C(SCW_API_TOKEN).
- If one wants to use a different C(api_url) one can also set the C(SCW_API_URL)
environment variable.
'''