Browse Source

refactored for switch to specs.openstack.org

* added CONTRIBUTING, HACKING and LICENSE file like in the other
  openstack specs repos
* added Makefile to autogenerate html files easier
* refactored index.rst for easier access to the specs

Change-Id: Ic018705a23398572e4efca1d958d9282746008f4
Jan Klare 3 years ago
parent
commit
7445f03a19
5 changed files with 379 additions and 7 deletions
  1. 12
    0
      CONTRIBUTING.rst
  2. 4
    0
      HACKING.rst
  3. 175
    0
      LICENSE
  4. 164
    0
      doc/Makefile
  5. 24
    7
      doc/source/index.rst

+ 12
- 0
CONTRIBUTING.rst View File

@@ -0,0 +1,12 @@
1
+If you would like to contribute to the development of OpenStack,
2
+you must follow the steps in this page:
3
+
4
+http://docs.openstack.org/infra/manual/developers.html
5
+
6
+Once those steps have been completed, changes to OpenStack
7
+should be submitted for review via the Gerrit tool, following
8
+the workflow documented at:
9
+
10
+http://docs.openstack.org/infra/manual/developers.html#development-workflow
11
+
12
+Pull requests submitted through GitHub will be ignored.

+ 4
- 0
HACKING.rst View File

@@ -0,0 +1,4 @@
1
+openstack-chef-specs Style Commandments
2
+=========================================
3
+
4
+Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/

+ 175
- 0
LICENSE View File

