Difference between revisions of "Editing Wiki"

From SdNOG wiki
Jump to navigation Jump to search
m (Text replacement - "SdNOG" to "sdnog")
m
 
(24 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:sdnog]]
+
[[Category:SdNOG]]
This page will guide you to know how to edit the wiki.
+
[[File:info-icon.png|30px]] This page will mention some guidelines to edit the wiki pages, We recommend to check this page first before starting editing. and if you have any questions don't hesitate to send an email to  info@sdnog.sd<br>
 +
[[File:info-icon.png|30px]] Since [[SdNOG-5|sdnog-5]] we decided to write '''sdnog''' all in '''lowercase'''.
  
Categories that we have:
+
== Editing a page ==
* Best Practices‏‎: include all the procedures to do an activity
+
 
* Events‏‎: For sdnog events, meetings, forums and workshops ....etc
+
* Each page you will write need to be linked to other page, or mentioned on other page. otherwise the page will be orphaned and no one will access it.
* Hardware‏‎: To list all sdnog equipments, stationaries or any countable things.
+
* Each page and image need to be tagged to one/more Category. on the top of the page add these lines:
* Logistics: All sdnog logistic things.
+
<pre>
* Plans‏‎: include sdnog plans for any activity
+
[[Category:name_of_Category1]]
* sdnog‏‎: General category for all sdnog pages
+
[[Category:name_of_Category2]]
* Setup‏‎: Technical details for sdnog activity
+
e.g: [[Category:SdNOG]]
* Sponsors‏‎: List All sdnog Sponsor for any event or activity
+
</pre>
* Templates‏‎: All sdnog letters, reports, emails ... templates
+
 
* Workshops‏‎: list all sdnog’s workshops and its profile.
+
and here a list of the '''categories''' we have:
 +
* Announcement‏‎  : for sdnog announcements and advertisements
 +
* Best Practices ‏‎: technical guides for configuring, setup a network stuff
 +
* Bureaucracy‏‎    : for administration use.
 +
* Events‏‎         : for sdnog activities like: conference, workshop, forum, online-course,...
 +
* Feedback‏‎      : for Survey and comments about sdnog activities
 +
* Icon‏‎          : for icons that been used in this wiki.
 +
* Logistics‏‎      : for the administrative,logistic work to organise sdnog activity
 +
* People‏‎        : sdnog team, voulunteers ...etc
 +
* Plans‏‎         : for future use. things need to be done
 +
* SdNOG‏‎          : this is the master category for this wiki.
 +
* Sponsors‏‎      : about sdnog sponsors
 +
* Store‏‎          : to list sdnog stuff, what we have in our stock
 +
* Templates‏‎      : text formats can be used for adv, announcement ...etc
 +
* Workshops‏‎      : sdnog activities workshop, fourm, online-course ...etc
 +
 
 +
== Drawing a Flowchart ==
 +
To draw a flowchart or gantt chart use [https://www.mediawiki.org/wiki/Extension:Mermaid Mermaid] extension. at this [https://sandbox.semantic-mediawiki.org/wiki/Mermaid page] you find the syntax for mermaid diagrams
 +
 
 +
== Adding an Image ==
 +
 
 +
== Adding an Icon ==
 +
 
 +
We have already uploaded some icons, please note before uploading a new icon; check if it is already here or not.
 +
 
 +
{| class="wikitable sortable"
 +
|-
 +
! icon !! used for !! example
 +
|-
 +
| [[File:Check-icon.png|40px]] || check-icon for listing or checking lists || [[Post-event Activities]]
 +
|-
 +
| [[File:Info-icon.png|50px]]  || info-icon for notification and box-message || Example
 +
|-
 +
| [[File:Warning-icon.png|50px]] || warning-icon for notification and box-message || Example
 +
|-
 +
| [[File:Feedback-icon.png|40px]] || feedback-icon for surveys and comments || Example
 +
|}
 +
 
 +
==== Upload new icon ====
 +
* get the transparent version
 +
* name the icon photo as same format
 +
<pre>
 +
{name-icon}
 +
e.g Check-icon
 +
e.g Info-icon
 +
</pre>
 +
* make sure to add the icon to the "icon category"
 +
<pre>
 +
[[Category:icon]]
 +
</pre>
 +
 
 +
==Adding a text message box ==

Latest revision as of 23:22, 19 March 2022

Info-icon.png This page will mention some guidelines to edit the wiki pages, We recommend to check this page first before starting editing. and if you have any questions don't hesitate to send an email to info@sdnog.sd
Info-icon.png Since sdnog-5 we decided to write sdnog all in lowercase.

Editing a page

  • Each page you will write need to be linked to other page, or mentioned on other page. otherwise the page will be orphaned and no one will access it.
  • Each page and image need to be tagged to one/more Category. on the top of the page add these lines:
[[Category:name_of_Category1]]
[[Category:name_of_Category2]]
e.g: [[Category:SdNOG]]

and here a list of the categories we have:

  • Announcement‏‎ : for sdnog announcements and advertisements
  • Best Practices ‏‎: technical guides for configuring, setup a network stuff
  • Bureaucracy‏‎ : for administration use.
  • Events‏‎ : for sdnog activities like: conference, workshop, forum, online-course,...
  • Feedback‏‎ : for Survey and comments about sdnog activities
  • Icon‏‎ : for icons that been used in this wiki.
  • Logistics‏‎ : for the administrative,logistic work to organise sdnog activity
  • People‏‎ : sdnog team, voulunteers ...etc
  • Plans‏‎ : for future use. things need to be done
  • SdNOG‏‎ : this is the master category for this wiki.
  • Sponsors‏‎ : about sdnog sponsors
  • Store‏‎ : to list sdnog stuff, what we have in our stock
  • Templates‏‎ : text formats can be used for adv, announcement ...etc
  • Workshops‏‎ : sdnog activities workshop, fourm, online-course ...etc

Drawing a Flowchart

To draw a flowchart or gantt chart use Mermaid extension. at this page you find the syntax for mermaid diagrams

Adding an Image

Adding an Icon

We have already uploaded some icons, please note before uploading a new icon; check if it is already here or not.

icon used for example
Check-icon.png check-icon for listing or checking lists Post-event Activities
Info-icon.png info-icon for notification and box-message Example
Warning-icon.png warning-icon for notification and box-message Example
Feedback-icon.png feedback-icon for surveys and comments Example

Upload new icon

  • get the transparent version
  • name the icon photo as same format
{name-icon}
e.g Check-icon
e.g Info-icon
  • make sure to add the icon to the "icon category"
[[Category:icon]]

Adding a text message box