summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorElizabeth Elwell <e.r.elwell@gmail.com>2016-08-17 14:23:51 +0100
committerElizabeth Elwell <e.r.elwell@gmail.com>2016-08-17 14:45:19 +0100
commitc457a0e9d84c6c7265cf033290eebb260a6c9e02 (patch)
treefcc441fce342470eeb93c10b9842c1d6f0d63181
parent4549ae61e2ed19659c3d641ebd37ebdf12eb4d7f (diff)
Added documentation for eslint-config-openstack
Added documentation to include release guidelines. Change-Id: I2c2cd929283868dac415f986f541d0ec5741ef17
Notes
Notes (review): Code-Review+2: Michael Krotscheck <krotscheck@gmail.com> Workflow+1: Michael Krotscheck <krotscheck@gmail.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Fri, 02 Sep 2016 14:02:43 +0000 Reviewed-on: https://review.openstack.org/356473 Project: openstack/eslint-config-openstack Branch: refs/heads/master
-rwxr-xr-xdoc/source/conf.py75
-rw-r--r--doc/source/contributing.rst73
-rw-r--r--doc/source/index.rst25
-rw-r--r--doc/source/installation.rst14
-rw-r--r--doc/source/readme.rst1
-rw-r--r--doc/source/releasing.rst26
6 files changed, 214 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
new file mode 100755
index 0000000..f886053
--- /dev/null
+++ b/doc/source/conf.py
@@ -0,0 +1,75 @@
1# -*- coding: utf-8 -*-
2# Licensed under the Apache License, Version 2.0 (the "License");
3# you may not use this file except in compliance with the License.
4# You may obtain a copy of the License at
5#
6# http://www.apache.org/licenses/LICENSE-2.0
7#
8# Unless required by applicable law or agreed to in writing, software
9# distributed under the License is distributed on an "AS IS" BASIS,
10# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11# implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15import os
16import sys
17
18sys.path.insert(0, os.path.abspath('../..'))
19# -- General configuration ----------------------------------------------------
20
21# Add any Sphinx extension module names here, as strings. They can be
22# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
23extensions = [
24 'sphinx.ext.autodoc',
25 #'sphinx.ext.intersphinx',
26 'oslosphinx'
27]
28
29# autodoc generation is a bit aggressive and a nuisance when doing heavy
30# text edit cycles.
31# execute "export SPHINX_DEBUG=1" in your terminal to disable
32
33# The suffix of source filenames.
34source_suffix = '.rst'
35
36# The master toctree document.
37master_doc = 'index'
38
39# General information about the project.
40project = u'eslint-config-openstack'
41copyright = u'2016, OpenStack Foundation'
42
43# If true, '()' will be appended to :func: etc. cross-reference text.
44add_function_parentheses = True
45
46# If true, the current module name will be prepended to all description
47# unit titles (such as .. function::).
48add_module_names = True
49
50# The name of the Pygments (syntax highlighting) style to use.
51pygments_style = 'sphinx'
52
53# -- Options for HTML output --------------------------------------------------
54
55# The theme to use for HTML and HTML Help pages. Major themes that come with
56# Sphinx are currently 'default' and 'sphinxdoc'.
57# html_theme_path = ["."]
58# html_theme = '_theme'
59# html_static_path = ['static']
60
61# Output file base name for HTML help builder.
62htmlhelp_basename = '%sdoc' % project
63
64# Grouping the document tree into LaTeX files. List of tuples
65# (source start file, target name, title, author, documentclass
66# [howto/manual]).
67latex_documents = [
68 ('index',
69 '%s.tex' % project,
70 u'%s Documentation' % project,
71 u'OpenStack Foundation', 'manual'),
72]
73
74# Example configuration for intersphinx: refer to the Python standard library.
75#intersphinx_mapping = {'http://docs.python.org/': None}
diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
new file mode 100644
index 0000000..147c5a9
--- /dev/null
+++ b/doc/source/contributing.rst
@@ -0,0 +1,73 @@
1.. _contributing:
2
3=======================================
4Contributing to eslint-config-openstack
5=======================================
6
7If you're interested in contributing to the eslint-config-openstack
8project, the following will help get you started.
9
10Contributor License Agreement
11-----------------------------
12
13.. index::
14 single: license; agreement
15
16In order to contribute to the project, you need to have
17signed OpenStack's contributor's agreement.
18
19.. seealso::
20
21 * http://docs.openstack.org/infra/manual/developers.html
22 * http://wiki.openstack.org/CLA
23
24LaunchPad Project
25-----------------
26
27Most of the tools used for OpenStack depend on a launchpad.net ID for
28authentication.
29
30.. seealso::
31
32 * https://launchpad.net
33 * https://launchpad.net/eslint-config-openstack
34
35Project Hosting Details
36-------------------------
37
38Mailing list (prefix subjects with ``[eslint-config-openstack]`` for faster responses)
39 http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
40
41Code Hosting
42 https://github.com/openstack/eslint-config-openstack
43
44Code Review
45 https://review.openstack.org/#/q/status:open+project:openstack/eslint-config-openstack,n,z
46
47Rules only land with consensus
48------------------------------
49
50Patches that activate, deactivate, or modify rules, should only be merged if a consensus of
51reviewers is reached. In this case, consensus means at least five positive votes (+1 or +2),
52with no -1 votes. Cores may not override and/or ignore -1 votes.
53
54Library upgrades require two cores
55----------------------------------
56
57Patches that upgrade eslint only require two core approvers to land. These patches must add new
58upstream rules in a deactivated state, and delete any deprecated rules.
59
60Policy upgrades require all cores
61---------------------------------
62
63Updates to policies and governance on this project require +2 votes from all direct cores on the
64project. Core votes from the parent OpenStack QA project are optional.
65
66Patches should be abandoned after a month of inactivity
67-------------------------------------------------------
68
69Cores should attempt to keep the list of extant patches small and managable. As such, they should
70talk to any author whose patch has failed to garner the necessary support, and has experienced
71one month of inactivity. Reasonable notice should be given to the author before a patch is
72abandoned.
73
diff --git a/doc/source/index.rst b/doc/source/index.rst
new file mode 100644
index 0000000..a584bcb
--- /dev/null
+++ b/doc/source/index.rst
@@ -0,0 +1,25 @@
1===========================================================
2Welcome to eslint-config-openstack developer documentation!
3===========================================================
4
5Introduction
6============
7
8OpenStack has a set of style guidelines for clarity. OpenStack is a very large
9code base, spanning dozens of git trees, with over a thousand developers contributing
10every 6 months. As such, common style helps developers understand code in reviews,
11move between projects smoothly, and overall make the code more maintainable.
12
13Even though eslint permits overriding rules on a per-project basis, it should be
14the goal of every project to stay as close to the common guidelines as possible.
15
16Administrator's Guide
17=====================
18
19.. toctree::
20 :maxdepth: 1
21
22 Introduction to eslint-config-openstack <readme>
23 Installing eslint-config-openstack in your project <installation>
24 Contributing to eslint-config-openstack <contributing>
25 Releasing a version of eslint-config-openstack <releasing>
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
new file mode 100644
index 0000000..fc06f9d
--- /dev/null
+++ b/doc/source/installation.rst
@@ -0,0 +1,14 @@
1.. _installation:
2
3==================================================
4Installing eslint-config-openstack in your project
5==================================================
6
7To add these rules to your project, follow these steps.
8
91. Install the npm package to your project:
10
11 `npm install --save-dev eslint eslint-config-openstack`
12
132. Add `extends: "openstack"` to your `.eslintrc` yaml file.
14 If your project is using ES2015, add `extends: "openstack/es2015"` instead.
diff --git a/doc/source/readme.rst b/doc/source/readme.rst
new file mode 100644
index 0000000..a6210d3
--- /dev/null
+++ b/doc/source/readme.rst
@@ -0,0 +1 @@
.. include:: ../../README.rst
diff --git a/doc/source/releasing.rst b/doc/source/releasing.rst
new file mode 100644
index 0000000..6f24f0f
--- /dev/null
+++ b/doc/source/releasing.rst
@@ -0,0 +1,26 @@
1======================================
2How to release eslint-config-openstack
3======================================
4
5Only follow these steps if you have authority to release a version of eslint-config-openstack.
6
71. Ensure that you have gpg set up locally.
8 If you do not currently have gog installed:
9
10 `brew install gpg gpg2`
11
12 Set up your gpg key:
13
14 https://wiki.openstack.org/wiki/Oslo/ReleaseProcess#Setting_Up_GPG
15
162. `git pull --ff-only`
17
183. `git tag -s <version number>`
19
204. `git push gerrit <version number>`
21
22 Git won’t have a remote named gerrit until the first time git-review runs.
23 You may need to run git review -s before the push.
24
25For more information see:
26http://docs.openstack.org/infra/manual/drivers.html#tagging-a-release \ No newline at end of file