You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@labs.apache.org by ad...@apache.org on 2014/07/19 04:54:57 UTC
svn commit: r1611842 - in /labs/panopticon/pan-commands/docs/source: ./
reference/commands/ reference/install/
Author: adc
Date: Sat Jul 19 02:54:56 2014
New Revision: 1611842
URL: http://svn.apache.org/r1611842
Log:
Installation instructions.
Added:
labs/panopticon/pan-commands/docs/source/reference/commands/sebb.en.rst
labs/panopticon/pan-commands/docs/source/reference/install/
labs/panopticon/pan-commands/docs/source/reference/install/commands.en.rst
labs/panopticon/pan-commands/docs/source/reference/install/index.en.rst
- copied, changed from r1611251, labs/panopticon/pan-commands/docs/source/index.rst
labs/panopticon/pan-commands/docs/source/reference/install/web_site.en.rst
- copied, changed from r1611251, labs/panopticon/pan-commands/docs/source/index.rst
Modified:
labs/panopticon/pan-commands/docs/source/index.rst
labs/panopticon/pan-commands/docs/source/reference/commands/common_arguments.en.rst
labs/panopticon/pan-commands/docs/source/reference/commands/index.en.rst
Modified: labs/panopticon/pan-commands/docs/source/index.rst
URL: http://svn.apache.org/viewvc/labs/panopticon/pan-commands/docs/source/index.rst?rev=1611842&r1=1611841&r2=1611842&view=diff
==============================================================================
--- labs/panopticon/pan-commands/docs/source/index.rst (original)
+++ labs/panopticon/pan-commands/docs/source/index.rst Sat Jul 19 02:54:56 2014
@@ -1,6 +1,3 @@
-Apache Panopticon
-=================
-
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -18,7 +15,10 @@ Apache Panopticon
specific language governing permissions and limitations
under the License.
-Apache Panopticon⢠is web UI and command-line scripts for tracking/managing
+Apache Panopticon
+=================
+
+**Apache Panopticon** is web UI and command-line scripts for tracking/managing
ASF projects and Incubator podlings based on Python and Flask.
.. toctree::
@@ -26,6 +26,7 @@ ASF projects and Incubator podlings base
reference/commands/index.en
reference/api/index.en
+ reference/install/index.en
Indices and tables
Modified: labs/panopticon/pan-commands/docs/source/reference/commands/common_arguments.en.rst
URL: http://svn.apache.org/viewvc/labs/panopticon/pan-commands/docs/source/reference/commands/common_arguments.en.rst?rev=1611842&r1=1611841&r2=1611842&view=diff
==============================================================================
--- labs/panopticon/pan-commands/docs/source/reference/commands/common_arguments.en.rst (original)
+++ labs/panopticon/pan-commands/docs/source/reference/commands/common_arguments.en.rst Sat Jul 19 02:54:56 2014
@@ -22,7 +22,8 @@ Arguments common to all utilities
Description
===========
-All Apache Panopticon utilities share a set of common command-line arguments::
+All **Apache Panopticon** utilities share a set of common command-line
+arguments::
-h, --help show this help message and exit
--completion SHELL Print out shell completion script: bash, zsh
@@ -64,7 +65,7 @@ All Apache Panopticon utilities share a
Using & Managing Your Keystore
==============================
-The Apache Panopticon command-line scripts all allow for the use of local
+The **Apache Panopticon** command-line scripts all allow for the use of local
keystore so that the user does not have to constantly enter in the username
and password.
@@ -74,5 +75,5 @@ the environmental variable ``PANOPTICON_
.. envvar:: PANOPTICON_DISABLE_KEYSTORE
- If set, the Apache Panopticon command-line scripts will not store the user's
- username and password to the local keystore.
+ If set, the **Apache Panopticon** command-line scripts will not store the
+ user's username and password to the local keystore.
Modified: labs/panopticon/pan-commands/docs/source/reference/commands/index.en.rst
URL: http://svn.apache.org/viewvc/labs/panopticon/pan-commands/docs/source/reference/commands/index.en.rst?rev=1611842&r1=1611841&r2=1611842&view=diff
==============================================================================
--- labs/panopticon/pan-commands/docs/source/reference/commands/index.en.rst (original)
+++ labs/panopticon/pan-commands/docs/source/reference/commands/index.en.rst Sat Jul 19 02:54:56 2014
@@ -22,4 +22,5 @@ Command Reference
:maxdepth: 1
moderator.en
+ sebb.en
common_arguments.en
Added: labs/panopticon/pan-commands/docs/source/reference/commands/sebb.en.rst
URL: http://svn.apache.org/viewvc/labs/panopticon/pan-commands/docs/source/reference/commands/sebb.en.rst?rev=1611842&view=auto
==============================================================================
--- labs/panopticon/pan-commands/docs/source/reference/commands/sebb.en.rst (added)
+++ labs/panopticon/pan-commands/docs/source/reference/commands/sebb.en.rst Sat Jul 19 02:54:56 2014
@@ -0,0 +1,125 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you 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.
+
+========
+``sebb``
+========
+
+Synopsis
+========
+
+A tool used to create, vet, and publish project releases from the command line::
+
+ usage: sebb [-h] [--debug] [--trace] [--log LOG] [--username USERNAME]
+ [--password PASSWORD] [--clear-store]
+ {verify,create,projects,publish} ...
+
+ A tool used to create, vet, and publish project releases from the command line.
+
+ positional arguments:
+ {verify,create,projects,publish}
+
+ optional arguments:
+ -h, --help show this help message and exit
+ --debug Turn on debug mode / logging.
+ --trace Turn on trace logging. Implies --debug.
+ --log LOG Log file destination. Defaults to stdout only.
+ --username USERNAME Username
+ --password PASSWORD Password
+ --clear-store Clear password keystore
+
+Description
+===========
+
+:program:`sebb` is used to create, vet, and publish project releases from the command line.
+
+The sub-commands for :program:`sebb` are:
+
+``create``
+==========
+
+List the available ASF mailing lists. This is restricted to public mailing
+lists unless the user happens to be an ASF member, in which case private
+mailing lists are included. If the user happens to be an ASF committer then
+the set of private mailing lists for those projects to which the committer
+belongs are also included.
+
+.. option:: project
+
+The project to release. When this is supplied then members of that mailing
+list email addresses are are listed. Moderators are marked with an asterisk
+at the end of their email address. This option is only available for ASF
+members or users who happen to be moderators of that mailing list.
+
+``verify``
+==========
+
+Lookup information of an ASF committer. The ``lookup`` subcommand lists the
+following information:
+
+* whether the person looked up is an ASF member
+* email aliases register to the person
+* projects that the person belongs to
+* incubator podlings that the person may be mentoring
+* PMCs that the person may be a member of. If that person is a chair of that PMC then that PMC will marked with an asterisk at the end
+
+The list of a person's email aliases are withheld if the user is not an ASF
+member or is not the same person as the user.
+
+.. option:: email_alias
+
+The email alias to lookup.
+
+.. option:: -t, --type
+
+Restrict output to information of a specific type. Allowed
+values: ``username``, ``podlings``, ``pmcs``, ``member``, ``fullname``, ``emails``, ``projects``
+
+``publish``
+===========
+
+Add an email address to a specific mailing list. Only mailing list moderators
+can add an email address to their own mailing list. ASF members can add an
+email address to any mailing list.
+
+.. option:: mailing_list
+
+The mailing list to add the email address to.
+
+.. option:: email_address
+
+The email address to add.
+
+.. option:: -m, --moderator
+
+Email address is for moderator
+
+``projects``
+============
+
+List the projects for which the ``sebb`` command can be used. This sub-command
+can be used for shell completion.
+
+Examples
+========
+
+Manage the mailing list for ``dev@httpd.apache.org``::
+
+ $ moderator lookup president@whitehouse.gov
+ $ moderator list dev@httpd.apache.org
+ $ moderator add dev@httpd.apache.org president@whitehouse.gov -m
+ $ moderator remove dev@httpd.apache.org jschaefer@apache.org
Added: labs/panopticon/pan-commands/docs/source/reference/install/commands.en.rst
URL: http://svn.apache.org/viewvc/labs/panopticon/pan-commands/docs/source/reference/install/commands.en.rst?rev=1611842&view=auto
==============================================================================
--- labs/panopticon/pan-commands/docs/source/reference/install/commands.en.rst (added)
+++ labs/panopticon/pan-commands/docs/source/reference/install/commands.en.rst Sat Jul 19 02:54:56 2014
@@ -0,0 +1,42 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you 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.
+
+Installing Commands
+===================
+
+The **Apache Panopticon** commands are written in Python and organized to be
+installed using ``setup.py`` and ``pip``. Because **Apache Panopticon** is
+still in `Apache Labs <http://labs.apache.org/>`_, it cannot perform releases
+and one cannot install it using only ``pip``. This document assumes a good knowledge of Python.
+
+.. note:: Until **Apache Panopticon** leaves Apache Labs, it is a good idea to use `virtualenvs <http://docs.python-guide.org/en/latest/dev/virtualenvs/>`_.
+
+Checkout a copy of **Apache Panopticon**: ::
+
+ $ svn co http://svn.apache.org/repos/asf/labs/panopticon
+
+Install the **Apache Panopticon** Python utilities: ::
+
+ $ cd panopticon/pan-utils
+ $ pip install -r requirements.txt
+ $ ./setup.py install
+
+Install the **Apache Panopticon** commands: ::
+
+ $ cd ../pan-commands
+ $ pip install -r requirements.txt
+ $ ./setup.py install
Copied: labs/panopticon/pan-commands/docs/source/reference/install/index.en.rst (from r1611251, labs/panopticon/pan-commands/docs/source/index.rst)
URL: http://svn.apache.org/viewvc/labs/panopticon/pan-commands/docs/source/reference/install/index.en.rst?p2=labs/panopticon/pan-commands/docs/source/reference/install/index.en.rst&p1=labs/panopticon/pan-commands/docs/source/index.rst&r1=1611251&r2=1611842&rev=1611842&view=diff
==============================================================================
--- labs/panopticon/pan-commands/docs/source/index.rst (original)
+++ labs/panopticon/pan-commands/docs/source/reference/install/index.en.rst Sat Jul 19 02:54:56 2014
@@ -1,6 +1,3 @@
-Apache Panopticon
-=================
-
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -18,20 +15,11 @@ Apache Panopticon
specific language governing permissions and limitations
under the License.
-Apache Panopticon⢠is web UI and command-line scripts for tracking/managing
-ASF projects and Incubator podlings based on Python and Flask.
+Installing Apache Panopticon
+============================
.. toctree::
:maxdepth: 1
- reference/commands/index.en
- reference/api/index.en
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
+ commands.en
+ web_site.en
Copied: labs/panopticon/pan-commands/docs/source/reference/install/web_site.en.rst (from r1611251, labs/panopticon/pan-commands/docs/source/index.rst)
URL: http://svn.apache.org/viewvc/labs/panopticon/pan-commands/docs/source/reference/install/web_site.en.rst?p2=labs/panopticon/pan-commands/docs/source/reference/install/web_site.en.rst&p1=labs/panopticon/pan-commands/docs/source/index.rst&r1=1611251&r2=1611842&rev=1611842&view=diff
==============================================================================
--- labs/panopticon/pan-commands/docs/source/index.rst (original)
+++ labs/panopticon/pan-commands/docs/source/reference/install/web_site.en.rst Sat Jul 19 02:54:56 2014
@@ -1,6 +1,3 @@
-Apache Panopticon
-=================
-
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -18,20 +15,6 @@ Apache Panopticon
specific language governing permissions and limitations
under the License.
-Apache Panopticon⢠is web UI and command-line scripts for tracking/managing
-ASF projects and Incubator podlings based on Python and Flask.
-
-.. toctree::
- :maxdepth: 1
-
- reference/commands/index.en
- reference/api/index.en
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+Installing the Web Site
+=======================
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@labs.apache.org
For additional commands, e-mail: commits-help@labs.apache.org