Browse Source

Create skeleton for restoring ha-guide content

This just sets up all the framework pieces to allow content to be added
back into the ha-guide.

Change-Id: I3b5a77407f9d91fe85d7749a6ec70870f75dc482
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
Sean McGinnis 7 months ago
parent
commit
34c59c7cb5
No account linked to committer's email address
9 changed files with 383 additions and 10 deletions
  1. 24
    0
      .gitignore
  2. 4
    0
      .gitreview
  3. 6
    0
      .zuul.yaml
  4. 176
    0
      LICENSE
  5. 78
    10
      README.rst
  6. 6
    0
      doc/requirements.txt
  7. 61
    0
      doc/source/conf.py
  8. 12
    0
      doc/source/index.rst
  9. 16
    0
      tox.ini

+ 24
- 0
.gitignore View File

@@ -0,0 +1,24 @@
1
+.DS_Store
2
+*.xpr
3
+
4
+# Packages
5
+.venv
6
+*.egg
7
+*.egg-info
8
+
9
+# Testenvironment
10
+.tox
11
+
12
+# Build directories
13
+doc/build
14
+
15
+# Transifex Client Setting
16
+.tx
17
+
18
+# Editors
19
+*~
20
+.*.swp
21
+.bak
22
+*.pyc
23
+
24
+doc/source/.doctrees

+ 4
- 0
.gitreview View File

@@ -0,0 +1,4 @@
1
+[gerrit]
2
+host=review.openstack.org
3
+port=29418
4
+project=openstack/ha-guide.git

+ 6
- 0
.zuul.yaml View File

@@ -0,0 +1,6 @@
1
+- project:
2
+    templates:
3
+      - build-openstack-docs-pti
4
+    post:
5
+      jobs:
6
+        - publish-openstack-tox-docs-direct

+ 176
- 0
LICENSE View File

@@ -0,0 +1,176 @@
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.
176
+

+ 78
- 10
README.rst View File

@@ -1,13 +1,81 @@
1
-This project is no longer maintained.
1
+=================================
2
+OpenStack High Availability Guide
3
+=================================
2 4
 
3
-The contents of this repository are still available in the Git
4
-source code management system.  To see the contents of this
5
-repository before it reached its end of life, please check out the
6
-previous commit with "git checkout HEAD^1".
5
+This repository contains the source files for the OpenStack High Availability
6
+Guide.
7 7
 
8
-The content has been merged into the openstack-manuals repository at
9
-http://git.openstack.org/cgit/openstack/openstack-manuals/
8
+You can read this guide at `docs.openstack.org/ha-guide
9
+<http://docs.openstack.org/ha-guide>`_.
10 10
 
11
-For any further questions, please email
12
-openstack-docs@lists.openstack.org or join #openstack-doc on
13
-Freenode.
11
+Prerequisites
12
+-------------
13
+
14
+At a minimum, you will need git and the git-review tool installed in order to
15
+contribute documentation. You will also need a `Gerrit account
16
+<https://docs.openstack.org/infra/manual/developers.html#account-setup>`_ to
17
+submit the change.
18
+
19
+Git is available for Linux, Mac, and Windows environments. Some platforms come
20
+with it preinstalled, but you can review the `installation instructions
21
+<https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_ if you
22
+do not have it by default.
23
+
24
+Once git is installed, you can follow the instructions for your platform to
25
+`install git-review <https://www.mediawiki.org/wiki/Gerrit/git-review>`_.
26
+
27
+The last step is to configure git with your name and email address used for
28
+your Gerrit account set up so it can link you patch to your user. Run the
29
+following to set these values:
30
+
31
+.. code-block:: console
32
+
33
+  git config --global user.name "First Last"
34
+  git config --global user.email "your_email@youremail.com"
35
+
36
+
37
+Submitting Updates
38
+------------------
39
+Proposing updates to the documentation is fairly straight forward once you've
40
+done it, but there are a few steps that can appear intimidating your first
41
+couple times through. Here is a suggested workflow to help you along the way.
42
+
43
+.. code-block:: console
44
+
45
+  git clone https://git.openstack.org/openstack/ha-guide
46
+  cd ha-guide
47
+  
48
+  # it is useful to make changes on a separate branch in case you need to make
49
+  # other changes
50
+  git checkout -b my-topic
51
+
52
+  # edit your files
53
+  git add .
54
+  git commit # Add a descriptive commit message
55
+
56
+  # submit your changes for review
57
+  git review
58
+
59
+The changes will then be run through a few tests to make sure the docs build
60
+and it will be ready for reviews. Once reviewed, if no problems are found with
61
+the changes they will be merged to the repo and the changes will be published
62
+to the docs.openstack.org site.
63
+
64
+Local Testing
65
+-------------
66
+If you would like to build the docs locally to make sure there are no issues
67
+with the changes, and to view locally generated HTML files, you will need to do
68
+a couple extra steps.
69
+
70
+The jobs are run using a tool called `tox`. You will need to install tox on
71
+your platform first following its `installation guide
72
+<https://tox.readthedocs.io/en/latest/install.html>`_.
73
+
74
+You can then run the following to perform a local build with some tests:
75
+
76
+.. code-block:: console
77
+
78
+  tox -e docs
79
+
80
+If you have any questions, please reach out on the #openstack-operators IRC
81
+channel or through the openstack-ops mailing list.

