Editing Cheese-E-Pedia in DecapCMS

This page provides an overview of the steps required to edit Cheese-E-Pedia on the web using DecapCMS. This is the primary method of editing content on Cheese-E-Pedia.

Jump to Section:


Here is the general flow for editing a page:

  1. Click “Contribute” and then “Edit Page” while you’re on the page you want to edit.
  2. Login to DecapCMS and start editing the content.
  3. Save, and then mark your content as ready.
  4. Moderators will review your edit(s) and may leave comments to make adjustments.
  5. Once approved, your changes will appear on the site within 5-10 minutes of approval.

Please note that DecapCMS is unfortunately a system with quite a few issues that we are aware of but cannot solve. An alternative editor, Sveltia CMS, is available but does not support the functionality that allows anyone to edit and submit for review. We are expecting that to be ready in early-to-mid 2026. Stay tuned!

We highly reccommend that you store your content in a text file or a notes application if you are making significant edits, just in case you are unable to save and need to try again later.


Intro to DecapCMS

DecapCMS is our primary editor that appears when you click the “Contribute” and then “Edit Page” while you’re reading any page on Cheese-E-Pedia.

To make an edit, go to the page you would like to edit and then click the “Contribute” and then the “Edit Page” button.

DecapCMS will ask you to login with GitHub. At this point, you can make an account on GitHub, or sign in with an existing account.

If you have not made an edit before, DecapCMS will create a clone of Cheese-E-Pedia that stores your changes. When your changes are ready to publish, DecapCMS will push the changes to moderator review on your behalf, without you needing to know how GitHub works.

First Step: Credit Yourself!

Before you make any edits, make sure to add yourself to the contributors list. By adding your name to the list, your name will appear on the page you edited. We have a User List that shows all users and their ranking on our contribution leaderboard based on the number of pages credited to them. Get yourself to the top with high-quality edits!

Second Step: Understand Parameters

Pages on Cheese-E-Pedia use parameters, which are special fields that are parts of the page you are looking at. For example, the title, the body/content, tags, and categories are all parameters.

When you edit a page, you are shown the parameters that are relevant to the type of page you are editing. For example, a general wiki page might have a place to add a store number or a show format. However, a transcriptions page might just have a place to add the name of the showtape it is a transcription of.

Third Step: Editing Markdown and Using Shortcodes

The body content of the site uses Markdown, which provides an easy system to format text. For example, **bold** text is bold and _italicized_ text is italicized.

We also use common shortcodes that help insert links to other pages or external websites without needing to remember the formatting.

When using shortcodes, make sure to use the correct format and to ensure that you always have a closing quote; when using citation shortcodes, make sure you have at least one citation, and that you use a number between 1 and the number of citations, not higher than that! Otherwise, this will cause issues when the wiki gets rebuilt with your changes.

Fourth Step: Save and Mark Ready!

When you’re ready to save your changes, click “Save” on the top of the page, and then click “Publish”/“Ready” – then you’re all set!

What’s Next?

At this point, your edit is now in the review process by the moderation team. When free, they will review your edits and ensure that they meet wiki standards and won’t cause issues when the wiki is rebuilt with your changes. This is done on the GitHub Page in the “Pull Requests” section. Moderators may leave a comment on the edit asking for more info or suggesting changes before merging. Check on your contributions or set up email notifications!

Once your edit is approved, it will be added to the wiki. The wiki automatically rebuilds when any changes are made, but this process can take between 5 to 10 minutes, and then your changes will appear on the live site!


Thank you for contributing to Cheese-E-Pedia!


References

  1. https://cheeseepedia.org
  2. Cheese-E-Pedia