Adding and editing documentation

This is a documentation page. Click here to go to the full documentation index.
Table of contents

Setup

YAML header

The documentation system uses a YAML header to sort and display in the proper places the different documents composing our documentation. This header stores different information using an internal controlled vocabulary.

Example:

---
title: Adding and editing documentation
section: User guides
category:
audiences:
  - Content contributor
chips:
  - editor
authors:
  - Pagé-Perron, Émilie
---

title

The title variable is the title of the document, it must summarize the content of the whole file.

section

Sections are the broad categorizations for the documentation's content.

  • User guides
  • Contribution and data guides
  • Dev and devops docs

category

The pre-cited sections can be classified further into categories.

  • Search guide
  • Browse guide
  • Features guide
  • Editor guide
  • Data formats and data
  • Contribution guides (data)
  • Contribution guides (code)
  • API usage
  • Style guides
  • Deploy guide
  • Features documentation

audiences

  • Visitor
  • Content contributor
  • Developer
  • Organization

chips

Chips are tags that can be used to help the users visualize topics of interest discussed in the documentation. They do not belong to a restricted list but are more helpful as they repeat.

authors

The full name of each author Last name first, followed by a comma, and then all other names. eg.: Pagé-Perron, Émilie. Each name comes on a separate line and are added in alphabetical order.

Files

  • Filename must be explicit

  • Filename mut contain dashes, not underscores

  • Use the extension .md

  • Images go in the /images folder

    Images will not display when the files are looked at from the cdli_docs repo but they appear when rendered on the website. below is an example of the formating to use for images: ![alt text for testing](/cdli-docs/images/browse_ss1.png) alt text for testing

Cite this Doc
Pagé-Perron, Émilie. 2024. “User Guides: Adding and Editing Documentation.” Cuneiform Digital Library Initiative. April 12, 2024. https://cdli.mpiwg-berlin.mpg.de/docs/adding-and-editing-documentation.
Pagé-Perron, É. (2024, April 12). User guides: Adding and editing documentation. Cuneiform Digital Library Initiative. https://cdli.mpiwg-berlin.mpg.de/docs/adding-and-editing-documentation
Pagé-Perron, É. (2024) User guides: Adding and editing documentation, Cuneiform Digital Library Initiative. Available at: https://cdli.mpiwg-berlin.mpg.de/docs/adding-and-editing-documentation (Accessed: April 12, 2024).
@misc{Page2024User,
	note = {[Online; accessed 2024-04-12]},
	author = {Pag{\' e}-Perron, {\' E}milie},
	year = {2024},
	month = {apr 12},
	title = {User guides: Adding and editing documentation},
	url = {https://cdli.mpiwg-berlin.mpg.de/docs/adding-and-editing-documentation},
	howpublished = {https://cdli.mpiwg-berlin.mpg.de/docs/adding-and-editing-documentation},
}

TY  - ELEC
AU  - Pagé-Perron, Émilie
DA  - 2024/4/12/
PY  - 2024
ID  - temp_id_091812100566
M1  - 2024/4/12/
TI  - User guides: Adding and editing documentation
UR  - https://cdli.mpiwg-berlin.mpg.de/docs/adding-and-editing-documentation

ER  - 
This website uses essential cookies that are necessary for it to work properly. These cookies are enabled by default.