Releases:Release Notes System - Revision history

Sardisson: now maybe it's complete

2009-10-11T03:45:37Z

now maybe it's complete

Sardisson: /* Features in Camino ''N.n'' */ add the header for this section and note style differences between web and RTF

2009-10-11T03:37:12Z

Features in Camino ''N.n'': add the header for this section and note style differences between web and RTF

Sardisson: /* Milestone style */ finish up examples for the milestone style

2009-10-11T03:30:16Z

Milestone style: finish up examples for the milestone style

Sardisson: ok, this is mostly complete now

2009-10-11T03:22:10Z

ok, this is mostly complete now

Show changes

Sardisson: /* Branch EOL Release */ better box

2008-12-10T20:12:18Z

Branch EOL Release: better box

Sardisson: /* Security and Stability Update style */ add a note about eol

2008-12-10T20:11:37Z

Security and Stability Update style: add a note about eol

Sardisson: /* Security and Stability Update style */ document this

2007-10-09T01:46:16Z

Security and Stability Update style: document this

Sardisson: this is all for now, I think

2007-08-16T03:45:37Z

this is all for now, I think

Sardisson: commit the first part of this, since the power gods have not been smiling

2007-08-16T03:31:30Z

commit the first part of this, since the power gods have not been smiling

New page

Camino uses three basic styles of release notes: the Milestone style, the Final Release style, and the Security and Stability Update style. Each of these styles varies slightly in format, structure, and language. This document explains the system finalized during the 1.1/1.5 release cycle.

When the Final Release and Security and Stability Update notes appear on the website, there are slight layout changes involved, but the format and structure remain essentially the same. A fourth, website-only, style is the “Complete Release Notes”, which consists of all the Milestone notes for a given release plus any relnote-worthy changes between the last Milestone and the Final Release, in a slightly different format (this supplements the normal Final Release style notes for a version by providing a comprehensive changelog-style notes).

==Milestone style==

The first style is the Milestone style, used for alpha and beta milestones. This style is the most informal and consists largely of a component-ordered list of changes since the last final release or milestone. These changes are drawn from the respective ''Releases:N.n:Notes'' pages, which in turn are “branched” from the “running release notes” page for the release, ''Releases:Release Notes N.n''. The wiki pages list all “relnote-worthy” changes since the last final release (or the last milestone). To be “relnote-worthy,” a checkin typically has to be a user-facing feature addition, behavior change, or bug fix.

The Milestone style consists of 3 major sections, “About Camino® ''N.n Milestone''” (with the ®), “Features in Camino ''N.n Milestone''” (without the ®), and “Known Issues”. A new Features section is prepended for each subsequent milestone, e.g., Camino 1.1a1 will have one Features section, but Camino 1.1b might have 3, one for the 1.1a1, 1.1a2, and the topmost Features section for 1.1b.

===About Camino===
This section contains a paragraph highlighting the main areas of change since the previous Final Release, a paragraph of caution tailored to the Alpha or Beta (with slightly different wording), a single sentence paragraph about Firefox/Gecko compatibility, and, where necessary, a final paragraph directing users of a no-longer-supported OS version to the last Security and Stability Update version for their OS.

<div style="border: 1px solid blue; padding-left: 5px;">
===About Camino® 1.1 Beta===
Camino 1.1 Beta is a heavily-updated version of the only native Mac OS X browser using Mozilla.org’s Gecko HTML rendering engine. Notable improvements include enhanced tabbed browsing (“single window mode”), integration with the Mac OS X spell-checking system, detection of RSS/Atom feeds, an improved design for the “blocked pop-up” notification, enhanced options for cookies and downloads, and a resizable search field in the toolbar. This release also includes enhancements in speed, security, and rendering accuracy brought by version 1.8.1 of the Gecko rendering engine.

Note that this version is in the “beta” stage, which means that it is close to its final shipping state. We feel that it is usable on a day-to-day basis and is a large improvement over Camino 1.0, but you may still experience bugs and some functionality may not work entirely as intended. The goal of this release is to demonstrate the team’s progress and to allow users to report problems before the final release.

Camino 1.1 Beta shares the same code base as Firefox 2.0, both being based on Gecko 1.8.1, and thus shares many of the security fixes and Gecko improvements that are in that version of Firefox.

