Merge lp:~cjohnston/summit/adding-tons-of-docs into lp:summit

Proposed by Chris Johnston
Status: Merged
Approved by: Chris Johnston
Approved revision: 400
Merged at revision: 399
Proposed branch: lp:~cjohnston/summit/adding-tons-of-docs
Merge into: lp:summit
Diff against target: 922 lines (+754/-24)
10 files modified
dev-docs/Makefile (+153/-0)
dev-docs/conf.py (+242/-0)
dev-docs/index.rst (+22/-0)
dev-docs/installing.rst (+151/-0)
docs/index.rst (+6/-2)
docs/lead.rst (+2/-2)
docs/running.rst (+146/-0)
docs/scheduler.rst (+15/-3)
docs/scheduling.rst (+10/-10)
docs/using.rst (+7/-7)
To merge this branch: bzr merge lp:~cjohnston/summit/adding-tons-of-docs
Reviewer Review Type Date Requested Status
Chris Johnston Approve
Review via email: mp+105593@code.launchpad.net

Commit message

adding more docs

To post a comment you must log in.
Revision history for this message
Chris Johnston (cjohnston) :
review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== added directory 'dev-docs'
2=== added file 'dev-docs/Makefile'
3--- dev-docs/Makefile 1970-01-01 00:00:00 +0000
4+++ dev-docs/Makefile 2012-05-14 01:12:18 +0000
5@@ -0,0 +1,153 @@
6+# Makefile for Sphinx documentation
7+#
8+
9+# You can set these variables from the command line.
10+SPHINXOPTS =
11+SPHINXBUILD = sphinx-build
12+PAPER =
13+BUILDDIR = _build
14+
15+# Internal variables.
16+PAPEROPT_a4 = -D latex_paper_size=a4
17+PAPEROPT_letter = -D latex_paper_size=letter
18+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
19+# the i18n builder cannot share the environment and doctrees with the others
20+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
21+
22+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
23+
24+help:
25+ @echo "Please use \`make <target>' where <target> is one of"
26+ @echo " html to make standalone HTML files"
27+ @echo " dirhtml to make HTML files named index.html in directories"
28+ @echo " singlehtml to make a single large HTML file"
29+ @echo " pickle to make pickle files"
30+ @echo " json to make JSON files"
31+ @echo " htmlhelp to make HTML files and a HTML help project"
32+ @echo " qthelp to make HTML files and a qthelp project"
33+ @echo " devhelp to make HTML files and a Devhelp project"
34+ @echo " epub to make an epub"
35+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
37+ @echo " text to make text files"
38+ @echo " man to make manual pages"
39+ @echo " texinfo to make Texinfo files"
40+ @echo " info to make Texinfo files and run them through makeinfo"
41+ @echo " gettext to make PO message catalogs"
42+ @echo " changes to make an overview of all changed/added/deprecated items"
43+ @echo " linkcheck to check all external links for integrity"
44+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
45+
46+clean:
47+ -rm -rf $(BUILDDIR)/*
48+
49+html:
50+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
51+ @echo
52+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
53+
54+dirhtml:
55+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
56+ @echo
57+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
58+
59+singlehtml:
60+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
61+ @echo
62+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
63+
64+pickle:
65+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
66+ @echo
67+ @echo "Build finished; now you can process the pickle files."
68+
69+json:
70+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
71+ @echo
72+ @echo "Build finished; now you can process the JSON files."
73+
74+htmlhelp:
75+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
76+ @echo
77+ @echo "Build finished; now you can run HTML Help Workshop with the" \
78+ ".hhp project file in $(BUILDDIR)/htmlhelp."
79+
80+qthelp:
81+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
82+ @echo
83+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
84+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
85+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SummitSchedulerDeveloper.qhcp"
86+ @echo "To view the help file:"
87+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SummitSchedulerDeveloper.qhc"
88+
89+devhelp:
90+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
91+ @echo
92+ @echo "Build finished."
93+ @echo "To view the help file:"
94+ @echo "# mkdir -p $$HOME/.local/share/devhelp/SummitSchedulerDeveloper"
95+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SummitSchedulerDeveloper"
96+ @echo "# devhelp"
97+
98+epub:
99+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
100+ @echo
101+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
102+
103+latex:
104+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
105+ @echo
106+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
107+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
108+ "(use \`make latexpdf' here to do that automatically)."
109+
110+latexpdf:
111+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
112+ @echo "Running LaTeX files through pdflatex..."
113+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
114+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
115+
116+text:
117+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
118+ @echo
119+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
120+
121+man:
122+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
123+ @echo
124+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
125+
126+texinfo:
127+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
128+ @echo
129+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
130+ @echo "Run \`make' in that directory to run these through makeinfo" \
131+ "(use \`make info' here to do that automatically)."
132+
133+info:
134+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
135+ @echo "Running Texinfo files through makeinfo..."
136+ make -C $(BUILDDIR)/texinfo info
137+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
138+
139+gettext:
140+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
141+ @echo
142+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
143+
144+changes:
145+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
146+ @echo
147+ @echo "The overview file is in $(BUILDDIR)/changes."
148+
149+linkcheck:
150+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
151+ @echo
152+ @echo "Link check complete; look for any errors in the above output " \
153+ "or in $(BUILDDIR)/linkcheck/output.txt."
154+
155+doctest:
156+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
157+ @echo "Testing of doctests in the sources finished, look at the " \
158+ "results in $(BUILDDIR)/doctest/output.txt."
159
160=== added directory 'dev-docs/_build'
161=== added directory 'dev-docs/_static'
162=== added directory 'dev-docs/_templates'
163=== added file 'dev-docs/conf.py'
164--- dev-docs/conf.py 1970-01-01 00:00:00 +0000
165+++ dev-docs/conf.py 2012-05-14 01:12:18 +0000
166@@ -0,0 +1,242 @@
167+# -*- coding: utf-8 -*-
168+#
169+# Summit Scheduler Developer documentation build configuration file, created by
170+# sphinx-quickstart on Fri May 11 15:57:16 2012.
171+#
172+# This file is execfile()d with the current directory set to its containing dir.
173+#
174+# Note that not all possible configuration values are present in this
175+# autogenerated file.
176+#
177+# All configuration values have a default; values that are commented out
178+# serve to show the default.
179+
180+import sys, os
181+
182+# If extensions (or modules to document with autodoc) are in another directory,
183+# add these directories to sys.path here. If the directory is relative to the
184+# documentation root, use os.path.abspath to make it absolute, like shown here.
185+#sys.path.insert(0, os.path.abspath('.'))
186+
187+# -- General configuration -----------------------------------------------------
188+
189+# If your documentation needs a minimal Sphinx version, state it here.
190+#needs_sphinx = '1.0'
191+
192+# Add any Sphinx extension module names here, as strings. They can be extensions
193+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
194+extensions = []
195+
196+# Add any paths that contain templates here, relative to this directory.
197+templates_path = ['_templates']
198+
199+# The suffix of source filenames.
200+source_suffix = '.rst'
201+
202+# The encoding of source files.
203+#source_encoding = 'utf-8-sig'
204+
205+# The master toctree document.
206+master_doc = 'index'
207+
208+# General information about the project.
209+project = u'Summit Scheduler Developer'
210+copyright = u'2012, Chris Johnston'
211+
212+# The version info for the project you're documenting, acts as replacement for
213+# |version| and |release|, also used in various other places throughout the
214+# built documents.
215+#
216+# The short X.Y version.
217+version = '1.x'
218+# The full version, including alpha/beta/rc tags.
219+release = '1.x'
220+
221+# The language for content autogenerated by Sphinx. Refer to documentation
222+# for a list of supported languages.
223+#language = None
224+
225+# There are two options for replacing |today|: either, you set today to some
226+# non-false value, then it is used:
227+#today = ''
228+# Else, today_fmt is used as the format for a strftime call.
229+#today_fmt = '%B %d, %Y'
230+
231+# List of patterns, relative to source directory, that match files and
232+# directories to ignore when looking for source files.
233+exclude_patterns = ['_build']
234+
235+# The reST default role (used for this markup: `text`) to use for all documents.
236+#default_role = None
237+
238+# If true, '()' will be appended to :func: etc. cross-reference text.
239+#add_function_parentheses = True
240+
241+# If true, the current module name will be prepended to all description
242+# unit titles (such as .. function::).
243+#add_module_names = True
244+
245+# If true, sectionauthor and moduleauthor directives will be shown in the
246+# output. They are ignored by default.
247+#show_authors = False
248+
249+# The name of the Pygments (syntax highlighting) style to use.
250+pygments_style = 'sphinx'
251+
252+# A list of ignored prefixes for module index sorting.
253+#modindex_common_prefix = []
254+
255+
256+# -- Options for HTML output ---------------------------------------------------
257+
258+# The theme to use for HTML and HTML Help pages. See the documentation for
259+# a list of builtin themes.
260+html_theme = 'default'
261+
262+# Theme options are theme-specific and customize the look and feel of a theme
263+# further. For a list of options available for each theme, see the
264+# documentation.
265+#html_theme_options = {}
266+
267+# Add any paths that contain custom themes here, relative to this directory.
268+#html_theme_path = []
269+
270+# The name for this set of Sphinx documents. If None, it defaults to
271+# "<project> v<release> documentation".
272+#html_title = None
273+
274+# A shorter title for the navigation bar. Default is the same as html_title.
275+#html_short_title = None
276+
277+# The name of an image file (relative to this directory) to place at the top
278+# of the sidebar.
279+#html_logo = None
280+
281+# The name of an image file (within the static path) to use as favicon of the
282+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
283+# pixels large.
284+#html_favicon = None
285+
286+# Add any paths that contain custom static files (such as style sheets) here,
287+# relative to this directory. They are copied after the builtin static files,
288+# so a file named "default.css" will overwrite the builtin "default.css".
289+html_static_path = ['_static']
290+
291+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
292+# using the given strftime format.
293+#html_last_updated_fmt = '%b %d, %Y'
294+
295+# If true, SmartyPants will be used to convert quotes and dashes to
296+# typographically correct entities.
297+#html_use_smartypants = True
298+
299+# Custom sidebar templates, maps document names to template names.
300+#html_sidebars = {}
301+
302+# Additional templates that should be rendered to pages, maps page names to
303+# template names.
304+#html_additional_pages = {}
305+
306+# If false, no module index is generated.
307+#html_domain_indices = True
308+
309+# If false, no index is generated.
310+#html_use_index = True
311+
312+# If true, the index is split into individual pages for each letter.
313+#html_split_index = False
314+
315+# If true, links to the reST sources are added to the pages.
316+#html_show_sourcelink = True
317+
318+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
319+#html_show_sphinx = True
320+
321+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
322+#html_show_copyright = True
323+
324+# If true, an OpenSearch description file will be output, and all pages will
325+# contain a <link> tag referring to it. The value of this option must be the
326+# base URL from which the finished HTML is served.
327+#html_use_opensearch = ''
328+
329+# This is the file name suffix for HTML files (e.g. ".xhtml").
330+#html_file_suffix = None
331+
332+# Output file base name for HTML help builder.
333+htmlhelp_basename = 'SummitSchedulerDeveloperdoc'
334+
335+
336+# -- Options for LaTeX output --------------------------------------------------
337+
338+latex_elements = {
339+# The paper size ('letterpaper' or 'a4paper').
340+#'papersize': 'letterpaper',
341+
342+# The font size ('10pt', '11pt' or '12pt').
343+#'pointsize': '10pt',
344+
345+# Additional stuff for the LaTeX preamble.
346+#'preamble': '',
347+}
348+
349+# Grouping the document tree into LaTeX files. List of tuples
350+# (source start file, target name, title, author, documentclass [howto/manual]).
351+latex_documents = [
352+ ('index', 'SummitSchedulerDeveloper.tex', u'Summit Scheduler Developer Documentation',
353+ u'Chris Johnston', 'manual'),
354+]
355+
356+# The name of an image file (relative to this directory) to place at the top of
357+# the title page.
358+#latex_logo = None
359+
360+# For "manual" documents, if this is true, then toplevel headings are parts,
361+# not chapters.
362+#latex_use_parts = False
363+
364+# If true, show page references after internal links.
365+#latex_show_pagerefs = False
366+
367+# If true, show URL addresses after external links.
368+#latex_show_urls = False
369+
370+# Documents to append as an appendix to all manuals.
371+#latex_appendices = []
372+
373+# If false, no module index is generated.
374+#latex_domain_indices = True
375+
376+
377+# -- Options for manual page output --------------------------------------------
378+
379+# One entry per manual page. List of tuples
380+# (source start file, name, description, authors, manual section).
381+man_pages = [
382+ ('index', 'summitschedulerdeveloper', u'Summit Scheduler Developer Documentation',
383+ [u'Chris Johnston'], 1)
384+]
385+
386+# If true, show URL addresses after external links.
387+#man_show_urls = False
388+
389+
390+# -- Options for Texinfo output ------------------------------------------------
391+
392+# Grouping the document tree into Texinfo files. List of tuples
393+# (source start file, target name, title, author,
394+# dir menu entry, description, category)
395+texinfo_documents = [
396+ ('index', 'SummitSchedulerDeveloper', u'Summit Scheduler Developer Documentation',
397+ u'Chris Johnston', 'SummitSchedulerDeveloper', 'One line description of project.',
398+ 'Miscellaneous'),
399+]
400+
401+# Documents to append as an appendix to all manuals.
402+#texinfo_appendices = []
403+
404+# If false, no module index is generated.
405+#texinfo_domain_indices = True
406+
407+# How to display URL addresses: 'footnote', 'no', or 'inline'.
408+#texinfo_show_urls = 'footnote'
409
410=== added file 'dev-docs/index.rst'
411--- dev-docs/index.rst 1970-01-01 00:00:00 +0000
412+++ dev-docs/index.rst 2012-05-14 01:12:18 +0000
413@@ -0,0 +1,22 @@
414+.. Summit Scheduler Developer documentation master file, created by
415+ sphinx-quickstart on Fri May 11 15:57:16 2012.
416+ You can adapt this file completely to your liking, but it should at least
417+ contain the root `toctree` directive.
418+
419+Welcome to Summit Scheduler Developer's documentation!
420+======================================================
421+
422+Contents:
423+
424+.. toctree::
425+ :maxdepth: 2
426+
427+
428+
429+Indices and tables
430+==================
431+
432+* :ref:`genindex`
433+* :ref:`modindex`
434+* :ref:`search`
435+
436
437=== added file 'dev-docs/installing.rst'
438--- dev-docs/installing.rst 1970-01-01 00:00:00 +0000
439+++ dev-docs/installing.rst 2012-05-14 01:12:18 +0000
440@@ -0,0 +1,151 @@
441+==================
442+Installing Summit
443+==================
444+
445+Before you start hacking on summit, you need to first setup your environment.
446+We're going to set it up without breaking anything else in your current.
447+
448+
449+Requirements
450+------------
451+To get started, you'll need:
452+ * Python 2.6 (greater than 2.6.1)
453+ * virtualenv
454+
455+virtualenv
456+~~~~~~~~~~
457+`virtualenv <http://pypi.python.org/pypi/virtualenv>`_ is a tool to create
458+isolated Python environments. We don't want to install packages system-wide
459+because that can create quite a mess. The following command will install the
460+required development files on Ubuntu or, if you're running a recent version,
461+you can `install them automatically <apt:python-virtualenv>`_::
462+
463+ sudo apt-get install python-virtualenv
464+
465+virtualenv is the only Python package you need to install system-wide.
466+Everything else goes in a virtual environment.
467+
468+virtualenvwrapper
469+~~~~~~~~~~~~~~~~~
470+
471+`virtualenvwrapper <http://www.doughellmann.com/docs/virtualenvwrapper/>`_
472+is a set of shell functions that make virtualenv easy to work with.
473+
474+For Ubuntu Maverick Meerkat and above, `install virtualenvwrapper via apt
475+<apt:virtualenvwrapper>`_::
476+
477+ sudo apt-get install virtualenvwrapper
478+
479+Once installed, ``exec bash`` and you're set to start!
480+
481+For earlier releases, install it like this::
482+
483+ wget http://bitbucket.org/dhellmann/virtualenvwrapper/raw/f31869779141/virtualenvwrapper_bashrc -O ~/.virtualenvwrapper
484+ mkdir ~/.virtualenvs
485+
486+Then put these lines in your ``~/.bashrc``::
487+
488+ export WORKON_HOME=$HOME/.virtualenvs
489+ source $HOME/.virtualenvwrapper
490+
491+``exec bash`` and you're set.
492+
493+.. note:: If you didn't have a ``.bashrc`` already, you should make a
494+ ``~/.profile`` too::
495+
496+ echo 'source $HOME/.bashrc' >> ~/.profile
497+
498+Grab the source
499+---------------
500+
501+Create the bzr environment for summit with::
502+
503+ bzr init-repo summit
504+ cd summit
505+ bzr branch lp:summit trunk
506+ bzr branch trunk myfeaturex
507+ cd myfeaturex
508+
509+From now on, you can simply `cd trunk && bzr pull` when you want to update your
510+trunk.
511+
512+Getting Packages
513+----------------
514+
515+Now we're ready to go, so create an environment for summit::
516+
517+ mkvirtualenv --no-site-packages summit
518+
519+That creates a clean environment named summit. You can get out of the
520+environment by restarting your shell or calling ``deactivate``.
521+
522+To get back into the summit environment later, type::
523+
524+ workon summit # requires virtualenvwrapper
525+
526+.. note:: If you want to use a different Python binary, pass the path to
527+ mkvirtualenv with ``--python``::
528+
529+ mkvirtualenv --python=/usr/bin/python2.6 --no-site-packages summit
530+
531+Finish the install
532+~~~~~~~~~~~~~~~~~~
533+
534+From inside your activated virtualenv, run::
535+
536+ pip install -r requirements.txt
537+
538+pip installs all the dependencies with the exact revisions as our production
539+environment.
540+
541+
542+Settings
543+--------
544+
545+Most of summit is already configured in ``ubuntu_settings.py``, ``linaro_settings.py`` and ``settings.py``, but there's some
546+things you need to configure locally. All your local settings go into
547+``local_settings.py``. Just copy ``local_settings.py.sample`` to create
548+``local_settings.py`` and everything should run fine.
549+
550+Get themes
551+----------
552+
553+Get setup for the themes for Ubuntu and Linaro::
554+
555+ ./manage.py init-summit
556+ ./manage.py pullapps
557+
558+Database
559+--------
560+
561+Let Django sync up the database schema for you and run the migrations::
562+
563+ ./manage.py syncdb
564+ ./manage.py migrate
565+
566+Run the Server
567+--------------
568+
569+If you've gotten the system requirements, downloaded the source code, set up
570+your virtualenv, and configured your settings and database, you're good to go.
571+Summit is now split into two different 'sites,' Ubuntu and Linaro. You will
572+need to call the proper settings for the site you wish to run.
573+To run the server::
574+
575+ python manage.py runserver --settings ubuntu_settings
576+ python maange.py runserver --settings linaro_settings
577+
578+Contact
579+-------
580+
581+Come talk to us on irc://irc.freenode.net/#ubuntu-website if you have questions,
582+issues, or compliments.
583+
584+Testing
585+-------
586+
587+The quick way to run summit's tests::
588+
589+ ./manage.py test
590+
591+Make sure to write tests for all new code your write and all the tests pass.
592
593=== modified file 'docs/index.rst'
594--- docs/index.rst 2012-04-27 15:12:58 +0000
595+++ docs/index.rst 2012-05-14 01:12:18 +0000
596@@ -4,13 +4,17 @@
597 contain the root `toctree` directive.
598
599 Welcome to The Summit Scheduler documentation!
600-==================================
601+==============================================
602+
603+The Summit Scheduler is a highly agile scheduling solution for conferences. Built originally for use at Ubuntu Developer Summits, the Summit Scheduler is now also used by Linaro at Linaro Connect and at the Linux Plumbers Conference.
604+
605+If you are interested in using the Summit Scheduler at your conference, please contact Chris Johnston <chrisjohnston@ubuntu.com>.
606
607 Contents:
608
609 .. toctree::
610- :numbered:
611
612+ running
613 using
614 scheduling
615 lead
616
617=== modified file 'docs/lead.rst'
618--- docs/lead.rst 2012-02-29 13:35:15 +0000
619+++ docs/lead.rst 2012-05-14 01:12:18 +0000
620@@ -1,6 +1,6 @@
621-==================
622+======================
623 Track Lead Permissions
624-==================
625+======================
626
627 **Managing Meeting Proposals**
628
629
630=== added file 'docs/running.rst'
631--- docs/running.rst 1970-01-01 00:00:00 +0000
632+++ docs/running.rst 2012-05-14 01:12:18 +0000
633@@ -0,0 +1,146 @@
634+==================
635+Running a Summit
636+==================
637+
638+----------------
639+Create a Summit
640+----------------
641+
642+In the Summit Scheduler
643+-----------------------
644+
645+**Name**
646+
647+This field will become the URL of the summit. May only contain lowercase letters, numbers and hyphens.
648+
649+**Title**
650+
651+The display name of your summit. May contain uppercase and lowercase letters and numbers.
652+
653+**Description**
654+
655+A description of the event. You may use markdown styling.
656+
657+**Etherpad**
658+
659+The Summit Scheduler uses etherpad for taking notes during meetings. Please provide the base URL for the etherpad instance you would like to use.
660+
661+**QR**
662+
663+If your summit has a mobile application to display the schedule, you may enter the URL to the QR image here.
664+
665+**Hashtag**
666+
667+This is useful if you wish to display a twitter feed of a certain hashtag on the Summit page.
668+
669+**State**
670+
671+ * Sponsorship Requests - During this state users will be able to apply for sponsorship to the summit event.
672+ * Sponsorship Reviews - This status will turn off the ability for users to request sponsorship to your summit and turn on the ability for a defined group of users to review the sponsorship requests and vote on them.
673+ * Scheduling - This status is what should be used prior to and during the summit. It will give users the ability to propose new meetings and mark themselves as attending meetings.
674+ * Public - This status should be set after the event is over. This will prevent users from being able to create new meetings and remove other features that are used prior to and during a summit.
675+
676+**Help**
677+
678+This field is used for displaying a message across the bottom of each page. Markdown styling is supported.
679+
680+**Sites**
681+
682+The Summit Scheduler is capable of running multiple different sites off of one code base while appearing to be completely seperate sites. This field is what defines which site the summit will appear on. Multiple selections are allowed for co-hosted events.
683+
684+**Managers**
685+
686+This field allows you to define users who will have manager permissions. For more information on the permissions given to a manager, view the Summit Scheduler Permissions page.
687+
688+**Schedulers**
689+
690+This field allows you to define users who are allowed to have scheduler permissions. For more information on the permissions given to a scheduler, view the Summit Scheduler Permissions page.
691+
692+**Tracks**
693+
694+ * Title - The display title of your track.
695+ * Slug - The track slug may contain lowercase letters, numbers, and hyphens.
696+ * Color - Adding a color allows for an obvious differentiation between different tracks.
697+ * Description - A brief description of the track. This field supports markdown styling.
698+ * Allow adjacent sessions - By default, the Summit Scheduler does not allow two sessions from the same track to be scheduled in the same room. This is to encourage participants to get up, move around, and have more interaction with other participants. If you would like to allow the Summit Scheduler to have sessions from the same track back to back in the same room, check this box.
699+ * Delete - Check this box if you want to delete an already created track
700+
701+**Sprint**
702+
703+Add the export URL for the Launchpad sprint that was created for this event.
704+
705+In Launchpad
706+------------
707+
708+------
709+Rooms
710+------
711+
712+**Name**
713+
714+Name of the room. May contain lowercase letters and numbers.
715+
716+**Title**
717+
718+Display title of the room. May contain uppercase and lowercase letters, numbers and spaces.
719+
720+**Type**
721+
722+ * Openly Scheduled - May contain any meeting other than a plenary.
723+ * Plenary Events - May contain only plenaries.
724+ * Closed - Room that will not be used.
725+ * Private - A private room that is not displayed to people without the correct permissions or attendees to private meetings in the room.
726+
727+**Size**
728+
729+The number of people the room can hold.
730+
731+**Tracks**
732+
733+You are able to set the room up so that only certain tracks will be scheduled in the room. This is helpful for special setups for things like hacking sessions.
734+
735+**Icecast URL**
736+
737+This can be the URL to any type of audio or audio video link. Ex. Icecast, Google Hangouts
738+
739+**IRC Channel**
740+
741+The IRC channel name without the hash (#).
742+
743+**Has Dial In**
744+
745+If this room has dial in capabilities, meetings that require dial in will be scheduled here.
746+
747+**Availability**
748+
749+General starting and ending availability of the room. Must be entered in UTC time.
750+
751+**Busy**
752+
753+Used to set certain time periods throughout the sprint in which this room is not available.
754+
755+------------
756+Track Leads
757+------------
758+
759+-------
760+Slots
761+-------
762+
763+------
764+Crew
765+------
766+
767+----------------
768+Crons
769+----------------
770+
771+**Auto Schedule**
772+
773+**Reschedule**
774+
775+**Dead blueprints**
776+
777+----------------
778+Track Lead
779+----------------
780
781=== modified file 'docs/scheduler.rst'
782--- docs/scheduler.rst 2012-02-29 13:35:15 +0000
783+++ docs/scheduler.rst 2012-05-14 01:12:18 +0000
784@@ -1,5 +1,17 @@
785-==================
786-Scheduler Permissions
787-==================
788+============================
789+Summit Scheduler Permissions
790+============================
791
792 Coming Soon!
793+
794+----------------
795+Scheduler
796+----------------
797+
798+----------------
799+Manager
800+----------------
801+
802+----------------
803+Track Lead
804+----------------
805
806=== modified file 'docs/scheduling.rst'
807--- docs/scheduling.rst 2012-05-05 00:48:19 +0000
808+++ docs/scheduling.rst 2012-05-14 01:12:18 +0000
809@@ -1,14 +1,14 @@
810-==================
811+====================
812 Scheduling a Meeting
813-==================
814+====================
815
816 You have two options to schedule a meeting.
817
818 You can either create a meeting in Summit or by using a blueprint in Launchpad.
819
820-------------------
821+----------------------------
822 Creating a Meeting in Summit
823-------------------
824+----------------------------
825
826 Creating a meeting in Summit is now easier than ever. All you need to do is fill out a simple form and the meeting will be created and scheduled for you automaticaly.
827
828@@ -16,20 +16,20 @@
829
830 .. _video: http://www.youtube.com/watch?v=Jr25brEMOuA
831
832-------------------
833+--------------------------------
834 Creating a Meeting in Launchpad
835-------------------
836+--------------------------------
837
838 If you've already defined a blueprint that needs discussing you can register it. You can also create one from scratch.
839
840 Using an Existing Engineering Blueprint
841----------------
842+-------------------------------------------
843
844 If your blueprint can fit into a single session, this is the route to choose. After creating your blueprint you may select the "Propose for sprint" option when viewing the blueprint in Launchpad.
845
846
847 Creating a "Scheduling Blueprint"
848----------------
849+------------------------------------
850
851 If your engineering blueprint is too big for a single session, you can break it up by using multiple "scheduling blueprints".
852
853@@ -54,7 +54,7 @@
854 The video is old so ignore the beginning about the wiki and just pay attention to the part where Jorge talks about Launchpad.
855
856 Filling Out the Blueprint Fields
857---------------
858+-----------------------------------
859
860 The following are fields on the "Register a blueprint" page.
861
862@@ -106,7 +106,7 @@
863 If your blueprint is not on the schedule during the week before the summit, please ask your track lead to approve it. If they don't have it then it means you didn't submit it to the correct sprint (see the video). Track leads will be approving specs on a regular basis, so if you don't see your meetings on the schedule it's up to YOU to bother the track lead.
864
865 Ubuntu Developer Summit
866----------------
867+-----------------------
868
869 Jono Bacon and Michael Hall keep an eye on the incoming specs for UDS, so if a track lead is particularly swamped we help keep the submissions going smoothly, but it helps tremendously when you check.
870
871
872=== modified file 'docs/using.rst'
873--- docs/using.rst 2012-02-29 13:14:51 +0000
874+++ docs/using.rst 2012-05-14 01:12:18 +0000
875@@ -1,18 +1,18 @@
876-==================
877+==========================
878 Using The Summit Scheduler
879-==================
880+==========================
881
882 The Summit Scheduler is a web tool utilized at Ubuntu Developer Summit and Linaro Connect.
883
884 Registering to Attend a Summit
885-==========
886+==============================
887 In order to use Summit for your personal schedule, you will need to register in Launchpad as attending the summit. To do this, click the "Register in Launchpad" link on the main page for the summit.
888
889 *Note*: Once you register, it may take up to 20 minutes for you to be able to use Summit.
890
891
892 Signing up to Attend a Meeting
893-==========
894+==============================
895 After you have registered yourself as attending a Summit, you have the ability to "attend meetings." Signing yourself up to attend meetings will create your own personal schedule.
896
897 To sign up to attend a meeting you have 2 options:
898@@ -32,14 +32,14 @@
899 To subscribe to a meeting in Summit, click on the meeting name and you will be sent to the meeting page. In the navigation near the top, you will see a link called ""Attend this meeting." Shortly after clicking this link, the meeting will show up in your personal schedule.
900
901 Agenda View
902-==========
903+===========
904
905 When you are logged into Summit, the agenda view will show your personal schedule. All of the meetings have a star infront of the name of the meeting. If this star is grey you are not subscribed to the meeting. If the star is gold, you are subscribed.
906
907 If you mouseover the meeting name, you will see the details about the meeting. This includes the meeting description, participants, and tracks. Any participants with a red star next to their name are "Participation essential."
908
909 Wide Screen View
910-==========
911+================
912
913 The Wide Screen View is the traditional schedule view. This view is no longer recommended for use on personal computers.
914
915@@ -51,6 +51,6 @@
916 The Track View will show you all of the meetings for a particular track.
917
918 Room View
919-==========
920+=========
921
922 The Room View will show you all of the meetings for a particular room.

Subscribers

People subscribed via source and target branches