Compatibility/Guide - Revision history

Karlcow: updating prose and links

2019-05-16T00:26:45Z

updating prose and links

← Older revision		Revision as of 00:26, 16 May 2019
Line 46:		Line 46:
	Do not forget: '''Be nice'''. It is our collective effort.		Do not forget: '''Be nice'''. It is our collective effort.

	== ~~Analyzing for~~ Web Compatibility ~~Issues~~ ==		== Diagnose a Web Compatibility Issue ==

	Analysis is broken down into two processes: triage and diagnosis.		Analysis is broken down into two processes: triage and diagnosis.
Line 56:		Line 56:
	There are many ways of diagnosing a web site for Web Compatibility issues. We could write an entire book with the types of issues and techniques used to find them.		There are many ways of diagnosing a web site for Web Compatibility issues. We could write an entire book with the types of issues and techniques used to find them.

	=== ~~Mozilla Bugzilla~~ Process ~~for Analysis~~ ===		=== Diagnosis Process and Tools ===

	You might want help analyzing [https://bugzilla.mozilla.org/buglist.cgi?product=Tech%20Evangelism&component=Mobile&resolution=---&list_id=7757638 Mobile Web Compatibility bugs]. A bug which has the status '''NEW''' or '''ASSIGNED''' are basically the same.		The work is based on a [[Compatibility/Diagnosis\|diagnosis process]]. You may want to read this. It gives useful hints on how to organize the work. [[Compatibility/Tools\|some tools and techniques]] for investigating bugs have also been described.

	~~# When analyzing the bug, take it (and change the bug to '''ASSIGNED''').~~
	~~# Once you've discovered the type of issue affecting the site:~~
	~~## document in a comment~~
	~~## flag it with~~ a ~~whiteboard keyword for example [serversniff] if it's related to server side user agent detection.~~ [[Compatibility/~~BugsGuide#whiteboard_keywords_for_categorizing_the_issues~~ \| ~~Jump to the full list~~]].
	~~# If you do not plan~~ to ~~work further~~ on the ~~bug, such as contacting the Web site, '''Unassign yourself'''~~

	~~You may use~~ [[Compatibility/Tools\|some tools and techniques]] for investigating bugs.

	== Finding The Right Contact on a Web site ==		== Finding The Right Contact on a Web site ==

Astevenson: /* Analyzing for Web Compatibility Issues */ add description of triage-diagnosis and link to triage process

2016-11-08T22:00:57Z

Analyzing for Web Compatibility Issues: add description of triage-diagnosis and link to triage process

← Older revision		Revision as of 22:00, 8 November 2016
Line 48:		Line 48:
	== Analyzing for Web Compatibility Issues ==		== Analyzing for Web Compatibility Issues ==

	There are many ways of ~~analyzing~~ a ~~Web~~ site for Web Compatibility issues. We could write an entire book with the types of issues and techniques used to find them.		Analysis is broken down into two processes: triage and diagnosis.
			The [[Compatibility/Guide/Triage\|triage process]] involves testing the reported issue to validate if the issue:
			* Can be reproduced
			* Is considered a valid Web Compatibility bug
			* Has been reported previously (a duplicate)

			There are many ways of diagnosing a web site for Web Compatibility issues. We could write an entire book with the types of issues and techniques used to find them.

	=== Mozilla Bugzilla Process for Analysis ===		=== Mozilla Bugzilla Process for Analysis ===

Miketaylr: /* Reporting a Web compatibility issue */ Add link to webcompat reporter add-on.

2016-07-27T22:37:36Z

Reporting a Web compatibility issue: Add link to webcompat reporter add-on.

← Older revision		Revision as of 22:37, 27 July 2016
Line 24:		Line 24:
	'''You can help'''!		'''You can help'''!

	Note: We try to avoid working on fixing Web sites which are working badly everywhere. We focus first our energy on Web sites which are broken in one browser and not others.		Note: We try to avoid working on fixing Web sites which are working badly everywhere. We focus first our energy on Web sites which are broken in one browser and not others. Issues caused by add-ons or ad blockers are also not considered web compatibility issues.

	=== Requirements ===		=== Requirements ===
Line 34:		Line 34:
	A good bug report includes steps to reproduce an issue, and what the expected outcome was. The more details you give, the better chance the issue will be properly addressed. If, for example, one must log in to see the issue, it is important to say so. Screenshots can also be very helpful!		A good bug report includes steps to reproduce an issue, and what the expected outcome was. The more details you give, the better chance the issue will be properly addressed. If, for example, one must log in to see the issue, it is important to say so. Screenshots can also be very helpful!

	# Create a [https://webcompat.com/?open=1 new bug on webcompat.com]		# Create a [https://webcompat.com/?open=1 new bug on webcompat.com] (if you have the [https://addons.mozilla.org/en-US/firefox/addon/webcompatcom-reporter/ webcompat reporter add-on] installed, just click on the icon to open this for you with some of the info pre-filled).
	## Include the URL'''		## Include the URL'''
	## Include the steps to perform to see the problem after opening that URL		## Include the steps to perform to see the problem after opening that URL

Miketaylr: /* Reporting a Web compatibility issue */ Change reporting instructions to be for webcompat.com

2016-07-27T22:33:27Z

Reporting a Web compatibility issue: Change reporting instructions to be for webcompat.com

← Older revision		Revision as of 22:33, 27 July 2016
Line 18:		Line 18:
	=== What? ===		=== What? ===

	# ~~Enter the Web site URI~~		# You visit a webpage.
	# ~~You have not been able to use it with your Web browsers of choice~~		# Something about the experience is broken: layout is messed up, video doesn't play, buttons don't work, etc.
	# '''Check ~~on other browsers~~'''. ~~Are~~ there ~~any differences making the site unusable.~~		# '''Check in another browser'''. Is it working there but not in Firefox?

	'''You can help'''!		'''You can help'''!

	This guide is focused on Mozilla browsers but you can also help other browser vendors. If you have an issue with Opera ([https://bugs.opera.com/wizarddesktop/ Bug Wizard]), Chrome ([http://code.google.com/p/chromium/issues/entry Bug]), Safari ([https://bugs.webkit.org/ Bug]) or Internet Explorer ([https://connect.microsoft.com/IE Bug]).		Note: We try to avoid working on fixing Web sites which are working badly everywhere. We focus first our energy on Web sites which are broken in one browser and not others.

	PS: We try to avoid ~~to fix~~ Web sites which are working badly everywhere. We focus first our energy on Web sites which are broken in one browser and not ~~the~~ others.

	=== Requirements ===		=== Requirements ===

	You will need a ~~Mozilla bugzilla~~ account. If ~~not~~ [https://~~bugzilla~~.~~mozilla.org~~/~~createaccount.cgi~~ create a new account].		You will need a GitHub account. If you don't have one, [https://github.com/ you can create a new account] (it's free). You can also file bugs anonymously, but that makes it hard to follow up— filing with an account is preferred!

	~~Alternately~~, ~~you can open a bug on [https://webcompat.com/?open=1 webcompat.com ]~~

	=== Steps to follow ===		=== Steps to follow ===

	~~The person (volunteer or Mozilla engineer) will need to know which~~ steps ~~you have followed~~ to ~~reach~~ the ~~issue~~. The more details you give, the better chance the issue will be properly addressed. If, for example, one must log in to see the issue, it is important to say so.		A good bug report includes steps to reproduce an issue, and what the expected outcome was. The more details you give, the better chance the issue will be properly addressed. If, for example, one must log in to see the issue, it is important to say so. Screenshots can also be very helpful!

	# Create a [https://~~bugzilla~~.~~mozilla.org~~/~~form.mobile.compat~~ new bug ~~in Bugzilla~~]		# Create a [https://webcompat.com/?open=1 new bug on webcompat.com]
	## ~~Describe~~ the ~~steps you have been doing for reaching the point where you have an issue:~~ '''~~[https://bugzilla.mozilla.org/show_bug.cgi?id=901569~~#~~c0 Example of~~ steps~~]'''~~		## Include the URL'''
	## Describe ~~what is happening~~		## Include the steps to perform to see the problem after opening that URL
	## Describe ~~what you were expecting~~		## Describe the expected behavior
	## Give information about your device and your browser		## Describe the actual behavior
	# (Bonus) Test in one or more browsers to understand the differences~~: [https://bugzilla.mozilla.org/show_bug.cgi?id=843165#c1 Example of tests in different browsers]~~		## Give relevant information about your device and your browser
			# (Bonus) Test in one or more browsers to understand the differences

	Someone might ask further questions in the bug report to better understand the issue.		Someone might ask further questions in the bug report to better understand the issue. This is why it's important to report issues with a GitHub account — you'll be able to get notifications about questions and progress.

	Do not forget: '''Be nice'''. It is our collective effort.		Do not forget: '''Be nice'''. It is our collective effort.

Miketaylr: /* Mobile Web Compatibility Issues By Countries */ Put this section down at the bottom.

2016-07-27T16:18:52Z

Mobile Web Compatibility Issues By Countries: Put this section down at the bottom.

← Older revision		Revision as of 16:18, 27 July 2016
Line 111:		Line 111:

	Web Compatibility often requires to communicate with the Web site developer or owner in his/her own language. We try to keep a [[Compatibility/Countries\|list of countries]] for people with specific language skills can get easily involved in the work.		Web Compatibility often requires to communicate with the Web site developer or owner in his/her own language. We try to keep a [[Compatibility/Countries\|list of countries]] for people with specific language skills can get easily involved in the work.

			== Collecting Information And Surveys ==

			Once a mobile device has been introduced in a new country, some Web sites will exhibit issues of Web compatibility. Every country has popular Web sites which are related to their local market (for example well known press and magazines sites).

			=== Steps to follow ===

			# Create a page with a list of top Web sites. See for example [https://etherpad.mozilla.org/top-brazilian-sites Brazil], [https://etherpad.mozilla.org/top-indian-sites India] or [https://etherpad.mozilla.org/top-german-sites Germany]
			# Start small, grow it little by little
			# For each Web site, test the site with Firefox Android (and Opera Mobile, IEMobile, Chrome Mobile, Android, etc.). You can get help by having a [https://air.mozilla.org/compcast-1-reviewing-screenshots-reporting-bugs/ pre-generation of screenshots for your Web site list].
			# Note differences and open individual bugs for each individual issue (see below)


	[[Category:Web Compatibility\|Guide]]		[[Category:Web Compatibility\|Guide]]

Miketaylr: /* Collecting Information And Surveys */ (remove this -- going to move down)

2016-07-27T16:18:26Z

Collecting Information And Surveys: (remove this -- going to move down)

← Older revision		Revision as of 16:18, 27 July 2016
Line 13:		Line 13:

	The '''work and the effort of the community''' is key to the success of the open Web. These efforts have to be considered in the constraints of the business requirements of each contacted Web site. We are not here to blame, we are here to make the Web open to anyone. The [[Compatibility\|Web compatibility]] effort is driven by two projects [[Compatibility/Mobile\|mobile Web compatibility]] and [[Compatibility/Desktop\|desktop Web compatibility]].		The '''work and the effort of the community''' is key to the success of the open Web. These efforts have to be considered in the constraints of the business requirements of each contacted Web site. We are not here to blame, we are here to make the Web open to anyone. The [[Compatibility\|Web compatibility]] effort is driven by two projects [[Compatibility/Mobile\|mobile Web compatibility]] and [[Compatibility/Desktop\|desktop Web compatibility]].

	~~== Collecting Information And Surveys ==~~

	Once a mobile device has been introduced in a new country, some Web sites will exhibit issues of Web compatibility. Every country has popular Web sites which are related to their local market (for example well known press and magazines sites).

	~~=== Steps to follow ===~~

	# Create a page with a list of top Web sites. See for example [https://etherpad.mozilla.org/top-brazilian-sites Brazil], [https://etherpad.mozilla.org/top-indian-sites India] or [https://etherpad.mozilla.org/top-german-sites Germany]
	~~# Start small, grow it little by little~~
	# For each Web site, test the site with Firefox OS, Firefox Android (and Opera Mobile, IEMobile, Chrome Mobile, Android, etc.). You can get help by having a [https://air.mozilla.org/compcast-1-reviewing-screenshots-reporting-bugs/ pre-generation of screenshots for your Web site list].
	~~# Note differences and open individual bugs for each individual issue (see below)~~

	== Reporting a Web compatibility issue ==		== Reporting a Web compatibility issue ==

Miketaylr: /* Reporting a Web compatibility issue */ Add link to webcompat.com

2016-07-26T23:05:57Z

Reporting a Web compatibility issue: Add link to webcompat.com

← Older revision		Revision as of 23:05, 26 July 2016
Line 42:		Line 42:

	You will need a Mozilla bugzilla account. If not [https://bugzilla.mozilla.org/createaccount.cgi create a new account].		You will need a Mozilla bugzilla account. If not [https://bugzilla.mozilla.org/createaccount.cgi create a new account].

			Alternately, you can open a bug on [https://webcompat.com/?open=1 webcompat.com ]

	=== Steps to follow ===		=== Steps to follow ===

Karlcow: /* Mozilla Bugzilla Process for Analysis */ fixing link

2016-04-11T21:31:25Z

Mozilla Bugzilla Process for Analysis: fixing link

← Older revision		Revision as of 21:31, 11 April 2016
Line 69:		Line 69:
	# Once you've discovered the type of issue affecting the site:		# Once you've discovered the type of issue affecting the site:
	## document in a comment		## document in a comment
	## flag it with a whiteboard keyword for example [serversniff] if it's related to server side user agent detection. [[#~~whiteboard keywords for categorizing the issues~~ \| Jump to the full list]].		## flag it with a whiteboard keyword for example [serversniff] if it's related to server side user agent detection. [[Compatibility/BugsGuide#whiteboard_keywords_for_categorizing_the_issues \| Jump to the full list]].
	# If you do not plan to work further on the bug, such as contacting the Web site, '''Unassign yourself'''		# If you do not plan to work further on the bug, such as contacting the Web site, '''Unassign yourself'''

Karlcow: /* Mobile Web Compatibility Issues By Countries */

2014-09-24T05:13:16Z

Mobile Web Compatibility Issues By Countries

← Older revision		Revision as of 05:13, 24 September 2014
Line 121:		Line 121:
	Web Compatibility often requires to communicate with the Web site developer or owner in his/her own language. We try to keep a [[Compatibility/Countries\|list of countries]] for people with specific language skills can get easily involved in the work.		Web Compatibility often requires to communicate with the Web site developer or owner in his/her own language. We try to keep a [[Compatibility/Countries\|list of countries]] for people with specific language skills can get easily involved in the work.

	[[Category:Web Compatibility]]		[[Category:Web Compatibility\|Guide]]

Karlcow: /* Bugzilla Conventions for Web Compatibility Issues */ fixing link

2014-05-14T00:45:03Z

Bugzilla Conventions for Web Compatibility Issues: fixing link

← Older revision		Revision as of 00:45, 14 May 2014
Line 115:		Line 115:
	== Bugzilla Conventions for Web Compatibility Issues ==		== Bugzilla Conventions for Web Compatibility Issues ==

	We are using a [[/Compatibility/BugsGuide\|list of conventions]] in the Web Compatibility activity.		We are using a [[Compatibility/BugsGuide\|list of conventions]] in the Web Compatibility activity.

	== Mobile Web Compatibility Issues By Countries ==		== Mobile Web Compatibility Issues By Countries ==