summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBryan Strassner <bryan.strassner@gmail.com>2018-07-17 11:02:12 -0500
committerBryan Strassner <bryan.strassner@gmail.com>2018-07-17 14:01:31 -0500
commit43b300cdc5c007e11221009990a13696cf76d4fc (patch)
tree0fa9995d5846adc234aaf9984f8a2eccacccd78d
parentca404ab7998b573259ca83a59586898aadcd85e6 (diff)
Initial commit of specs repo
The airship-specs repo is for specifications that impact the components that are part of the airship project group. Change-Id: Ic72f970f211de95ee0c08616a3a43869270b6061
Notes
Notes (review): Code-Review+1: Felipe Monteiro <felipe.monteiro@att.com> Code-Review+2: Scott Hussey <sthussey@att.com> Code-Review+2: Mark Burnett <mark.m.burnett@gmail.com> Workflow+1: Mark Burnett <mark.m.burnett@gmail.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Mon, 23 Jul 2018 15:11:12 +0000 Reviewed-on: https://review.openstack.org/583294 Project: openstack/airship-specs Branch: refs/heads/master
-rw-r--r--.gitignore6
-rw-r--r--Makefile20
-rw-r--r--doc/source/_static/.gitkeep0
-rw-r--r--doc/source/conf.py155
-rw-r--r--doc/source/index.rst35
l---------doc/source/specs1
-rw-r--r--specs/approved/.gitkeep0
-rw-r--r--specs/implemented/.gitkeep0
-rw-r--r--specs/template.rst96
9 files changed, 313 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..218ae64
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,6 @@
1# Sphinx artifacts
2/doc/build/
3/doc/*/_static/
4!/doc/source/_static/
5/AUTHORS
6/ChangeLog
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..50bd7da
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,20 @@
1# Minimal makefile for Sphinx documentation
2#
3
4# You can set these variables from the command line.
5SPHINXOPTS = -a -E -W
6SPHINXBUILD = sphinx-build
7SPHINXPROJ = airship-specs
8SOURCEDIR = doc/source
9BUILDDIR = doc/build
10
11# Put it first so that "make" without argument is like "make help".
12help:
13 @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14
15.PHONY: help Makefile
16
17# Catch-all target: route all unknown targets to Sphinx using the new
18# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19%: Makefile
20 @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file
diff --git a/doc/source/_static/.gitkeep b/doc/source/_static/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/doc/source/_static/.gitkeep
diff --git a/doc/source/conf.py b/doc/source/conf.py
new file mode 100644
index 0000000..6bfbdef
--- /dev/null
+++ b/doc/source/conf.py
@@ -0,0 +1,155 @@
1# -*- coding: utf-8 -*-
2#
3# Configuration file for the Sphinx documentation builder.
4#
5# This file does only contain a selection of the most common options. For a
6# full list see the documentation:
7# http://www.sphinx-doc.org/en/master/config
8
9# -- Path setup --------------------------------------------------------------
10
11# If extensions (or modules to document with autodoc) are in another directory,
12# add these directories to sys.path here. If the directory is relative to the
13# documentation root, use os.path.abspath to make it absolute, like shown here.
14#
15# import os
16# import sys
17# sys.path.insert(0, os.path.abspath('.'))
18
19
20# -- Project information -----------------------------------------------------
21
22project = 'airship-specs'
23copyright = '2018, Airship Authors'
24author = 'Airship Authors'
25
26# The short X.Y version
27version = ''
28# The full version, including alpha/beta/rc tags
29release = '0.1.0'
30
31
32# -- General configuration ---------------------------------------------------
33
34# If your documentation needs a minimal Sphinx version, state it here.
35#
36# needs_sphinx = '1.0'
37
38# Add any Sphinx extension module names here, as strings. They can be
39# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40# ones.
41extensions = [
42]
43
44# Add any paths that contain templates here, relative to this directory.
45templates_path = ['_templates']
46
47# The suffix(es) of source filenames.
48# You can specify multiple suffix as a list of string:
49#
50# source_suffix = ['.rst', '.md']
51source_suffix = '.rst'
52
53# The master toctree document.
54master_doc = 'index'
55
56# The language for content autogenerated by Sphinx. Refer to documentation
57# for a list of supported languages.
58#
59# This is also used if you do content translation via gettext catalogs.
60# Usually you set "language" from the command line for these cases.
61language = None
62
63# List of patterns, relative to source directory, that match files and
64# directories to ignore when looking for source files.
65# This pattern also affects html_static_path and html_extra_path .
66exclude_patterns = []
67
68# The name of the Pygments (syntax highlighting) style to use.
69pygments_style = 'sphinx'
70
71
72# -- Options for HTML output -------------------------------------------------
73
74# The theme to use for HTML and HTML Help pages. See the documentation for
75# a list of builtin themes.
76#
77html_theme = 'alabaster'
78
79# Theme options are theme-specific and customize the look and feel of a theme
80# further. For a list of options available for each theme, see the
81# documentation.
82#
83# html_theme_options = {}
84
85# Add any paths that contain custom static files (such as style sheets) here,
86# relative to this directory. They are copied after the builtin static files,
87# so a file named "default.css" will overwrite the builtin "default.css".
88html_static_path = ['_static']
89
90# Custom sidebar templates, must be a dictionary that maps document names
91# to template names.
92#
93# The default sidebars (for documents that don't match any pattern) are
94# defined by theme itself. Builtin themes are using these templates by
95# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
96# 'searchbox.html']``.
97#
98# html_sidebars = {}
99
100
101# -- Options for HTMLHelp output ---------------------------------------------
102
103# Output file base name for HTML help builder.
104htmlhelp_basename = 'airship-specsdoc'
105
106
107# -- Options for LaTeX output ------------------------------------------------
108
109latex_elements = {
110 # The paper size ('letterpaper' or 'a4paper').
111 #
112 # 'papersize': 'letterpaper',
113
114 # The font size ('10pt', '11pt' or '12pt').
115 #
116 # 'pointsize': '10pt',
117
118 # Additional stuff for the LaTeX preamble.
119 #
120 # 'preamble': '',
121
122 # Latex figure (float) alignment
123 #
124 # 'figure_align': 'htbp',
125}
126
127# Grouping the document tree into LaTeX files. List of tuples
128# (source start file, target name, title,
129# author, documentclass [howto, manual, or own class]).
130latex_documents = [
131 (master_doc, 'airship-specs.tex', 'airship-specs Documentation',
132 'Airship Authors', 'manual'),
133]
134
135
136# -- Options for manual page output ------------------------------------------
137
138# One entry per manual page. List of tuples
139# (source start file, name, description, authors, manual section).
140man_pages = [
141 (master_doc, 'airship-specs', 'airship-specs Documentation',
142 [author], 1)
143]
144
145
146# -- Options for Texinfo output ----------------------------------------------
147
148# Grouping the document tree into Texinfo files. List of tuples
149# (source start file, target name, title, author,
150# dir menu entry, description, category)
151texinfo_documents = [
152 (master_doc, 'airship-specs', 'airship-specs Documentation',
153 author, 'airship-specs', 'One line description of project.',
154 'Miscellaneous'),
155] \ No newline at end of file
diff --git a/doc/source/index.rst b/doc/source/index.rst
new file mode 100644
index 0000000..213ab7c
--- /dev/null
+++ b/doc/source/index.rst
@@ -0,0 +1,35 @@
1.. airship-specs documentation master file, created by
2 sphinx-quickstart on Tue Jul 10 09:26:57 2018.
3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive.
5
6Airship Specs Documentation
7===========================
8
9Proposed Specs
10--------------
11
12.. toctree::
13 :maxdepth: 1
14 :glob:
15
16 specs/*
17
18Approved Specs
19--------------
20
21.. toctree::
22 :maxdepth: 1
23 :glob:
24
25 specs/approved/*
26
27Implemented Specs
28-----------------
29
30.. toctree::
31 :maxdepth: 1
32 :glob:
33
34 specs/implemented/*
35
diff --git a/doc/source/specs b/doc/source/specs
new file mode 120000
index 0000000..87a4030
--- /dev/null
+++ b/doc/source/specs
@@ -0,0 +1 @@
../../specs \ No newline at end of file
diff --git a/specs/approved/.gitkeep b/specs/approved/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/specs/approved/.gitkeep
diff --git a/specs/implemented/.gitkeep b/specs/implemented/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/specs/implemented/.gitkeep
diff --git a/specs/template.rst b/specs/template.rst
new file mode 100644
index 0000000..8b753f0
--- /dev/null
+++ b/specs/template.rst
@@ -0,0 +1,96 @@
1..
2 This work is licensed under a Creative Commons Attribution 3.0 Unported
3 License.
4
5 http://creativecommons.org/licenses/by/3.0/legalcode
6
7.. note::
8
9 Blueprints are written using ReSTructured text.
10
11=====================================
12Template: The title of your blueprint
13=====================================
14
15Introduction paragraph -- What is this blueprint about?
16
17Links
18=====
19
20Include pertinent links to where the work is being tracked (e.g. Storyboard),
21as well as any other foundational information that may lend clarity to this
22blueprint
23
24Problem description
25===================
26
27A detailed description of the problem being addressed or solved by this
28blueprint
29
30Impacted components
31===================
32
33List the Airship components that are impacted by this blueprint
34
35Proposed change
36===============
37
38Provide a detailed description of the change being proposed. Include how the
39problem will be addressed or solved.
40
41If this is an incremental part of a larger solution or effort, provide the
42specific scope of this blueprint, and how it fits into the overarching
43solution.
44
45Details of changes to specific Airship components should be specified in this
46section, as well as interaction between those components.
47
48Special attention should be given to interfaces between components. New
49interfaces shuld attempt to follow established patterns within Airship, or
50should be evaluated for suitability as new precedent.
51
52If this blueprint changes testing needs or approaches, that information
53should be disclosed here, and should be regarded as part of the deliverable
54related to this design.
55
56If this blueprint introduces new functionality that requires new kinds of
57documentation, or a change to the documentation processes, that information
58should be included in this section.
59
60Security impact
61---------------
62
63Details of any security-related concerns that this proposed change introduces
64or addresses.
65
66Performance impact
67------------------
68
69Analysis of performance changes that are introduced or addressed with this
70proposed design.
71
72Alternatives
73------------
74
75If other approaches were considered, include a summary of those here, and a
76short discussion of why the proposed approach is preferred.
77
78Implementation
79==============
80
81If known, include any information detailing assigned individuals, proposed
82milestones, intermediate deliverable products, and work items.
83
84If there are Assignee(s) or Work Items, use a sub-heading for that
85information.
86
87Dependencies
88============
89
90If there are any dependencies on other work, blueprints, or other things that
91impact the ability to deliver this solution, include that information here.
92
93References
94==========
95
96Any external references (other than the direct links above)