Due to changes in the feature set, Camino 1.1 Beta no longer supports Mac OS X 10.2. We advise users still running Mac OS X 10.2 to [http://www.caminobrowser.org/download/releases/1.0.3/ download Camino 1.0.3] ([http://www.caminobrowser.org/releases/1.0.3/ release notes]).</div>

@@ Line 57: / Line 57: @@
 ===Known Issues===
-List. Updated with each subsequent milestone.  Try to prune all but most serious carry-over notes from previous release.  What qualifies a bug to be a known issue?  Major, often not ours, common problem.
+Header (H1) followed by a list. Updated with each subsequent milestone.  Try to prune all but most serious carry-over notes from previous release.  What qualifies a bug to be a known issue?  Major, often not ours, common problem.
 Note that lazy journalists use this section to come up with "bugs in Camino" so try to differentiate between issues that are "ours" and are regressions and those that are caused by third-party software (and are often on-going, not regressions).
 ==Final Release style==
@@ Line 94: / Line 105: @@
 List based on the Known Issues of the milestone releases. Try to prune all but most serious carry-over notes from previous release.  What qualifies a bug to be a known issue?  Major, often not ours, common problem.  Note that lazy journalists use this section to come up with "bugs in Camino" so try to differentiate between issues that are "ours" and are regressions and those that are caused by third-party software (and are often on-going, not regressions).
@@ Line 145: / Line 169: @@
 ===Known Issues===
-List, updated as needed.  Try not to modify these, but when necessary to do so, be sure to 1) alert l10n and 2) post the updated Known Issues on the release's release notes web page.
+As in Final Release style, this is a list, updated as needed.  Try not to modify these, but when necessary to do so, be sure to 1) alert l10n and 2) post the updated Known Issues on the release's release notes web page.
 It's great to be able to delete a known issue during a branch cycle, but it's less fun to have to add an issue or modify the text of one.

@@ Line 79: / Line 79: @@
 ===Features in Camino ''N.n''===
-The Features section consists of about a dozen short, descriptive headings, each with list items below providing more detailed descriptions of the elements of the feature.  E.g.,
+The Features section consists of an introductory sentence containing a link to the "complete" changelog-style notes, followed by about a dozen short, descriptive headings (bold, but as first-level list items), each with list items below providing more detailed descriptions of the elements of the feature.
 <div style="border: 1px solid blue; padding: 5px; background-color: light grey; margin: 10px;">
