Fixed broken link.
← Older revision
Revision as of 19:09, 11 January 2013
(9 intermediate revisions by one user not shown)
Line 2:
Line 2:
−
=Getting
Started
contributing content=
+
=Getting
started
contributing content=
Anyone can contribute to this WebPlatform wiki. All of the steps are outlined in the [[WPD:Editors_Guide|Editor's Guide]].
Anyone can contribute to this WebPlatform wiki. All of the steps are outlined in the [[WPD:Editors_Guide|Editor's Guide]].
Line 8:
Line 8:
There are many ways to contribute that take varying amounts of time and expertise. It is best to start with the simplest, fastest tasks, and move on to more complicated tasks as you gain expertise and experience. You can make meaningful contributions whether you have [[#Five-minute tasks|five minutes]], [[#Half-hour tasks|half an hour]], or [[#Half-day tasks|half a day]].
There are many ways to contribute that take varying amounts of time and expertise. It is best to start with the simplest, fastest tasks, and move on to more complicated tasks as you gain expertise and experience. You can make meaningful contributions whether you have [[#Five-minute tasks|five minutes]], [[#Half-hour tasks|half an hour]], or [[#Half-day tasks|half a day]].
−
The community is friendly and welcoming to newcomers; if you ever have any questions, [[WPD:
Help
|just ask the community on IRC or e-mail]]
!
+
The community is friendly and welcoming to newcomers; if you ever have any questions, [[WPD:
Editors_Guide/step_2_communicate_with_the_online_community
| just ask the community on IRC or e-mail]]
.
+
[[File:get_start.png]]
[[File:get_start.png]]
Line 17:
Line 18:
Tasks provide you with a way to roll up your sleeves and contribute; these take varying amounts of time and expertise. It is usually best to start with the simplest, fastest tasks and move on to make more complicated changes as you gain expertise and experience. You can make meaningful contributions whether you have five minutes, half an hour, or half a day.
Tasks provide you with a way to roll up your sleeves and contribute; these take varying amounts of time and expertise. It is usually best to start with the simplest, fastest tasks and move on to make more complicated changes as you gain expertise and experience. You can make meaningful contributions whether you have five minutes, half an hour, or half a day.
−
'''For specific things to do''', visit the [[WPD:Most_Wanted_Tasks|
WPD
Most Wanted]] page, to find high priority
pages
that that you can
work on
right now.
+
'''For specific things to do''', visit the [[WPD:Most_Wanted_Tasks|Most Wanted
Tasks
]] page, to find high priority
changes
that that you can
accomplish
right now.
−
'''
If you want to create a new tutorial or concept page''' see the guide for authoring [[WPD:Content/Tutorials_and_concept_articles| tutorials and concept articles]].
+
If you want to
'''
create a new tutorial or concept page''' see the guide for authoring [[WPD:Content/Tutorials_and_concept_articles| tutorials and concept articles]].
−
'''
If you want to create a
new
reference page
, or edit an existing one
''' read the instructions for [[WPD:Content/Reference_articles| reference articles]].
+
If you want to
'''
create
or edit
a reference page''' read the instructions for [[WPD:Content/Reference_articles| reference articles]].
===Five-minute tasks===
===Five-minute tasks===
−
* '''Correct grammar and spelling mistakes''' Pages with the [[Special:SearchByProperty/Content-20quality-20flag/Grammar-2FSpelling|grammar flag checked]]
need some
attention to fix grammar and spelling mistakes. Often these changes require no knowledge of
MediaWiki
or web development domain expertise
to help with
,
which makes them
great
starter issues
to
focus on
. See [[WPD:Flags/Content_Grammar_Spelling|for more information
]]
.
+
* '''Correct grammar and spelling mistakes''' Pages with the [[Special:SearchByProperty/Content-20quality-20flag/Grammar-2FSpelling|grammar flag checked]]
require
attention to fix grammar and spelling mistakes. Often these changes require no knowledge of
the wiki syntax
or web development domain expertise,
so fixing these changes is a
great
way
to
get started
. See
the page that describes
[[WPD:Flags/Content_Grammar_Spelling|
Content Grammar and Spelling guidelines]]
for more information.
−
* '''
Fill in
missing summaries''' Most pages should include a short summary section that
gives
an overview of the article
and is
used to generate automatic overview pages. Writing a summary
normally
requires just writing a sentence or two in your own words. You can find
all pages that don't have summaries but should
[http://docs.webplatform.org/w/index.php?title=Special:WhatLinksHere/Template:Editorial/Needs_Summary&hidelinks=1&hideredirs=1
here
].
+
* '''
Author
missing summaries''' Most pages should include a short summary section that
provides
an overview of the article
. Summaries are
used to generate automatic overview pages. Writing a summary requires just writing a sentence or two in your own words. You can find [http://docs.webplatform.org/w/index.php?title=Special:WhatLinksHere/Template:Editorial/Needs_Summary&hidelinks=1&hideredirs=1
all pages that need summaries
]
and start adding them
.
−
* '''
Filling
in missing compatibility information''' Some pages have compatibility tables with missing cells
, which you can find on
[http://docs.webplatform.org/w/index.php?title=Special%3AWhatLinksHere&target=Template%3ACompat+Unknown&namespace=
this list
]. Generally the information can be verified by comparing a couple of other sources (such as http://caniuse.com/
)
and then
inputting
the values in the form.
There is a
[http://docs.webplatform.org/wiki/WPD:Getting_Started/Compatibility
detailed getting started guide suitable for new WPD contributors
].
+
* '''
Fill
in missing compatibility information''' Some pages have compatibility tables with missing cells
. These pages are
[http://docs.webplatform.org/w/index.php?title=Special%3AWhatLinksHere&target=Template%3ACompat+Unknown&namespace=
listed here
]. Generally
,
the information can be verified by comparing a couple of other sources (such as
[
http://caniuse.com/
www.caniuse.com] or the [http://www.quirksmode.org/compatibility.html www.quirksmode.org site]. Identify the compatibility for each browser,
and then
enter
the values in the form.
See the
[http://docs.webplatform.org/wiki/WPD:Getting_Started/Compatibility
Compatibility page
]
to learn more
.
−
* '''
Data
not semantic'''
On Web Platform Docs, we use
Semantic Media Wiki and Semantic Forms to organize information in a structured way. Sometimes, however, data is represented on a page in an unstructured field. Often it
's
as simple as moving bits of content from one text box to another.
The
[[WPD:Flags/Data_Not_Semantic|
Data Not Semantic flags page
]]
has more information
.
+
* '''
Identify data that is
not semantic'''
WebPlatform uses
Semantic Media Wiki and Semantic Forms to organize information in a structured way. Sometimes, however, data is represented on a page in an unstructured field. Often it
is
as simple as moving bits of content from one text box to another.
See the
[[WPD:Flags/Data_Not_Semantic|
list of pages that are not semantic
]].
−
* '''
Biased
content'''
WPD
is
supposed
to
be a
vendor-neutral documentation
site
, so
efforts need to be made to remove
biased information. For example,
have
you
found
a section that
talks about
a feature as if it
is
only
usable
in a certain browser, or a section of code that could work across all browsers, but won't because it only uses one or two browsers' vendor prefixes
? Please amend
these
accordingly
,
or at least check
the [[Special:SearchByProperty/Content-20quality-20flag/Biased-20Voice|Biased Voice]] flag in the edit form.
+
* '''
Update biased
content'''
One of the goals of WebPlatform
is to
offer
vendor-neutral documentation, so
you can help improve imported content by removing
biased information. For example,
if
you
find
a section that
describes
a feature as if it
can
only
be used
in a certain browser, or a section of code that could work across all browsers, but
currently
won't because it only uses one or two browsers' vendor prefixes
, please edit
these
pages. If you cannot update them yourself
,
be sure to enable
the [[Special:SearchByProperty/Content-20quality-20flag/Biased-20Voice|Biased Voice]] flag in the edit form
, so someone else can update the page
.
−
* '''
Setting appropriate
flags'''
If you press
the edit button at the top of an article
, you can
check the different flag
checkboxes
at the top of the edit form to
indicate what
tasks
need
to
be done on that article
.
+
* '''
Mark pages using
flags'''
Press
the edit button at the top of an article
to
check the different flag
check boxes
at the top of the edit form
. Flagging pages is critical
to
help other contributors find
tasks to
do
.
−
* '''
Fixing
broken links''' Broken links are fairly easy to spot on
WPD - they should be
highlighted in a [[albatross/my broken link example|bold red
colour
]]. Please
repair
any you find, or at least check the [[Special:SearchByProperty/Content-20quality-20flag/Broken-20Links|Broken Links]] flag.
+
* '''
Fix
broken links''' Broken links are fairly easy to spot on
the wiki. Misspelled words are
highlighted in a [[albatross/my broken link example|bold red
color
]]. Please
fix
any
misspelled words
you find, or at least check the [[Special:SearchByProperty/Content-20quality-20flag/Broken-20Links|Broken Links]] flag.
* '''Add more useful links''' Feel free to add useful, relevant links to external resources to show more examples to illustrate a technique or technology.
* '''Add more useful links''' Feel free to add useful, relevant links to external resources to show more examples to illustrate a technique or technology.
−
* '''
Add
the correct code syntax coloring to code blocks''' See [[WPD:Style_Manual#Code_syntax_highlighting|our code coloring guide]] for details
of how
.
+
* '''
Apply
the correct code syntax coloring to code blocks''' See [[WPD:Style_Manual#Code_syntax_highlighting|our code coloring guide]] for details.
−
* '''
Watch Recent Changes for improper
changes'''
It always helps to have someone keeping an eye on
the [[Special:RecentChanges|Recent Changes]] list to help find cases where new editors might need a bit of guidance to contribute productively and
according
to
the norms of the community
.
+
* '''
Review the recent
changes
and look for mistakes to fix
'''
Check out
the [[Special:RecentChanges|Recent Changes]] list to help find cases where new editors might need a bit of guidance to contribute productively
,
and
ensure we are all following the guidelines
to
author and edit pages
.
===Half-hour tasks===
===Half-hour tasks===