# Brads All Encompassing Compendium of the Entirety of XDR Knowledge

BAECEXD (pronounced "bake ext") is a set of notes about how to actually get things done in XDR. Since XDR is a rapidly evolving landscape, some of these notes are likely to be out of date, flawed, or just outright wrong. Use at your own risk.

## Rules
1. All files MUST follow the naming scheme.
    `<Major Topic> <Minor Topic> Notes.md` e.g. 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>
    ```

    ``` 
    # 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. 
    ```
        
        
3. 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! 

4. Use three backticks to indicate a section of code or terminal output and single backticks to indicate technical commands or terms.

5. When referencing other files use a link in the format `See <file name> for more details.` e.g. See [Salt Notes](Salt%20Notes.md) for more details. 

6. For PRs, push directly to master unless they are major changes.

7. Be kind and think about the engineer after you.


![](https://img.buzzfeed.com/buzzfeed-static/static/enhanced/webdr03/2013/2/26/15/enhanced-buzz-29234-1361911376-25.jpg)