-'''Improved toolbar search'''
+===Features in Camino 1.6===
-* The search field in the toolbar now includes a simple editor that allows deleting, renaming, and reordering search engines.
+The following are the major changes and improvements made since the Camino 1.5 release. A full list is available on our [http://caminobrowser.org/releases/1.6/complete.php website].
 * Camino now supports [http://opensearch.org/ OpenSearch] search engine plug-ins. New search engines can be added to the toolbar’s search field by automatic discovery or by web pages that provide links to OpenSearch plug-ins.</div>
 ===Known Issues===

@@ Line 19: / Line 19: @@
 ===About Camino® ''N.n Milestone''===
-This section contains a paragraph highlighting the main areas of change since the previous Final Release, a paragraph of caution tailored to the Alpha or Beta (with slightly different wording for alpha vs. beta), a single sentence paragraph about Firefox/Gecko compatibility, and, where necessary, a final paragraph directing users of a no-longer-supported OS version to the last Security and Stability Update version for their OS.
+This section (H1) contains a paragraph highlighting the main areas of change since the previous Final Release, a paragraph of caution tailored to the Alpha or Beta (with slightly different wording for alpha vs. beta), a single sentence paragraph about Firefox/Gecko compatibility, and, where necessary, a final paragraph directing users of a no-longer-supported OS version to the last Security and Stability Update version for their OS.
 In each subsequent milestone, be sure to increment the "''nth'' preview release" text in the first sentence.
@@ Line 44: / Line 44: @@
 ===Features in Camino ''N.n Milestone''===
-List, by functional area.  Don't include functional areas which have no checkins.  Keep the list of functional areas consistent within a release cycle.
+List, by functional area (H2).  Don't include functional areas which have no checkins.  Keep the list of functional areas consistent within a release cycle.
 ===Known Issues===
 List. Updated with each subsequent milestone.  Try to prune all but most serious carry-over notes from previous release.  What qualifies a bug to be a known issue?  Major, often not ours, common problem.
 ==Final Release style==

← Older revision		Revision as of 20:12, 10 December 2008
Line 45:		Line 45:
	===Branch EOL Release===		===Branch EOL Release===

−	<~~pre~~>Camino 1.0.5 is a security and stability update for Camino 1.0.x users running Mac OS X 10.2.8. Camino 1.0.5 will be the last update in the 1.0.x series and is thus the last version of Camino to support Mac OS X 10.2.</~~pre~~>	+	<div style="border: 1px solid blue; padding: 5px; background-color: light grey; margin: 10px;">Camino 1.0.5 is a security and stability update for Camino 1.0.x users running Mac OS X 10.2.8. Camino 1.0.5 will be the last update in the 1.0.x series and is thus the last version of Camino to support Mac OS X 10.2.</div>

← Older revision		Revision as of 20:11, 10 December 2008
Line 42:		Line 42:

	In intro sentence, N.n.1 has "Camino N.n.1 is a security and stability update for Camino N.n. All users are urged to upgrade." but N.n.>1 has "Camino N.n.>1 is a security and stability update for Camino N.n.x. All users are urged to upgrade."		In intro sentence, N.n.1 has "Camino N.n.1 is a security and stability update for Camino N.n. All users are urged to upgrade." but N.n.>1 has "Camino N.n.>1 is a security and stability update for Camino N.n.x. All users are urged to upgrade."
		+
		+	===Branch EOL Release===
		+
		+	<pre>Camino 1.0.5 is a security and stability update for Camino 1.0.x users running Mac OS X 10.2.8. Camino 1.0.5 will be the last update in the 1.0.x series and is thus the last version of Camino to support Mac OS X 10.2.</pre>

← Older revision		Revision as of 01:46, 9 October 2007
Line 39:		Line 39:
	==Security and Stability Update style==		==Security and Stability Update style==

−	This basically replaces the About section and appends a set of lists for each subsequent s&s release. Also changes Known Issues, if applicable. Try to keep changes light (repeat same texts in lists where possible) for l10n.	+	This basically replaces the About section and appends a set of lists for each subsequent s&s release. Also changes Known Issues, if applicable. Try to keep changes light (repeat same texts in lists where possible) for l10n.
		+
		+	In intro sentence, N.n.1 has "Camino N.n.1 is a security and stability update for Camino N.n. All users are urged to upgrade." but N.n.>1 has "Camino N.n.>1 is a security and stability update for Camino N.n.x. All users are urged to upgrade."

@@ Line 1: / Line 1: @@
 Camino uses three basic styles of release notes: the Milestone style, the Final Release style, and the Security and Stability Update style.  Each of these styles varies slightly in format, structure, and language.  This document explains the system finalized during the 1.1/1.5 release cycle.
@@ Line 9: / Line 16: @@
 The Milestone style consists of 3 major sections, “About Camino® ''N.n Milestone''” (with the ®), “Features in Camino ''N.n Milestone''” (without the ®), and “Known Issues”.  A new Features section is prepended for each subsequent milestone, e.g., Camino 1.1a1 will have one Features section, but Camino 1.1b might have 3, one for the 1.1a1, 1.1a2, and the topmost Features section for 1.1b.
-===About Camino===
+===About Camino® ''N.n Milestone''===
 This section contains a paragraph highlighting the main areas of change since the previous Final Release, a paragraph of caution tailored to the Alpha or Beta (with slightly different wording), a single sentence paragraph about Firefox/Gecko compatibility, and, where necessary, a final paragraph directing users of a no-longer-supported OS version to the last Security and Stability Update version for their OS.
-<div style="border: 1px solid blue; padding-left: 5px;">
+<div style="border: 1px solid blue; padding: 5px; background-color: light grey; margin: 10px;">
 ===About Camino® 1.1 Beta===
 Camino 1.1 Beta is a heavily-updated version of the only native Mac OS X browser using Mozilla.org’s Gecko HTML rendering engine. Notable improvements include enhanced tabbed browsing (“single window mode”), integration with the Mac OS X spell-checking system, detection of RSS/Atom feeds, an improved design for the “blocked pop-up” notification, enhanced options for cookies and downloads, and a resizable search field in the toolbar. This release also includes enhancements in speed, security, and rendering accuracy brought by version 1.8.1 of the Gecko rendering engine.
@@ Line 21: / Line 28: @@
 Due to changes in the feature set, Camino 1.1 Beta no longer supports Mac OS X 10.2. We advise users still running Mac OS X 10.2 to [http://www.caminobrowser.org/download/releases/1.0.3/ download Camino 1.0.3] ([http://www.caminobrowser.org/releases/1.0.3/ release notes]).</div>