Getting Started As A Contributor: Difference between revisions

From AgileMe
Jump to navigation Jump to search
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:help]]
[[Category:help]]
Welcome to the [http::/agileme.com.au AgileMe] wiki.
Welcome to the [http://agileme.com.au AgileMe] wiki.


Here are some notes on how to get started and contribute to the wiki:
Here are some notes on how to get started and contribute to the wiki:
Line 7: Line 7:
The mission for the wiki is to provide an open and accessible repository of agile knowledge for all agilists, coaches, scrum masters, product owners, leaders and practitioners.  
The mission for the wiki is to provide an open and accessible repository of agile knowledge for all agilists, coaches, scrum masters, product owners, leaders and practitioners.  


The content ranges from articles, workshop facilitation guides, illustrations and much more, all available under a [https://creativecommons.org/licenses/by-sa/4.0/ Attribution Share Alike International License]
The content ranges from articles, workshop facilitation guides, illustrations and much more, all available under a [https://creativecommons.org/licenses/by-sa/4.0/ Creative Commons Attribution Share Alike International License]


==Getting a Login==
==Getting a Login==
If you don't already know me (Dave) then use the [http://agileme.com.au Contact Us] form to get in touch or use the Gentle Agile Folk slack channel to request a new login.
If you don't already know me (Dave) then use the [http://agileme.com.au Contact Us] form to get in touch or use the '''Gentle Agile Folk''' slack channel to request a new login.


Once created the login will allow you to create new pages and edit existing ones.
Once created the login will allow you to create new pages and edit existing ones.
Line 33: Line 33:


Common categories include:
Common categories include:
* [[:Category:Agile:Articles|Agile Articles]] - insert '''<nowiki>[[Category:Agile:Articles]]</nowiki>''' into your page
* [[:Category:Agile:Articles|Agile Articles]] - insert <code><nowiki>[[Category:Agile:Articles]]</nowiki></code> into your page
* [[:Category:Agile:Scrum|Scrum]] - insert '''<nowiki>[[Category:Agile:Scrum]]</nowiki>''' into your page
* [[:Category:Agile:Scrum|Scrum]] - insert <code><nowiki>[[Category:Agile:Scrum]]</nowiki></code> into your page
* [[:Category:Agile:Kanban|Kanban]] - insert '''<nowiki>[[Category:Agile:Kanban]]</nowiki>''' into your page
* [[:Category:Agile:Kanban|Kanban]] - insert <code><nowiki>[[Category:Agile:Kanban]]</nowiki></code> into your page
* [[:Category:Agile:XP|eXtreme Programming (XP)]] - insert '''<nowiki>[[Category:Agile:XP]]</nowiki>''' into your page
* [[:Category:Agile:XP|eXtreme Programming (XP)]] - insert <code><nowiki>[[Category:Agile:XP]]</nowiki></code> into your page
* [[:Category:Agile:Tools|Agile Tools]] - insert '''<nowiki>[[Category:Agile:Tools]]</nowiki>''' into your page
* [[:Category:Agile:Tools|Agile Tools]] - insert <code><nowiki>[[Category:Agile:Tools]]</nowiki></code> into your page
* [[:Category:Agile:Workshops|Agile Workshops]] - insert '''<nowiki>[[Category:Agile:Workshops]]</nowiki>''' into your page
* [[:Category:Agile:Workshops|Agile Workshops]] - insert <code><nowiki>[[Category:Agile:Workshops]]</nowiki></code> into your page
* [[:Category:Agile:Presentations|Agile Presentations]] - insert '''<nowiki>[[Category:Agile:Presentations]]</nowiki>''' into your page
* [[:Category:Agile:Presentations|Agile Presentations]] - insert <code><nowiki>[[Category:Agile:Presentations]]</nowiki></code> into your page
* [[:Category:Agile:Coaching|Agile Coaching]] - insert '''<nowiki>[[Category:Agile:Coaching]]</nowiki>''' into your page
* [[:Category:Agile:Coaching|Agile Coaching]] - insert <code><nowiki>[[Category:Agile:Coaching]]</nowiki></code> into your page
* [[:Category:Agile:Training|Agile Training]] - insert '''<nowiki>[[Category:Agile:Training]]</nowiki>''' into your page
* [[:Category:Agile:Training|Agile Training]] - insert <code><nowiki>[[Category:Agile:Training]]</nowiki></code> into your page
* [[:Category:Agile:Culture|Agile Culture]] - insert '''<nowiki>[[Category:Agile:Culture]]</nowiki>''' into your page
* [[:Category:Agile:Culture|Agile Culture]] - insert <code><nowiki>[[Category:Agile:Culture]]</nowiki></code> into your page
* [[:Category:Agile:Leadership|Agile Leadership]] - insert '''<nowiki>[[Category:Agile:Leadership]]</nowiki>''' into your page
* [[:Category:Agile:Leadership|Agile Leadership]] - insert <code><nowiki>[[Category:Agile:Leadership]]</nowiki></code> into your page
* [[:Category:Agile:Conferences|Agile Conferences]] - insert '''<nowiki>[[Category:Agile:Conferences]]</nowiki>''' into your page
* [[:Category:Agile:Conferences|Agile Conferences]] - insert <code><nowiki>[[Category:Agile:Conferences]]</nowiki></code> into your page
* [[:Category:Agile|Agile Everything]] - insert '''<nowiki>[[Category:Agile]]</nowiki>''' into your page
* [[:Category:Agile|Agile Everything]] - insert <code><nowiki>[[Category:Agile]]</nowiki></code> into your page


==Headers==
==Headers==
Headers are quite easy:
Headers are quite easy:
* Big Header type in '''<nowiki>=Header=</nowiki>'''
* Big Header type in <code><nowiki>=Header=</nowiki></code>
* Sub Header type in '''<nowiki>==Header==</nowiki>'''
* Sub Header type in <code><nowiki>==Header==</nowiki></code>
* Sub Sub Header type in '''<nowiki>===Header===</nowiki>'''
* Sub Sub Header type in <code><nowiki>===Header===</nowiki></code>


==Bold and Italic==
==Bold and Italic==
* For '''bold''' text type in <nowiki>'''Bold Text Here'''</nowiki>
* For '''bold''' text type in <code><nowiki>'''Bold Text Here'''</nowiki></code>
* For ''italic'' text type in <nowiki>''Italic Text Here''</nowiki>
* For ''italic'' text type in <code><nowiki>''Italic Text Here''</nowiki></code>


==Links==
==Links==
It's quite easy to add links into a page and the following are two methods:
It's quite easy to add links into a page and the following are two methods:
# For a link to another page use <nowiki>[[Page Title]]</nowiki>
# For a link to another page use <code><nowiki>[[Page Title]]</nowiki></code>
# For a link to an external site use <nowiki>[http://mysite.com Caption]</nowiki>
# For a link to an external site use <code><nowiki>[http://mysite.com Caption]</nowiki></code>


==Files==
==Files==
Line 66: Line 66:


Once a file is uploaded you can then embed a link to the file in your article in the following ways:
Once a file is uploaded you can then embed a link to the file in your article in the following ways:
* Ordinary link to the file use <nowiki>[[:File:MyFile.pdf|Link Text Here]]</nowiki>
* Ordinary link to the file use <code><nowiki>[[:File:MyFile.pdf|Link Text Here]]</nowiki></code>
* Want to have a direct link to a downloadable file e.g.a pdf use <nowiki>[[Media:MyFile.pdf|Link Text Here]]</nowiki>
* Want to have a direct link to a downloadable file e.g.a pdf use <code><nowiki>[[Media:MyFile.pdf|Link Text Here]]</nowiki></code>
* Want to display a picture on the page use <nowiki>[[File:MyPicture.jpg|500px|Caption Here]]</nowiki>
* Want to display a picture on the page use <code><nowiki>[[File:MyPicture.jpg|500px|Caption Here]]</nowiki></code>
* Want to display a pdf doc on the page use <nowiki><pdf width="300" height="500">MyFile.pdf</pdf></nowiki>
* Want to display a pdf doc on the page use <code><nowiki><pdf width="300" height="500">MyFile.pdf</pdf></nowiki></code>


For more info on files check out [https://www.mediawiki.org/wiki/Help:Images Wikimedia Images]
For more info on files check out [https://www.mediawiki.org/wiki/Help:Images Wikimedia Images]
Line 89: Line 89:
Type in the following:
Type in the following:


<nowiki>{| class="wikitable"
<code><nowiki>{| class="wikitable"</nowiki></code>
!Header #1
 
!Header #2
<code><nowiki>!Header #1</nowiki></code>
|-
 
|Item #1
<code><nowiki>!Header #2</nowiki></code>
|Item #2
 
|-
<code><nowiki>|-</nowiki></code>
|Item #3
 
|Item #4
<code><nowiki>|Item #1</nowiki></code>
|}</nowiki>
 
<code><nowiki>|Item #2</nowiki></code>
 
<code><nowiki>|-</nowiki></code>
 
<code><nowiki>|Item #3</nowiki></code>
 
<code><nowiki>|Item #4</nowiki></code>
 
<code><nowiki>|}</nowiki></code>


For more info on tables check out [https://www.mediawiki.org/wiki/Help:Tables Wikimedia Tables]
For more info on tables check out [https://www.mediawiki.org/wiki/Help:Tables Wikimedia Tables]
==See Also==
It is really good to add in a "See Also" footer to your pages as this is where links to related docs can be found and is really helpful for a reader to navigate and find your contributions
==References==
Remember that the site content is under a Creative Commons license, so if you want attribution to your work, then pay it back by also providing attribution and citations to work that you have referenced.
This also shows where you got your ideas from, provides some legitimacy to the work and allows a further reading on the subject for the reader.

Latest revision as of 02:12, 24 November 2018

Welcome to the AgileMe wiki.

Here are some notes on how to get started and contribute to the wiki:

Intent

The mission for the wiki is to provide an open and accessible repository of agile knowledge for all agilists, coaches, scrum masters, product owners, leaders and practitioners.

The content ranges from articles, workshop facilitation guides, illustrations and much more, all available under a Creative Commons Attribution Share Alike International License

Getting a Login

If you don't already know me (Dave) then use the Contact Us form to get in touch or use the Gentle Agile Folk slack channel to request a new login.

Once created the login will allow you to create new pages and edit existing ones.

Rules

There are only two rules:

  1. If you can't find a page, create one
  2. If you do find a page, correct it

Writing A New Article

Creating A New Page

It can be frustrating to want to get started and not see how to create a new page. There are two ways to do this:

  1. Enter your page title in the search bar and the results page will show a red link to the page name, click on the link and then you should be able to edit your new page
  2. Embed a link into an existing page and when you next read the page it will show the link as a red link. Click on the red link and then you should be in an edit window for that page

Categories

Each page should be linked to a category and the convention at the moment is to put a category as the very first line of the page when in edit mode.

Categories are like lists of pages and so adding a new page to a category immediately means it is not an orphaned page and can be found in a category.

Multiple categories can be added e.g. if a page is a scrum related article then we might like to add it to the Agile, Agile:Articles and Agile:Scrum categories, and it can then be searched under each of those categories.

Common categories include:

Headers

Headers are quite easy:

  • Big Header type in =Header=
  • Sub Header type in ==Header==
  • Sub Sub Header type in ===Header===

Bold and Italic

  • For bold text type in '''Bold Text Here'''
  • For italic text type in ''Italic Text Here''

Links

It's quite easy to add links into a page and the following are two methods:

  1. For a link to another page use [[Page Title]]
  2. For a link to an external site use [http://mysite.com Caption]

Files

Use the "Upload" file link on the nav bar (left hand side) to upload files. (A maximum file size is limited to 32 Mb.)

Once a file is uploaded you can then embed a link to the file in your article in the following ways:

  • Ordinary link to the file use [[:File:MyFile.pdf|Link Text Here]]
  • Want to have a direct link to a downloadable file e.g.a pdf use [[Media:MyFile.pdf|Link Text Here]]
  • Want to display a picture on the page use [[File:MyPicture.jpg|500px|Caption Here]]
  • Want to display a pdf doc on the page use <pdf width="300" height="500">MyFile.pdf</pdf>

For more info on files check out Wikimedia Images

Tables

Tables are a bit long winded but to get the following table:

Header #1 Header #2
Item #1 Item #2
Item #3 Item #4

Type in the following:

{| class="wikitable"

!Header #1

!Header #2

|-

|Item #1

|Item #2

|-

|Item #3

|Item #4

|}

For more info on tables check out Wikimedia Tables

See Also

It is really good to add in a "See Also" footer to your pages as this is where links to related docs can be found and is really helpful for a reader to navigate and find your contributions

References

Remember that the site content is under a Creative Commons license, so if you want attribution to your work, then pay it back by also providing attribution and citations to work that you have referenced.

This also shows where you got your ideas from, provides some legitimacy to the work and allows a further reading on the subject for the reader.