222b074cb1
Currently, any document name or schema referenced in the Shipyard code base is a hard-coded string. Often times, these strings are repeated throughout the code. This patch set adds a new configuration section to shipyard.conf to define document names and schemas so they can then be referenced in the Shipyard code via the oslo configuration object. This functionality will be important for upcoming Shipyard features which will call for more documents to be validated as well as some new Shipyard-created docs. Change-Id: I34ae8cd578bab730d004c3d176e3817b5a45c89e
28 lines
1.1 KiB
ReStructuredText
28 lines
1.1 KiB
ReStructuredText
..
|
|
Copyright 2017 AT&T Intellectual Property. All other rights reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
.. _sample-configuration:
|
|
|
|
Sample Configuration File
|
|
==========================
|
|
|
|
The following is a sample Shipyard configuration for adaptation and use. It is
|
|
auto-generated from Shipyard when this documentation is built, so
|
|
if you are having issues with an option, please compare your version of
|
|
Shipyard with the version of this documentation.
|
|
|
|
The sample configuration can also be viewed in `file form <_static/shipyard.conf.sample>`_.
|
|
|
|
.. literalinclude:: _static/shipyard.conf.sample
|