How to contribute: Difference between revisions

From Open SaaS Wiki
Jump to navigation Jump to search
(Created page with "Every member of the Open SaaS Institute Community is wholeheartedly invited to contribute to the Open SaaS Institutes Wiki. Here is a short guide on how to do that: == First things first == * '''Become a Member''' of the OSI Community. Simply [https://theopensaasinstitute.slack.com join our Slack Workspace] and introduce yourself in the channel "#3_introductions". (Please use the same name you use in your professional everyday life.) * '''Register as a user in this Wik...")
 
(added "talk pages" and a link to mediawiki of how to operate talk pages)
 
(7 intermediate revisions by one other user not shown)
Line 14: Line 14:
* [https://www.mediawiki.org/wiki/Help:Formatting Here is an overview] of '''how to format''' your wiki content.
* [https://www.mediawiki.org/wiki/Help:Formatting Here is an overview] of '''how to format''' your wiki content.
* And [https://www.mediawiki.org/wiki/Help:Links here are instructions] on '''how to create links''' to internal and external pages.
* And [https://www.mediawiki.org/wiki/Help:Links here are instructions] on '''how to create links''' to internal and external pages.
* '''Mathematical Formulas''' use a special markup language called <code><math></code> and can become pretty complex - You can find [https://www.mediawiki.org/wiki/Extension:Math/Help:Formula instructions here].
If you don't want to dive too deep, you can also always use the WYSIWYG Editor for simple edits.
== How to edit a page ==
You can edit every page in this entire Wiki. Yes, really: '''every page is editable'''
(Ok, we might protect ''some'' pages from editing if they belong to the Wikis critical infrastructure, or if they are prone to vandalism.)
* Please use the '''[[Sandbox Page]]''' to play around and test your skills.
* Use the ''EDIT'' link on top of each page to edit the page with the Simple Editor.
* Or click on ''EDIT SOURCE'' to edit a page using the ''wikitext'' markup language.
== How to create a New Page ==
Mediawiki has essentially two standard ways of creating a new page:
* '''Search for a page''' - If it doesn't exist, you can create it by clicking on <span style="padding:2px 5px 2px 5px;background:#F0F0F0;>''Create the page <Searchterm> on this wiki''</span> which is displayed along with the message that the search term couldn't be found.
or
* '''Link to a non-existing page''' - if you link to an internal page, that doesn't yet exists a <span style="color:#DD0000;">red-colored link</span> is created. By clicking on that link, you are directed directly to editing the new page.
== Talk pages ==
A talk page is available for each wiki page, providing a space for users to interact, exchange ideas and engage in discussions with others.
[[mediawikiwiki:Help:Talk_pages|Here is an overview]] of '''how to operate''' the talk page.
== Don't do evil! ==
''"With great power comes great responsibility"'' - is what Peter Parker (aka Spiderman) was told. Please be a responsible and considerate spider when you help building this network of knowledge on our wiki and adhere to these rules:
* '''Don't reinvent the wheel''' - please make sure you don't create pages with duplicate content. Search first, before you decide to create a new page.
* '''Follow examples''' - There are templates for special pages. Please familiarize yourself with similar pages, before you create a new one.
** Here is '''a template for a new proposed Standard''': '''[[OSI-RFC Template]]'''
* '''Make sure you are familiar with the process''' of proposing a new standard by first reading [[Request for Comment (OSI-RFC)]] article.
* Once you created a new OSI-RFC please '''post it to our slack channel''' for further discussion.

Latest revision as of 12:52, 8 March 2023

Every member of the Open SaaS Institute Community is wholeheartedly invited to contribute to the Open SaaS Institutes Wiki. Here is a short guide on how to do that:

First things first

  • Become a Member of the OSI Community. Simply join our Slack Workspace and introduce yourself in the channel "#3_introductions". (Please use the same name you use in your professional everyday life.)
  • Register as a user in this Wiki by clicking on "Create Account" on the top right of the screen.
  • Go to the channel "#6_help_and_questions" in the Slack community and ask for your Wiki Account to be enabled. You are making it easier when you copy-paste the link to your Wiki Profile to the Slack Channel. The link to your Wiki Profile is on the top of the page (hint:It's your name)

Learn to how to wiki

The Open SaaS Institutes Wiki uses Mediawiki as its technology platform. It is the same technology Wikipedia was built upon.

All pages are written in a markup language often referred to as wikitext. It's very powerful, robust, and yet simple to learn.

If you don't want to dive too deep, you can also always use the WYSIWYG Editor for simple edits.

How to edit a page

You can edit every page in this entire Wiki. Yes, really: every page is editable

(Ok, we might protect some pages from editing if they belong to the Wikis critical infrastructure, or if they are prone to vandalism.)

  • Please use the Sandbox Page to play around and test your skills.
  • Use the EDIT link on top of each page to edit the page with the Simple Editor.
  • Or click on EDIT SOURCE to edit a page using the wikitext markup language.

How to create a New Page

Mediawiki has essentially two standard ways of creating a new page:

  • Search for a page - If it doesn't exist, you can create it by clicking on Create the page <Searchterm> on this wiki which is displayed along with the message that the search term couldn't be found.

or

  • Link to a non-existing page - if you link to an internal page, that doesn't yet exists a red-colored link is created. By clicking on that link, you are directed directly to editing the new page.

Talk pages

A talk page is available for each wiki page, providing a space for users to interact, exchange ideas and engage in discussions with others.

Here is an overview of how to operate the talk page.

Don't do evil!

"With great power comes great responsibility" - is what Peter Parker (aka Spiderman) was told. Please be a responsible and considerate spider when you help building this network of knowledge on our wiki and adhere to these rules:

  • Don't reinvent the wheel - please make sure you don't create pages with duplicate content. Search first, before you decide to create a new page.
  • Follow examples - There are templates for special pages. Please familiarize yourself with similar pages, before you create a new one.
  • Make sure you are familiar with the process of proposing a new standard by first reading Request for Comment (OSI-RFC) article.
  • Once you created a new OSI-RFC please post it to our slack channel for further discussion.