+ 6
- 0
doc/requirements.txt View File

@@ -0,0 +1,6 @@
1
+# The order of packages is significant, because pip processes them in the order
2
+# of appearance. Changing the order has an impact on the overall integration
3
+# process, which may cause wedges in the gate later.
4
+openstackdocstheme>=1.18.1 # Apache-2.0
5
+doc8>=0.6.0 # Apache-2.0
6
+sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD

+ 61
- 0
doc/source/conf.py View File

@@ -0,0 +1,61 @@
1
+# This file is execfile()d with the current directory set to its
2
+# containing dir.
3
+#
4
+# Note that not all possible configuration values are present in this
5
+# autogenerated file.
6
+#
7
+# All configuration values have a default; values that are commented out
8
+# serve to show the default.
9
+
10
+import os
11
+
12
+import openstackdocstheme
13
+
14
+# If extensions (or modules to document with autodoc) are in another directory,
15
+# add these directories to sys.path here. If the directory is relative to the
16
+# documentation root, use os.path.abspath to make it absolute, like shown here.
17
+# sys.path.insert(0, os.path.abspath('.'))
18
+
19
+# -- General configuration ------------------------------------------------
20
+
21
+# If your documentation needs a minimal Sphinx version, state it here.
22
+# needs_sphinx = '1.0'
23
+
24
+# Add any Sphinx extension module names here, as strings. They can be
25
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
26
+# ones.
27
+extensions = ['openstackdocstheme']
28
+
29
+# The master toctree document.
30
+master_doc = 'index'
31
+
32
+# General information about the project.
33
+repository_name = "openstack/ha-guide"
34
+bug_project = 'openstack-manuals'
35
+project = u'High Availability Guide'
36
+bug_tag = u'ha-guide'
37
+copyright = u'2016-present, OpenStack contributors'
38
+
39
+# -- Options for HTML output ----------------------------------------------
40
+
41
+# The theme to use for HTML and HTML Help pages.  See the documentation for
42
+# a list of builtin themes.
43
+html_theme = 'openstackdocs'
44
+
45
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
46
+# using the given strftime format.
47
+# So that we can enable "log-a-bug" links from each output HTML page, this
48
+# variable must be set to a format that includes year, month, day, hours and
49
+# minutes.
50
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
51
+
52
+# Grouping the document tree into LaTeX files. List of tuples
53
+# (source start file, target name, title,
54
+#  author, documentclass [howto, manual, or own class]).
55
+latex_documents = [
56
+    ('index', 'HAGuide.tex', u'HA Guide',
57
+     u'OpenStack contributors', 'manual'),
58
+]
59
+
60
+# -- Options for Internationalization output ------------------------------
61
+locale_dirs = ['locale/']

+ 12
- 0
doc/source/index.rst View File

@@ -0,0 +1,12 @@
1
+=================================
2
+OpenStack High Availability Guide
3
+=================================
4
+
5
+Abstract
6
+~~~~~~~~
7
+
8
+This guide provides information about configuring OpenStack services for high
9
+availability.
10
+
11
+This is a placeholder while we migrate information over from another repo.
12
+

+ 16
- 0
tox.ini View File

@@ -0,0 +1,16 @@
1
+[tox]
2
+minversion = 2.0
3
+skipsdist = True
4
+envlist = docs
5
+
6
+[testenv]
7
+basepython = python3
8
+setenv = VIRTUAL_ENV={envdir}
9
+passenv = *_proxy *_PROXY ZUUL_*
10
+
11
+[testenv:docs]
12
+deps =
13
+  -r{toxinidir}/doc/requirements.txt
14
+commands =
15
+  doc8 doc/source -e txt -e rst
16
+  sphinx-build -E -W -b html doc/source doc/build/html

Loading…
Cancel
Save