Merge lp:~summit-hackers/summit/user-manual into lp:summit

Proposed by Chris Johnston
Status: Merged
Approved by: Michael Hall
Approved revision: 300
Merged at revision: 297
Proposed branch: lp:~summit-hackers/summit/user-manual
Merge into: lp:summit
Diff against target: 214 lines (+184/-0)
5 files modified
docs/index.rst (+4/-0)
docs/lead.rst (+18/-0)
docs/scheduler.rst (+5/-0)
docs/scheduling.rst (+101/-0)
docs/using.rst (+56/-0)
To merge this branch: bzr merge lp:~summit-hackers/summit/user-manual
Reviewer Review Type Date Requested Status
Michael Hall (community) Approve
Review via email: mp+95171@code.launchpad.net

Commit message

Begins adding docs on using summit

To post a comment you must log in.
Revision history for this message
Michael Hall (mhall119) wrote :

I'm not really concerned with code reviews for documentation, if you want to just land this kind of thing yourself that'd be okay by me.

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'docs/index.rst'
2--- docs/index.rst 2012-01-23 01:18:55 +0000
3+++ docs/index.rst 2012-02-29 13:38:17 +0000
4@@ -11,6 +11,10 @@
5 .. toctree::
6 :numbered:
7
8+ using
9+ scheduling
10+ lead
11+ scheduler
12 installing
13 credits
14
15
16=== added file 'docs/lead.rst'
17--- docs/lead.rst 1970-01-01 00:00:00 +0000
18+++ docs/lead.rst 2012-02-29 13:38:17 +0000
19@@ -0,0 +1,18 @@
20+==================
21+Track Lead Permissions
22+==================
23+
24+**Managing Meeting Proposals**
25+
26+The track leads are responsible for accepting or rejecting proposals. As a track lead, you need to visit the list of blueprints for the upcoming summit to approve or decline blueprints that have been proposed to meetings.
27+
28+You should see a sentence before the footer like:
29+
30+You can show topics that have been declined and since you are a driver of Linaro Connect Q4.11 you can also accept meetings or topics that have been proposed.
31+All the track leads should have this authority. If you don't, you'll need to speak to the correct person in your organization.
32+
33+The accept/reject interface is self-explanatory.
34+
35+**Tips**
36+
37+If you like a proposal but want some updates to it, don't reject it. Its easier to tell the person to make the updates and then check back and accept it.
38
39=== added file 'docs/scheduler.rst'
40--- docs/scheduler.rst 1970-01-01 00:00:00 +0000
41+++ docs/scheduler.rst 2012-02-29 13:38:17 +0000
42@@ -0,0 +1,5 @@
43+==================
44+Scheduler Permissions
45+==================
46+
47+Coming Soon!
48
49=== added file 'docs/scheduling.rst'
50--- docs/scheduling.rst 1970-01-01 00:00:00 +0000
51+++ docs/scheduling.rst 2012-02-29 13:38:17 +0000
52@@ -0,0 +1,101 @@
53+==================
54+Scheduling a Meeting
55+==================
56+
57+You have two options to schedule a meeting. If you've already defined a blueprint that needs discussing you can register it. You can also create one from scratch.
58+
59+Using an Existing Engineering Blueprint
60+---------------
61+
62+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.
63+
64+
65+Creating a "Scheduling Blueprint"
66+---------------
67+
68+If your engineering blueprint is too big for a single session, you can break it up by using multiple "scheduling blueprints".
69+
70+To create a scheduling blueprint, you need to visit the sprint page in Launchpad. You will find a link to this page on the main page for the Summit you are attending.
71+
72+Prior to creating a blueprint, first view the blueprints proposed to see if one matches the topic you want to discuss.
73+
74+If none of the existing blueprints match your topic, you may register a new Blueprint by selecting the "Register a blueprint."
75+
76+When creating a blueprint, please use the naming convention below. Keep in mind that the name of a blueprint is very important as it affects how your meeting will appear in the scheduling tool at UDS.
77+
78+The format is either:
79+
80+* ubuntu-<cycle>-<track>-<topic>
81+* linaro-<track>-<cycle>-<topic>
82+
83+Further information on this topic can be found at:
84+
85+https://lists.ubuntu.com/archives/ubuntu-devel/2011-March/032813.html
86+http://ubuntudevelopers.blip.tv/file/3539348/
87+The video is old so ignore the beginning about the wiki and just pay attention to the part where Jorge talks about Launchpad.
88+
89+Filling Out the Blueprint Fields
90+--------------
91+
92+The following are fields on the "Register a blueprint" page.
93+
94+**For**
95+
96+When registering a blueprint for UDS, the project will be "ubuntu."
97+
98+**Name**
99+
100+The name is important as it determines how your meeting will appear in the scheduling tool at UDS, here are the track names:
101+
102+consumer community design desktop foundations hardware security serverandcloud ubuntu-arm
103+
104+You need to name your blueprint after the track name, and the title, and then the animal letter so that we can track it for this cycle:
105+
106+hardware-p-kernel-decision serverandcloud-p-openstack-integration design-p-wallpapers foundations-p-python-transition
107+
108+... and so on.
109+
110+**Title**
111+
112+This should be a human readable form of the name. Remember that your title will be displayed on the monitors, and need to be short and upfront, so make it easy to understand and put the information up front so that when the scheduler truncates your long title it makes sense.
113+
114+**Specification**
115+
116+Optional, but it can be a link to a page in this Wiki, but it's becoming popular to put your meeting notes from etherpad here, so:
117+
118+http://pad.ubuntu.com/serverandcloud-p-openstack-integration
119+
120+Don't worry, the system will autocreate your etherpad during UDS.
121+
122+What Happens Next
123+==============
124+
125+After you submit the blueprint, it will wait for approval by a track lead. Once it has been approved it will show up on the summit schedule:
126+
127+* http://summit.ubuntu.com/
128+* http://summit.linaro.org/
129+
130+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.
131+
132+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.
133+
134+If anyone has any questions please contact Michael Hall.
135+
136+Tips
137+---------
138+
139+**Meeting Title**
140+
141+The title of the blueprint is important. We have screens setup at our events displaying the meetings for the day at various locations. For example:
142+
143+http://summit.linaro.org/uds-o/2011-05-11/
144+
145+A long title will be cut off on the display, however in your browser, you can hover and get the full title. This is not possible on the hallway screens and you will only be able to see the truncated text on the screens. Therefore, it becomes important to make sure the most important words show up near the beginning of your title.
146+
147+**Whiteboard**
148+
149+The etherpad document will most likely get used to collect notes for a meeting. This creates a small dilemma when you need to put work items in and make it a real "engineering blueprint". The recommended approach to dealing with this is to copy the contents of the notes from etherpad and paste them into the whiteboard.
150+
151+**Before Creating a Blueprint**
152+
153+Its a good idea to talk to the track lead before drafting a proposal and see if they like the idea.
154
155=== added file 'docs/using.rst'
156--- docs/using.rst 1970-01-01 00:00:00 +0000
157+++ docs/using.rst 2012-02-29 13:38:17 +0000
158@@ -0,0 +1,56 @@
159+==================
160+Using The Summit Scheduler
161+==================
162+
163+The Summit Scheduler is a web tool utilized at Ubuntu Developer Summit and Linaro Connect.
164+
165+Registering to Attend a Summit
166+==========
167+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.
168+
169+*Note*: Once you register, it may take up to 20 minutes for you to be able to use Summit.
170+
171+
172+Signing up to Attend a Meeting
173+==========
174+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.
175+
176+To sign up to attend a meeting you have 2 options:
177+
178+**Subscribe to the blueprint**
179+
180+If a meeting has a blueprint, you can subscribe yourself to the blueprint which will mark you as attending the meeting. Subscribing to a blueprint will also notify you each time that the blueprint is changed. Sign up this way if you are interested in following the progress of the topic after the summit is over.
181+
182+When subscribing to the blueprint there is the ability to mark yourself as "Participation essential." By doing this, the Summit Scheduler will attempt to make the meeting at a time in which you are available.
183+
184+*Note: Please only subscribe to a blueprint as Participation essential if your participation truely is essential.*
185+
186+**Subscribe to the meeting in Summit**
187+
188+If you do not want to follow the progress of the topic after the summit is over, or if the meeting does not have a blueprint,ou will want to subscribe to the meeting in Summit. Signing up this way will still add the meeting to your personal calendar, however you will not get emails after the summit when the blueprint changes.
189+
190+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.
191+
192+Agenda View
193+==========
194+
195+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.
196+
197+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."
198+
199+Wide Screen View
200+==========
201+
202+The Wide Screen View is the traditional schedule view. This view is no longer recommended for use on personal computers.
203+
204+The Wide Screen View is the primary view for the monitors around the halls of the summit for reference when moving between meetings.
205+
206+Track View
207+==========
208+
209+The Track View will show you all of the meetings for a particular track.
210+
211+Room View
212+==========
213+
214+The Room View will show you all of the meetings for a particular room.

Subscribers

People subscribed via source and target branches