Mozilla.org/How to Work with Site: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(Updating docs and merging separate SVN how-to)
Line 1: Line 1:
Docs for people getting involved with site.
Docs for people getting involved with site.


==Asking Questions==
=Asking Questions=


The best way to learn about how to work with the www.mozilla.org site is to ask questions.  Community members are happy to help, but it can be difficult to know who to talk to.  Here are a few good places to go with questions:
The best way to learn about how to work with the www.mozilla.org site is to ask questions.  Community members are happy to help, but it can be difficult to know who to talk to.  Here are a few good places to go with questions:
Line 11: Line 11:
Phone: [[Mozilla.org:Planning#Planning_Meetings|Monthly planning meetings]]
Phone: [[Mozilla.org:Planning#Planning_Meetings|Monthly planning meetings]]


==Bugzilla==
=Bugzilla=


We use [http://bugzilla.mozilla.org Bugzilla] to track bugs as well as enhancements to the site, so we recommend that you look through open bugs to determine what you'd like to work on (of course you are welcome to suggest new ideas as well).
We use [http://bugzilla.mozilla.org Bugzilla] to track bugs as well as enhancements to the site, so we recommend that you get familiar with this tool. You can look through bugs without a [https://bugzilla.mozilla.org/createaccount.cgi Bugzilla account], but you will need one to update an existing bug or open a new one.  Please feel free to look through open bugs, comment in a bug, submit a patch or assign a bug to yourself.
 
You can look through bugs without a Bugzilla account, but you will need one to update an existing bug or open a new one.  Everyone is welcome to look through open bugs, comment in a bug, submit a patch or open a new one.


* [https://bugzilla.mozilla.org/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&component=www.mozilla.org&long_desc_type=substring&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&resolution=DUPLICATE&resolution=---&emailassigned_to1=1&emailtype1=exact&email1=&emailassigned_to2=1&emailreporter2=1&emailqa_contact2=1&emailtype2=exact&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&field0-0-0=noop&type0-0-0=noop&value0-0-0= All open www.mozilla.org bugs]
* [https://bugzilla.mozilla.org/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&component=www.mozilla.org&long_desc_type=substring&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&resolution=DUPLICATE&resolution=---&emailassigned_to1=1&emailtype1=exact&email1=&emailassigned_to2=1&emailreporter2=1&emailqa_contact2=1&emailtype2=exact&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&field0-0-0=noop&type0-0-0=noop&value0-0-0= All open www.mozilla.org bugs]
* [https://bugzilla.mozilla.org/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&component=www.mozilla.org&long_desc_type=substring&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=helpwanted&resolution=DUPLICATE&resolution=---&emailassigned_to1=1&emailtype1=exact&email1=&emailassigned_to2=1&emailreporter2=1&emailqa_contact2=1&emailtype2=exact&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&field0-0-0=noop&type0-0-0=noop&value0-0-0= All open helpwanted www.mozilla.org bugs]
* [https://bugzilla.mozilla.org/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&component=www.mozilla.org&long_desc_type=substring&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=student-project&resolution=DUPLICATE&resolution=---&emailassigned_to1=1&emailtype1=exact&email1=&emailassigned_to2=1&emailreporter2=1&emailqa_contact2=1&emailtype2=exact&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&field0-0-0=noop&type0-0-0=noop&value0-0-0= All open student-project www.mozilla.org bugs]


* [https://bugzilla.mozilla.org/enter_bug.cgi Enter a new bug]
* [https://bugzilla.mozilla.org/enter_bug.cgi Enter a new bug]


==Viewing The Source==
=Viewing The Source=


The site uses a templating system to add the header, side navigation and footer to all of the pages.  If you view the source of a page through your browser you are seeing the results of merging a page with a template.  To see what the HTML files look like before they are merged, you can look at the files in our Subversion repository at:
The site uses a templating system to add the header, side navigation and footer to all of the pages.  If you view the source of a page through your browser you are seeing the results of merging a page with a template.  To see what the HTML files look like before they are merged, you can look at the files in our Subversion repository at:
Line 33: Line 27:
Our repository is open, so feel free to look around at different files to see how things are put together.
Our repository is open, so feel free to look around at different files to see how things are put together.


==Making Site Changes==
=Making Site Changes=
 
There are several ways to edit the site and you are welcome to pick the option that works best for you.
 
==Submitting Patches==
 
The easiest way to make a change is to work with someone who already has access to edit the site.  You can send them the change in a variety of formats.  Attaching a [https://developer.mozilla.org/En/Creating_a_patch patch] to a bug is the most common way to do that, but it is also possible to simply email a change to someone.  How changes are submitted will vary on your technical experience and on who you are working with.
 
==Using Bespin (Web-based Editor)==
 
We will soon have a web-based editor available for the site.  Our goal is to embed [https://bespin.mozilla.com/ Bespin] to make it easy for people to edit pages.  When this is available, we'll post more information here about how to use it.
 
==Using Subversion==
 
The files for the site are kept in version control using the Subversion tool.  You can edit the site by checking out these files, editing them on your computer and then checking them back in.
 
The following provides information specifically about Subversion for www.mozilla.org.  General information about [[SVN|Mozilla's Subversion server]] is also available.
 
===Repository===
 
Location of repository: http://svn.mozilla.org/projects/mozilla.org/trunk/


There are two ways to update the site—have someone with access make the change or make the change yourself.
===Authentication===


===Submitting Changes===
Access to the repository is based on either your LDAP account or on an SSH key.  People have reported problems trying to use SVN+SSH though, so LDAP authentication is the recommended option (the commands below are based on LDAP authentication).


The easiest way to make a change is to work with someone who already has access.  You can send them the change in a variety of formats.  Attaching a [https://developer.mozilla.org/En/Creating_a_patch patch] to a bug is the most common way to do that, but it is also possible to simply email a change to someone.  How changes are submitted will vary on your technical experience and on who you are working with.
If you need an SVN account or if you have one and need permission to edit the www.mozilla.org files, please [https://bugzilla.mozilla.org/enter_bug.cgi?product=mozilla.org;component=Server%20Operations file a bug] to request access.  For people without existing Mozilla commit rights, please follow the process described in [http://www.mozilla.org/hacking/committer/ becoming a committer].


===Checking In Changes===
===Commands===


''Note: You '''do not''' need to deal with Subversion if you don't want to.  This information is provided for anyone who does want to work directly with our repository.''
To check out repository (''note the use of the S in https://''):


If you'd like to edit the site directly, you will need to get commit access and either edit pages using a version control tool or our online editor. Documentation for each of those steps is below:
<code>svn co https://svn.mozilla.org/projects/mozilla.org/trunk</code>


* [http://www.mozilla.org/hacking/committer/ Becoming A Mozilla Committer]
Check-in an edit to a page:


* [[Mozilla.org/Editing Site with SVN|Documentation for editing the site]] (covers Subversion and Bespin)
<code>svn ci -m "Comment goes here" foo.html</code>


==Style Guides and References==
=Style Guides and References=


Once you're able to make changes to the site, please take a look at the following pages that offer suggestions about writing and coding.  Since the site is edited by a range of people across the community, following some guidelines will help maintain a consistent experience for users.
Once you're able to make changes to the site, please take a look at the following pages that offer suggestions about writing and coding.  Since the site is edited by a range of people across the community, following some guidelines will help maintain a consistent experience for users.

Revision as of 02:58, 3 September 2009

Docs for people getting involved with site.

Asking Questions

The best way to learn about how to work with the www.mozilla.org site is to ask questions. Community members are happy to help, but it can be difficult to know who to talk to. Here are a few good places to go with questions:

Email: dev-mozilla-org

Chat: #siteplanning on irc.mozilla.org

Phone: Monthly planning meetings

Bugzilla

We use Bugzilla to track bugs as well as enhancements to the site, so we recommend that you get familiar with this tool. You can look through bugs without a Bugzilla account, but you will need one to update an existing bug or open a new one. Please feel free to look through open bugs, comment in a bug, submit a patch or assign a bug to yourself.

Viewing The Source

The site uses a templating system to add the header, side navigation and footer to all of the pages. If you view the source of a page through your browser you are seeing the results of merging a page with a template. To see what the HTML files look like before they are merged, you can look at the files in our Subversion repository at:

Our repository is open, so feel free to look around at different files to see how things are put together.

Making Site Changes

There are several ways to edit the site and you are welcome to pick the option that works best for you.

Submitting Patches

The easiest way to make a change is to work with someone who already has access to edit the site. You can send them the change in a variety of formats. Attaching a patch to a bug is the most common way to do that, but it is also possible to simply email a change to someone. How changes are submitted will vary on your technical experience and on who you are working with.

Using Bespin (Web-based Editor)

We will soon have a web-based editor available for the site. Our goal is to embed Bespin to make it easy for people to edit pages. When this is available, we'll post more information here about how to use it.

Using Subversion

The files for the site are kept in version control using the Subversion tool. You can edit the site by checking out these files, editing them on your computer and then checking them back in.

The following provides information specifically about Subversion for www.mozilla.org. General information about Mozilla's Subversion server is also available.

Repository

Location of repository: http://svn.mozilla.org/projects/mozilla.org/trunk/

Authentication

Access to the repository is based on either your LDAP account or on an SSH key. People have reported problems trying to use SVN+SSH though, so LDAP authentication is the recommended option (the commands below are based on LDAP authentication).

If you need an SVN account or if you have one and need permission to edit the www.mozilla.org files, please file a bug to request access. For people without existing Mozilla commit rights, please follow the process described in becoming a committer.

Commands

To check out repository (note the use of the S in https://):

svn co https://svn.mozilla.org/projects/mozilla.org/trunk

Check-in an edit to a page:

svn ci -m "Comment goes here" foo.html

Style Guides and References

Once you're able to make changes to the site, please take a look at the following pages that offer suggestions about writing and coding. Since the site is edited by a range of people across the community, following some guidelines will help maintain a consistent experience for users.

Retrieved from "https://wiki.allizom.org/index.php?title=Mozilla.org/How_to_Work_with_Site&oldid=166254"