update-website-spec
|
Size: 6112
Comment:
|
← Revision 22 as of 2011-12-04 18:19:41 ⇥
Size: 7741
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| * '''Launchpad Entry''': UbuntuSpec:update-website * '''Created''': <<Date(2005-10-25T15:45:54Z)>> * '''Contributors''': |
* '''Launchpad Entry''': UbuntuSpec:other-p-ubuntustudio-update-website * '''Created''': <<Date(2011-09-06T20:45:54Z)>> * '''Contributors''': ScottLavender |
| Line 5: | Line 5: |
||<tablestyle="float:right; font-size: 0.9em; width:25%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;"><<TableOfContents>>|| |
|
| Line 8: | Line 10: |
| This specification describes the way we would like Ubuntu specifications to be written. It takes the form of a specification itself. | This specification describes the development of an updated and improved Ubuntu Studio website (ubuntustudio.org). |
| Line 12: | Line 14: |
| As we develop new ideas for features in Ubuntu, it's important to be able to communicate them clearly. This serves the purpose of making it clear what the feature is about, and allowing people to evolve an implementation strategy for it. | The Ubuntu Studio website has not been updated in many years and is suffering some bitrot. An updated theme would improve the aesthetics of the website. |
| Line 14: | Line 16: |
| Publishing this content gives our community a chance to participate in the discussion and design of a feature, and increases the chance that community members will feel confident enough to start work on the implementation of the feature. | Additional pages are desired to improve user experience and support. |
| Line 16: | Line 18: |
| A good specification also allows community members who were not physically present at meetings discussing a topic to participate in the implementation of the spec. Bottom line: the better your spec, the better the chances that your ideas will be clearly understood by the review team. |
Furthermore, providing a more functional website improves Ubuntu Studio's presence on the web. |
| Line 22: | Line 22: |
| * Bob is the maintainer for the boot process for Ubuntu. In the Dapper cycle, he would like to work on getting the boot time down to two seconds from boot manager to GDM screen. He creates an entry for the specification in Launchpad, proposes it for the UBZ sprint, and starts writing out a braindump of it in the Ubuntu wiki. Magnus, who is in charge of UBZ scheduling, thinks it sounds fishy but approves it to make sure that the change is discussed and documented properly. He marks it as priority Medium because he isn't sure Bob will have time free for implementing it during Dapper. | === Primary === * download iso image, either current release or LTS version * learn about ubuntu studio (i.e. what is it and do i want to use it?) * learn how to contribute to ubuntu studio |
| Line 24: | Line 27: |
| * Pedro works on Malone, in Launchpad. Before UBZ, he remembers that the dependency handling in the bug tracker is really not optimal. He writes out a Summary and Rationale in a Launchpad wiki page, registers it as a specification in Launchpad, and suggests it for UBZ. Monica, Launchpad manageress, thinks that this is really not the time to be talking about it and rejects the application for UBZ. He then indicates it for the next conference, UBB, and marks its priority is Low. * Jason is an Ubuntu and Rosetta user. He has noticed that changes made to translations are making their way into language packs but not to the upstream versions, and adds a specification that describes a way for getting upstream to use language packs. Monica also has a plan for this but hadn't described it in a spec, so she adds it to the UBZ spec list, and adds Carlos, Rosetta maintainer, as drafter for it. |
=== Secondary === * news feed (with rss) * to learn about current design work (i.e. what we are trying to do now but haven't released yet) * to find tutorials, work flows, and instructions (could be wiki pages, videos, or even individual's blog posts) * to get help (forums, irc, wiki pages, mailing lists) |
| Line 30: | Line 35: |
| This specification covers feature specifications for Ubuntu and Launchpad. It is not meant as a more general specification format. | This specification covers creating a new website theme, deploying the theme via ubuntustudio-dev website launchpad branch, and develop content on the website. |
| Line 34: | Line 39: |
| A specification should be built with the following considerations: | Website Platform: We have decided to use Wordpress. |
| Line 36: | Line 42: |
| * The person implementing it may not be the person writing it. It should be clear enough for someone to be able to read it and have a clear path towards implementing it. If it doesn't, it needs more detail. * That the use cases covered in the specification should be practical situations, not contrived issues. * Limitations and issues discovered during the creation of a specification should be clearly pointed out so that they can be dealt with explicitly. * If you don't know enough to be able to competently write a spec, you should either get help or research the problem further. Avoid spending time making up a solution: base yourself on your peers' opinions and prior work. * Specifications should be written in clear, concise and correct English. If you're not a native speaker, co-editing the spec with somebody who is might be a good idea. Specific issues related to particular sections are described further below. === Summary === The summary should not attempt to say '''why''' the spec is being defined, just '''what''' is being specified. === Rationale === This should be the description of '''why''' this spec is being defined. === Scope and Use Cases === While not always required, but in many cases they bring much better clarity to the scope and scale of the specification than could be obtained by talking in abstract terms. ==== Use Cases ==== Use cases are positive statements which (loosely) conform to a pattern like * A person and their role * The objective they want to achieve * The steps they go through * The positive result Specifically, describing the current unsatisfactory state of affairs is not a use case; that belongs in the Rationale section. === Implementation Plan === This section is usually broken down into subsections, such as the packages being affected, data and system migration where necessary, user interface requirements and pictures (photographs of drawings on paper work well). |
|
| Line 77: | Line 45: |
| To implement a specification, the assignee should observe the use cases carefully, and follow the design specified. He should make note of places in which he has strayed from the design section, adding rationale describing why this happened. This is important so that next iterations of this specification (and new specifications that touch upon this subject) can use the specification as a reference. | === Development === A development website has been created and design/content will need to be created by the website team. It will be refined through peer/team review. |
| Line 79: | Line 48: |
| The implementation is very dependent on the type of feature to be implemented. Refer to the team leader for further suggestions and guidance on this topic. | We should try to complete as much design and content as possible before it is moved (by -security or RT or whoever) to the staging tree. === Launchpad Branch === Once the demo site is approved then the appropriate code would need to be pushed to the website bzr branch hosted in Launchpad. A Ubuntu Stduio website team has been created to control access to the bzr code. == Website Content == === Home Page === The home page will include, in general top -> down, left -> right flow: '''nav bar''' - links to home, news, (contributor's) blog, download, tutorials (aka wiki), support, contribute (to development), feedback '''slide show''' - show overview of ubuntu studio and general use cases; (1) overview of ubuntu studio plus gpl/linux/floss info, (2) audio, (3) graphic design, (4) video, (5) photography '''download button''' - in same vertical space as slide show but to the right of it (but also above the feature tour button), make it stand out as this is a primary reason people come to website, make it easy for them to see it!, make it appreciably big, use different color than rest of page and different than feature tour perhaps, label button "Download ISO" might still include the "release notes" and "installation guide" links between buttons '''feature tour''' - in the same vertical space as slide show but to the right of it (but also below the download button), make it stand out as this is a primary reason people come to website, make it easy for them to see it!, make it appreciably big, , use different color than rest of page and different than download perhaps, label button "Take the Feature Tour" or "Learn More About Ubuntu Studio" or similar '''project description''' - leave it as is, choosing to go with the simple, uncluttered aesthetic for the home page devoid of "wall-o-text" news items '''search''' - located at the top of the of the column to the right of the news/blog area and below the entire slide show area '''social''' - replace current article tags with social ticker as article tags might be better located on the news and designer blog pages, located in the column to the right of the news/blog area and below the search box, include social icons at the top of the ticker NOT SURE IF WE ARE USING THIS An example image knocked up in Inkscape: {{attachment:website-clean-2.png}} Notice how the vertical spacing is more optimized in this overlay image: {{attachment:website-overlay-1.png}} Full size .svg file: [[attachment:website-clean-original.svg]] smaller .svg file: [[attachment:website-clean-smaller.svg]] === News === typical news page with rss feed and search box meant for formal announcements mainly. do we include contributor blog posts here as well? is there a way to include both but have the blog items look different than the news ones? === Blog === place for contributors to blog about development, mentioning current development or possible considerations for upcoming development. not currently considered for a blog aggregation, but could be === Download === linked to by navbar and button on front page have a large, prominent area for "recommended release", will link DIRECTLY to images for i386 ISO, amd64 ISO, i386 torrent, and amd64 torrent, this section should be new user friendly and capture the eye somehow links should be included for "how to burn an ISO", "release notes", and "installation guide" "how to burn an ISO" and "installation guide" might be static links located in the right sidebar "release notes" might be located directly with "recommended release" links we can show the latest release (if not the current) and the LTS version as links to the cdimage page also === Tutorials === also known as "wiki" currently this probably should link to help.ubuntu.com/ubuntustudio help page in the future we can try to use a different css and pull the information directly from the h.u.c pages link edubuntu and kbuntu currently do for ubuntu studio pages === Support === description of the different forms of help and maybe mention timeliness of each include the following links: * ubuntu studio forum on ubuntuforums.org - http://ubuntuforums.org/forumdisplay.php?f=335 * IRC - freenode #ubuntustudio and #ubuntustudio-devel * email - ubuntu-studio-users@lists.ubuntu.com and ubuntu-studio-devel@lists.ubuntu.com * === Contribute === list and description of the ways to help contribute to ubuntu studio include link to "contribute to develop" wiki page - https://wiki.ubuntu.com/UbuntuStudio/ContributeToDevelopment === Feedback === feedback form to solicit user feedback should include prominent note saying that this isn't a bug report or for getting help/support but should note that this is a good place for suggestions or even new application notifications === Feature Tour === or "learn more about ubuntu studio" pages the purpose of this is to expand on the "slide show" use cases by explaining the features of each use case by highlighting the applications and their capacities. for example, the audio page can mention jack with lowlatency and super-flexible connectivity, ardour with unlimited (more or less) tracks and fader automation, and over 200+ plugins included. this is the page where we want to hook people who are unfamiliar with ubuntu studio (or possibly linux and fl/oss) to actually download, install, and use ubuntu studio pages will include text with some graphics and include "<- previous" and "next ->" links at bottom currently the pages are envisioned as: * overview of ubuntu studio and gpl/linux/floss * audio * graphic design * video/film * photography |
| Line 83: | Line 155: |
| The specification process requires experienced people to drive it. More documentation on the process should be produced. The drafting of a specification requires English skills and a very good understanding of the problem. It must also describe things to an extent that someone else could implement. This is a difficult set of conditions to ensure throughout all the specifications added. There is a lot of difficulty in gardening obsolete, unwanted and abandoned specifications in the Wiki. |
* further information is required for which code should be in bzr branch |
| Line 91: | Line 159: |
| We'll have a first public session on this on the first Monday in UBZ. | Further discussion can be scheduled as needed. |
Launchpad Entry: other-p-ubuntustudio-update-website
Created: 2011-09-06
Contributors: ScottLavender
Packages affected:
Summary
This specification describes the development of an updated and improved Ubuntu Studio website (ubuntustudio.org).
Rationale
The Ubuntu Studio website has not been updated in many years and is suffering some bitrot. An updated theme would improve the aesthetics of the website.
Additional pages are desired to improve user experience and support.
Furthermore, providing a more functional website improves Ubuntu Studio's presence on the web.
Use Cases
Primary
- download iso image, either current release or LTS version
- learn about ubuntu studio (i.e. what is it and do i want to use it?)
- learn how to contribute to ubuntu studio
Secondary
- news feed (with rss)
- to learn about current design work (i.e. what we are trying to do now but haven't released yet)
- to find tutorials, work flows, and instructions (could be wiki pages, videos, or even individual's blog posts)
- to get help (forums, irc, wiki pages, mailing lists)
Scope
This specification covers creating a new website theme, deploying the theme via ubuntustudio-dev website launchpad branch, and develop content on the website.
Design
Website Platform: We have decided to use Wordpress.
Implementation
Development
A development website has been created and design/content will need to be created by the website team. It will be refined through peer/team review.
We should try to complete as much design and content as possible before it is moved (by -security or RT or whoever) to the staging tree.
Launchpad Branch
Once the demo site is approved then the appropriate code would need to be pushed to the website bzr branch hosted in Launchpad. A Ubuntu Stduio website team has been created to control access to the bzr code.
Website Content
Home Page
The home page will include, in general top -> down, left -> right flow:
nav bar - links to home, news, (contributor's) blog, download, tutorials (aka wiki), support, contribute (to development), feedback
slide show - show overview of ubuntu studio and general use cases; (1) overview of ubuntu studio plus gpl/linux/floss info, (2) audio, (3) graphic design, (4) video, (5) photography
download button - in same vertical space as slide show but to the right of it (but also above the feature tour button), make it stand out as this is a primary reason people come to website, make it easy for them to see it!, make it appreciably big, use different color than rest of page and different than feature tour perhaps, label button "Download ISO"
might still include the "release notes" and "installation guide" links between buttons
feature tour - in the same vertical space as slide show but to the right of it (but also below the download button), make it stand out as this is a primary reason people come to website, make it easy for them to see it!, make it appreciably big, , use different color than rest of page and different than download perhaps, label button "Take the Feature Tour" or "Learn More About Ubuntu Studio" or similar
project description - leave it as is, choosing to go with the simple, uncluttered aesthetic for the home page devoid of "wall-o-text" news items
search - located at the top of the of the column to the right of the news/blog area and below the entire slide show area
social - replace current article tags with social ticker as article tags might be better located on the news and designer blog pages, located in the column to the right of the news/blog area and below the search box, include social icons at the top of the ticker NOT SURE IF WE ARE USING THIS
An example image knocked up in Inkscape: 
Notice how the vertical spacing is more optimized in this overlay image: 
Full size .svg file: website-clean-original.svg smaller .svg file: website-clean-smaller.svg
News
typical news page with rss feed and search box
meant for formal announcements mainly.
do we include contributor blog posts here as well? is there a way to include both but have the blog items look different than the news ones?
Blog
place for contributors to blog about development, mentioning current development or possible considerations for upcoming development.
not currently considered for a blog aggregation, but could be
Download
linked to by navbar and button on front page
have a large, prominent area for "recommended release", will link DIRECTLY to images for i386 ISO, amd64 ISO, i386 torrent, and amd64 torrent, this section should be new user friendly and capture the eye somehow
links should be included for "how to burn an ISO", "release notes", and "installation guide"
"how to burn an ISO" and "installation guide" might be static links located in the right sidebar
"release notes" might be located directly with "recommended release" links
we can show the latest release (if not the current) and the LTS version as links to the cdimage page also
Tutorials
also known as "wiki"
currently this probably should link to help.ubuntu.com/ubuntustudio help page
in the future we can try to use a different css and pull the information directly from the h.u.c pages link edubuntu and kbuntu currently do for ubuntu studio pages
Support
description of the different forms of help and maybe mention timeliness of each
include the following links:
ubuntu studio forum on ubuntuforums.org - http://ubuntuforums.org/forumdisplay.php?f=335
- IRC - freenode #ubuntustudio and #ubuntustudio-devel
email - ubuntu-studio-users@lists.ubuntu.com and ubuntu-studio-devel@lists.ubuntu.com
Contribute
list and description of the ways to help contribute to ubuntu studio
include link to "contribute to develop" wiki page - https://wiki.ubuntu.com/UbuntuStudio/ContributeToDevelopment
Feedback
feedback form to solicit user feedback
should include prominent note saying that this isn't a bug report or for getting help/support
but should note that this is a good place for suggestions or even new application notifications
Feature Tour
or "learn more about ubuntu studio" pages
the purpose of this is to expand on the "slide show" use cases by explaining the features of each use case by highlighting the applications and their capacities. for example, the audio page can mention jack with lowlatency and super-flexible connectivity, ardour with unlimited (more or less) tracks and fader automation, and over 200+ plugins included.
this is the page where we want to hook people who are unfamiliar with ubuntu studio (or possibly linux and fl/oss) to actually download, install, and use ubuntu studio
pages will include text with some graphics and include "<- previous" and "next ->" links at bottom
currently the pages are envisioned as:
- overview of ubuntu studio and gpl/linux/floss
- audio
- graphic design
- video/film
- photography
Outstanding Issues
- further information is required for which code should be in bzr branch
BoF agenda and discussion
Further discussion can be scheduled as needed.
UbuntuStudio/update-website-spec (last edited 2011-12-04 18:19:41 by lfkn-adsl-dhcp-64-92-16-215)