README.md 1.3 KB

Brads All Encompassing Compendium of the Entirety of XDR Knowledge

Rules

  1. All files MUST follow the naming scheme. MDR <Major Topic> <Minor Topic> Notes.md e.g. MDR Salt Upgrade Notes.md . The first letter of each word should be capitalized.
  2. All files MUST follow the proper markdown format. ( work in progress )

    # <filename>
     <Description of notes or project>
         
     ---
     <Section Title>
     <Today's date>
         
     <arbitrary notes>
         
     ---
     <Section Title>
     <Today's date>
         
     <arbitrary notes>
    

    ```

    # MDR Salt Notes.md
    Salt is the configuration management tool
    
    ---
    Section 1
    02/28/2020
    
    Salt sucks and we should use puppet.
    
    ---
    Section 2
    03/15/2020
    
    Salt version 2019.2.3 should always be made public on the internet. 
    ```
    
    1. To add a newline that is visible in markdown on the github website, add two newlines to the .md file. DO NOT add <br> or \ to the ends of lines. The primary place to view these files is in a text editor not on github website!

    2. When referencing other files use this format See <file name> for more details. e.g. See MDR Salt Upgrade Notes.md for more details.