Editing this Wiki

• 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 editing an existing page, don't forget to use restructuredText format.
  • When creating a new page, be sure to select reStructuredText from the Edit mode: dropdown.

• Editing with a git clone.

  • A subdirectory structure is set up in the wiki to help organize content and help with building docs in other formats using Sphinx. This subdirectory structure is invisible to users of the wiki editor.
  • The file namespace in the wiki is flat. All .rest files must have unique names regardless of their seperation in to subdirectories.
  • 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.
  • 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.

• 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.