Editing this Wiki

• This wiki contains the CIME Users and Developers guides as well as other pages related to CIME.

• The Users and Developers guide pages should always use restructuredText markup format. Other pages can use the default Markdown.

• Wiki pages can be edited either through the web page (like a wiki) or via a clone of the repository https://github.com/ESMCI/cime.wiki.git (editing source code with your favorite text editor and using git commands to update)

• Editing through the web interface

  • When creating a new page for the Users or Developers guide, be sure to select reStructuredText from the Edit mode: dropdown.

• Editing with a git clone.

  • The file namespace in the wiki is flat. All files must have unique names regardless of their seperation in to subdirectories.

  • Files should be named with dashes between words which will become the page name. The wiki will render the page name without dashes.

  • If someone using the web interface created a new page, it will be in the top level directory. If necessary, please move it to the related subdirectory.

  • If someone changed the name of a file with the web interface, it will be in the top level directory. If necessary, please move it to the related subdirectory.

  • Editing the Users or Developers guide with git clone.

    • When creating a new page with a text editor, use the .rest file suffix
    • New pages go under the "source" subdirectory of the main subdirectory. This is for building pdfs with Sphinx.

• If adding a new page which should be at the top level, add it to the sidebar (which must be done via git clone.)

• To learn more about using reStructuredText and Sphinx, see the Getting Started page.