@@ -0,0 +1,175 @@
1
+
2
+                                 Apache License
3
+                           Version 2.0, January 2004
4
+                        http://www.apache.org/licenses/
5
+
6
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+   1. Definitions.
9
+
10
+      "License" shall mean the terms and conditions for use, reproduction,
11
+      and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+      "Licensor" shall mean the copyright owner or entity authorized by
14
+      the copyright owner that is granting the License.
15
+
16
+      "Legal Entity" shall mean the union of the acting entity and all
17
+      other entities that control, are controlled by, or are under common
18
+      control with that entity. For the purposes of this definition,
19
+      "control" means (i) the power, direct or indirect, to cause the
20
+      direction or management of such entity, whether by contract or
21
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+      outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+      "You" (or "Your") shall mean an individual or Legal Entity
25
+      exercising permissions granted by this License.
26
+
27
+      "Source" form shall mean the preferred form for making modifications,
28
+      including but not limited to software source code, documentation
29
+      source, and configuration files.
30
+
31
+      "Object" form shall mean any form resulting from mechanical
32
+      transformation or translation of a Source form, including but
33
+      not limited to compiled object code, generated documentation,
34
+      and conversions to other media types.
35
+
36
+      "Work" shall mean the work of authorship, whether in Source or
37
+      Object form, made available under the License, as indicated by a
38
+      copyright notice that is included in or attached to the work
39
+      (an example is provided in the Appendix below).
40
+
41
+      "Derivative Works" shall mean any work, whether in Source or Object
42
+      form, that is based on (or derived from) the Work and for which the
43
+      editorial revisions, annotations, elaborations, or other modifications
44
+      represent, as a whole, an original work of authorship. For the purposes
45
+      of this License, Derivative Works shall not include works that remain
46
+      separable from, or merely link (or bind by name) to the interfaces of,
47
+      the Work and Derivative Works thereof.
48
+
49
+      "Contribution" shall mean any work of authorship, including
50
+      the original version of the Work and any modifications or additions
51
+      to that Work or Derivative Works thereof, that is intentionally
52
+      submitted to Licensor for inclusion in the Work by the copyright owner
53
+      or by an individual or Legal Entity authorized to submit on behalf of
54
+      the copyright owner. For the purposes of this definition, "submitted"
55
+      means any form of electronic, verbal, or written communication sent
56
+      to the Licensor or its representatives, including but not limited to
57
+      communication on electronic mailing lists, source code control systems,
58
+      and issue tracking systems that are managed by, or on behalf of, the
59
+      Licensor for the purpose of discussing and improving the Work, but
60
+      excluding communication that is conspicuously marked or otherwise
61
+      designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+      "Contributor" shall mean Licensor and any individual or Legal Entity
64
+      on behalf of whom a Contribution has been received by Licensor and
65
+      subsequently incorporated within the Work.
66
+
67
+   2. Grant of Copyright License. Subject to the terms and conditions of
68
+      this License, each Contributor hereby grants to You a perpetual,
69
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+      copyright license to reproduce, prepare Derivative Works of,
71
+      publicly display, publicly perform, sublicense, and distribute the
72
+      Work and such Derivative Works in Source or Object form.
73
+
74
+   3. Grant of Patent License. Subject to the terms and conditions of
75
+      this License, each Contributor hereby grants to You a perpetual,
76
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+      (except as stated in this section) patent license to make, have made,
78
+      use, offer to sell, sell, import, and otherwise transfer the Work,
79
+      where such license applies only to those patent claims licensable
80
+      by such Contributor that are necessarily infringed by their
81
+      Contribution(s) alone or by combination of their Contribution(s)
82
+      with the Work to which such Contribution(s) was submitted. If You
83
+      institute patent litigation against any entity (including a
84
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+      or a Contribution incorporated within the Work constitutes direct
86
+      or contributory patent infringement, then any patent licenses
87
+      granted to You under this License for that Work shall terminate
88
+      as of the date such litigation is filed.
89
+
90
+   4. Redistribution. You may reproduce and distribute copies of the
91
+      Work or Derivative Works thereof in any medium, with or without
92
+      modifications, and in Source or Object form, provided that You
93
+      meet the following conditions:
94
+
95
+      (a) You must give any other recipients of the Work or
96
+          Derivative Works a copy of this License; and
97
+
98
+      (b) You must cause any modified files to carry prominent notices
99
+          stating that You changed the files; and
100
+
101
+      (c) You must retain, in the Source form of any Derivative Works
102
+          that You distribute, all copyright, patent, trademark, and
103
+          attribution notices from the Source form of the Work,
104
+          excluding those notices that do not pertain to any part of
105
+          the Derivative Works; and
106
+
107
+      (d) If the Work includes a "NOTICE" text file as part of its
108
+          distribution, then any Derivative Works that You distribute must
109
+          include a readable copy of the attribution notices contained
110
+          within such NOTICE file, excluding those notices that do not
111
+          pertain to any part of the Derivative Works, in at least one
112
+          of the following places: within a NOTICE text file distributed
113
+          as part of the Derivative Works; within the Source form or
114
+          documentation, if provided along with the Derivative Works; or,
115
+          within a display generated by the Derivative Works, if and
116
+          wherever such third-party notices normally appear. The contents
117
+          of the NOTICE file are for informational purposes only and
118
+          do not modify the License. You may add Your own attribution
119
+          notices within Derivative Works that You distribute, alongside
120
+          or as an addendum to the NOTICE text from the Work, provided
121
+          that such additional attribution notices cannot be construed
122
+          as modifying the License.
123
+
124
+      You may add Your own copyright statement to Your modifications and
125
+      may provide additional or different license terms and conditions
126
+      for use, reproduction, or distribution of Your modifications, or
127
+      for any such Derivative Works as a whole, provided Your use,
128
+      reproduction, and distribution of the Work otherwise complies with
129
+      the conditions stated in this License.
130
+
131
+   5. Submission of Contributions. Unless You explicitly state otherwise,
132
+      any Contribution intentionally submitted for inclusion in the Work
133
+      by You to the Licensor shall be under the terms and conditions of
134
+      this License, without any additional terms or conditions.
135
+      Notwithstanding the above, nothing herein shall supersede or modify
136
+      the terms of any separate license agreement you may have executed
137
+      with Licensor regarding such Contributions.
138
+
139
+   6. Trademarks. This License does not grant permission to use the trade
140
+      names, trademarks, service marks, or product names of the Licensor,
141
+      except as required for reasonable and customary use in describing the
142
+      origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+   7. Disclaimer of Warranty. Unless required by applicable law or
145
+      agreed to in writing, Licensor provides the Work (and each
146
+      Contributor provides its Contributions) on an "AS IS" BASIS,
147
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+      implied, including, without limitation, any warranties or conditions
149
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+      PARTICULAR PURPOSE. You are solely responsible for determining the
151
+      appropriateness of using or redistributing the Work and assume any
152
+      risks associated with Your exercise of permissions under this License.
153
+
154
+   8. Limitation of Liability. In no event and under no legal theory,
155
+      whether in tort (including negligence), contract, or otherwise,
156
+      unless required by applicable law (such as deliberate and grossly
157
+      negligent acts) or agreed to in writing, shall any Contributor be
158
+      liable to You for damages, including any direct, indirect, special,
159
+      incidental, or consequential damages of any character arising as a
160
+      result of this License or out of the use or inability to use the
161
+      Work (including but not limited to damages for loss of goodwill,
162
+      work stoppage, computer failure or malfunction, or any and all
163
+      other commercial damages or losses), even if such Contributor
164
+      has been advised of the possibility of such damages.
165
+
166
+   9. Accepting Warranty or Additional Liability. While redistributing
167
+      the Work or Derivative Works thereof, You may choose to offer,
168
+      and charge a fee for, acceptance of support, warranty, indemnity,
169
+      or other liability obligations and/or rights consistent with this
170
+      License. However, in accepting such obligations, You may act only
171
+      on Your own behalf and on Your sole responsibility, not on behalf
172
+      of any other Contributor, and only if You agree to indemnify,
173
+      defend, and hold each Contributor harmless for any liability
174
+      incurred by, or claims asserted against, such Contributor by reason
175
+      of your accepting any such warranty or additional liability.

+ 164
- 0
doc/Makefile View File

@@ -0,0 +1,164 @@
1
+# Makefile for Sphinx documentation
2
+#
3
+
4
+# You can set these variables from the command line.
5
+SPHINXOPTS    =
6
+SPHINXBUILD   = sphinx-build
7
+PAPER         =
8
+BUILDDIR      = build
9
+
10
+# Internal variables.
11
+PAPEROPT_a4     = -D latex_paper_size=a4
12
+PAPEROPT_letter = -D latex_paper_size=letter
13
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14
+# the i18n builder cannot share the environment and doctrees with the others
15
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
16
+
17
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
18
+
19
+help:
20
+	@echo "Please use \`make <target>' where <target> is one of"
21
+	@echo "  html       to make standalone HTML files"
22
+	@echo "  dirhtml    to make HTML files named index.html in directories"
23
+	@echo "  singlehtml to make a single large HTML file"
24
+	@echo "  pickle     to make pickle files"
25
+	@echo "  json       to make JSON files"
26
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
27
+	@echo "  qthelp     to make HTML files and a qthelp project"
28
+	@echo "  devhelp    to make HTML files and a Devhelp project"
29
+	@echo "  epub       to make an epub"
30
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
32
+	@echo "  text       to make text files"
33
+	@echo "  man        to make manual pages"
34
+	@echo "  texinfo    to make Texinfo files"
35
+	@echo "  info       to make Texinfo files and run them through makeinfo"
36
+	@echo "  gettext    to make PO message catalogs"
37
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
38
+	@echo "  linkcheck  to check all external links for integrity"
39
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
40
+	@echo "  wadl       to build a WADL file for api.openstack.org"
41
+
42
+clean:
43
+	-rm -rf $(BUILDDIR)/*
44
+
45
+html: check-dependencies
46
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
47
+	@echo
48
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
49
+
50
+.PHONY: check-dependencies
51
+check-dependencies:
52
+	@python -c 'import sphinxcontrib.autohttp.flask' >/dev/null 2>&1 || (echo "ERROR: Missing Sphinx dependencies. Run: pip install sphinxcontrib-httpdomain" && exit 1)
53
+
54
+wadl:
55
+	$(SPHINXBUILD) -b docbook $(ALLSPHINXOPTS) $(BUILDDIR)/wadl
56
+	@echo
57
+	@echo "Build finished. The WADL pages are in $(BUILDDIR)/wadl."
58
+
59
+dirhtml:
60
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
61
+	@echo
62
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
63
+
64
+singlehtml:
65
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
66
+	@echo
67
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
68
+
69
+pickle:
70
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
71
+	@echo
72
+	@echo "Build finished; now you can process the pickle files."
73
+
74
+json:
75
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
76
+	@echo
77
+	@echo "Build finished; now you can process the JSON files."
78
+
79
+htmlhelp:
80
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
81
+	@echo
82
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
83
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
84
+
85
+qthelp:
86
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
87
+	@echo
88
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
89
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
90
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Ceilometer.qhcp"
91
+	@echo "To view the help file:"
92
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Ceilometer.qhc"
93
+
94
+devhelp:
95
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
96
+	@echo
97
+	@echo "Build finished."
98
+	@echo "To view the help file:"
99
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Ceilometer"
100
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Ceilometer"
101
+	@echo "# devhelp"
102
+
103
+epub:
104
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
105
+	@echo
106
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
107
+
108
+latex:
109
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
110
+	@echo
111
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
112
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
113
+	      "(use \`make latexpdf' here to do that automatically)."
114
+
115
+latexpdf:
116
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
117
+	@echo "Running LaTeX files through pdflatex..."
118
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
119
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
120
+
121
+text:
122
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
123
+	@echo
124
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
125
+
126
+man:
127
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
128
+	@echo
129
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
130
+
131
+texinfo:
132
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
133
+	@echo
134
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
135
+	@echo "Run \`make' in that directory to run these through makeinfo" \
136
+	      "(use \`make info' here to do that automatically)."
137
+
138
+info:
139
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
140
+	@echo "Running Texinfo files through makeinfo..."
141
+	make -C $(BUILDDIR)/texinfo info
142
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
143
+
144
+gettext:
145
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
146
+	@echo
147
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
148
+
149
+changes:
150
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
151
+	@echo
152
+	@echo "The overview file is in $(BUILDDIR)/changes."
153
+
154
+linkcheck:
155
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
156
+	@echo
157
+	@echo "Link check complete; look for any errors in the above output " \
158
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
159
+
160
+doctest:
161
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
162
+	@echo "Testing of doctests in the sources finished, look at the " \
163
+	      "results in $(BUILDDIR)/doctest/output.txt."
164
+

+ 24
- 7
doc/source/index.rst View File

@@ -1,19 +1,36 @@
1 1
 .. openstack-chef-specs documentation master file
2 2
 
3
-=========================================
4
-OpenStack for Chef Project Specifications
5
-=========================================
3
+=============================================
4
+Specifications for the OpenStack Chef Project
5
+=============================================
6 6
 
7
-Juno specs:
7
+Liberty approved specs
8
+======================
8 9
 
9 10
 .. toctree::
10 11
    :glob:
11
-   :maxdepth: 4
12
+   :maxdepth: 1
12 13
 
13
-   specs/juno/**
14
-   specs/kilo/**
15 14
    specs/liberty/**
16 15
 
16
+Kilo approved specs
17
+===================
18
+
19
+.. toctree::
20
+   :glob:
21
+   :maxdepth: 1
22
+
23
+   specs/kilo/**
24
+
25
+Juno approved specs
26
+===================
27
+
28
+.. toctree::
29
+   :glob:
30
+   :maxdepth: 1
31
+
32
+   specs/juno/**
33
+
17 34
 ==================
18 35
 Indices and tables
19 36
 ==================

Loading…
Cancel
Save