Skip to content

Best practices for contributions

Please follow the guidelines below when writing or adding resources to this repository:

  • Use markdown descriptive language for document writing
  • Page names should be set in low caps and with hyphens instead of spaces. Do not use special characters for file names.

To highlight informative elements, warnings, errors or confirmation messages please use text blocks as follow: 

!!! success "Best practice" 
    Confirmation blocks in green should be used to highlight best practices.

Best practice

Confirmation blocks in green should be used to highlight best practices. 

!!! warning "Alternative"
    Yellow warning blocks should be used to mention a different route to achieve a similar result (this is especially helpful for how-to guides)

Alternative

Yellow warning blocks should be used to mention a different route to achieve a similar result (this is especially helpful for how-to guides)

!!! failure "Error"
    Error blocks in red should be used to explain troubleshooting hints or alternative paths to follow to overcome an error.

Error

Error blocks in red should be used to explain troubleshooting hints or alternative paths to follow to overcome an error. 

!!! abstract "Consideración Legal"
    El bloque de información (azul) se utiliza para resaltar consideraciones legales

Legal consideration

The blue block is used to highlight legal considerations.