Getting started with Kuma

  • Revision slug: Project:Getting_started_with_Kuma
  • Revision title: Getting started with Kuma
  • Revision id: 296067
  • Created:
  • Creator: Sheppy
  • Is current revision? No
  • Comment

Revision Content

{{ draft() }}

This article will cover the differences between the current MindTouch wiki that powers MDN and the new Kuma wiki that we will be switching to very soon. The Kuma developers will be giving us an initial list of the big differences, and the writing team will build it out as we experiment with the new software. Stay tuned!

Servers

Environment URL Purpose
Dev https://developer-dev.allizom.org/ Newest features and fixes are added immediately after they pass code review.
Stage https://developer.allizom.org/ Beta features and fixes that will go on the next push to production.
Prod https://developer-new.mozilla.org/

The actual live server that we will promote to production when we cut over to Kuma for realz.

Note: The data here is real. Do not make trashy edits.

Things that work differently

Redirects

The syntax for redirects has changed. You now type the word "REDIRECT" followed by a standard HTML link to the page to redirect to. Switch to source editing mode, then type something like:

REDIRECT <a class="redirect" href="/destination/url/here">some title text here</a>

The URL (href) must be a full path from the base of the site, like "/en-US/docs/foo". Relative URLs will not work.

New features of Kuma

Localization and Translation

KumaScript

See Introduction to KumaScript

Things Kuma can't do

Automating and feeds

Kuma offers an an API for retrieving information and (eventually) automatically updating content. See The Kuma API for details.

Additionally, Kuma provides a number of RSS feeds that you can use to monitor the site. See Kuma RSS feeds.

See also

Revision Source

<p>{{ draft() }}</p>
<p>This article will cover the differences between the current MindTouch wiki that powers MDN and the new Kuma wiki that we will be switching to very soon. The Kuma developers will be giving us an initial list of the big differences, and the writing team will build it out as we experiment with the new software. Stay tuned!</p>
<h2 id="Servers">Servers</h2>
<table border="1" cellpadding="1" cellspacing="1" style="table-layout: fixed; width: 100%;">
  <thead>
    <tr>
      <th scope="col">Environment</th>
      <th scope="col">URL</th>
      <th scope="col">Purpose</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>Dev</td>
      <td><a class="link-https" href="https://developer-dev.allizom.org/" rel="freelink">https://developer-dev.allizom.org/</a></td>
      <td>Newest features and fixes are added immediately after they pass code review.</td>
    </tr>
    <tr>
      <td>Stage</td>
      <td><a class="link-https" href="https://developer.allizom.org/" rel="freelink">https://developer.allizom.org/</a></td>
      <td>Beta features and fixes that will go on the next push to production.</td>
    </tr>
    <tr>
      <td>Prod</td>
      <td><a class="link-https" href="https://developer-new.mozilla.org/" rel="freelink">https://developer-new.mozilla.org/</a></td>
      <td>
        <p>The actual live server that we will promote to production when we cut over to Kuma for realz.</p>
        <div class="warning">
          Note: The data here is real. Do not make trashy edits.</div>
      </td>
    </tr>
  </tbody>
</table>
<h2 id="Things_that_work_differently">Things that work differently</h2>
<h3 id="Redirects">Redirects</h3>
<p>The syntax for redirects has changed. You now type the word "REDIRECT" followed by a standard HTML link to the page to redirect to. Switch to source editing mode, then type something like:</p>
<pre>
REDIRECT &lt;a class="redirect" href="/destination/url/here"&gt;some title text here&lt;/a&gt;</pre>
<p>The URL (href) must be a full path from the base of the site, like "/en-US/docs/foo". Relative URLs will not work.</p>
<h2 id="New_features_of_Kuma">New features of Kuma</h2>
<h3 id="Localization_and_Translation">Localization and Translation</h3>
<h3 id="KumaScript">KumaScript</h3>
<p>See <a href="/Project:en/Introduction_to_KumaScript" title="/Project:en/Introduction to KumaScript">Introduction to KumaScript</a></p>
<h2 id="Things_Kuma_can't_do">Things Kuma can't do</h2>
<h2>Automating and feeds</h2>
<p>Kuma offers an an API for retrieving information and (eventually) automatically updating content. See <a href="/en-US/docs/Project:The_Kuma_API" title="/en-US/docs/Project:The_Kuma_API">The Kuma API</a> for details.</p>
<p>Additionally, Kuma provides a number of RSS feeds that you can use to monitor the site. See <a href="/en-US/docs/Project:Kuma_RSS_feeds" title="/en-US/docs/Project:Kuma_RSS_feeds">Kuma RSS feeds</a>.</p>
<h2 id="See_also">See also</h2>
<ul>
  <li><a href="/Project:en/Introduction_to_KumaScript" title="/Project:en/Introduction to KumaScript">Introduction to KumaScript</a></li>
  <li><a href="/Project:en/KumaScript_reference" title="Project:en/KumaScript reference">KumaScript reference</a></li>
  <li><a class="link-https" href="https://wiki.mozilla.org/MDN/Kuma" title="https://wiki.mozilla.org/MDN/Kuma">Kuma wiki</a></li>
</ul>
Revert to this revision