Contributing to the Wiki

Contributing

We welcome contributions to our community powered Wiki

Before editing a file, please read our Documentation Style Guide, to help us maintain consistency across user guidance documentation.

Currently, you need to request to have a wiki account created for you. We hope to have self-service wiki account creation implemented soon.

Once you have a wiki account, login to the account, find the file you would like to edit, and then edit it.

Formatting Hints

Use MediaWiki's Text Formatting Guide, their Cheatsheet, and their Image Guide for screenshots.

Headers

Using H2 headers for title sections can be done with the following code:

== Title Section == 

Pages with three or fewer headings will not have a Table of Contents. In cases where it would be useful to have section-specific header links to send to users, a Table of Contents can be added manually. Paste the below code anywhere on the page to create the Table of Contents in the default position:

__FORCETOC__

Info

To use an Info code block, use:

{{Info|this is info text}}

Caution

To use a Caution code block, use:

{{Caution|this is Caution text}}

Danger

To use a Danger code block, use:

{{Danger|this is danger text}}

Tables

This code:

{| class="wikitable" style="margin:auto"
|+ style="caption-side:top; |'''Table Caption'''
|-
! Header 1 !! Header 2 !! Header 3
|-
| Cell 1 || Cell 2 || Cell 3
|-
| [https://heliohost.org Link 1] || [https://heliohost.org Link 2] || [https://heliohost.org Link 3]
|}

Will display as:

Table Caption

Header 1	Header 2	Header 3
Cell 1	Cell 2	Cell 3
Link 1	Link 2	Link 3

Note: The table caption is optional. If no caption is needed, omit the line

|+ style="caption-side:top; |'''Table Caption'''

Code

Inline Code

For inline code, use <code> and </code>

This syntax:

<code>sudo whoami</code>

Will display as:

sudo whoami

Code Blocks

For code blocks, use <pre> and </pre>

This syntax:

<pre>
#!/usr/bin/python3.12
print("Content-Type: text/html\n\n")
print("Heliohost rules!")
</pre>

Will display as:

#!/usr/bin/python3.12
print("Content-Type: text/html\n\n")
print("Heliohost rules!")

Special Characters

To show < and > in plain text instead of having them interpreted as tags, use < for < and > for >.

Inside Info/Caution/Danger code blocks, use = for = and # for # so they appear as plain text instead of being interpreted as tags.

Variables

Variable	Code to Use	Result
Memory Limit	{{Template:MemoryLimit}}	200 GB
CPU Limit	{{Template:CPULimit}}	10,000 CPU

Other Ways to Help

There are many other ways you can help us keep improving. Learn how you can contribute to our community on our How You Can Help page.