Updated markdown styling with markdownlint

00-prerequisites/README.md

@@ -2,16 +2,16 @@
 
 To be able to participate in the workshop exercises that will take place, you
 will have to have a basic setup of development tools on your machine. We have
-prepared a variety of solutions for you to achieve this setup. 
+prepared a variety of solutions for you to achieve this setup.
 
 Which solution should I use? It depends :-)
 
-- **VirtualBox:** Good for in-person workshops. Ensures coherent setup for all 
+- **VirtualBox:** Good for in-person workshops. Ensures coherent setup for all
   participants, and makes life easier for trainers.
-- **Local setup:** Good for new developers. Ensures your environment is ready 
+- **Local setup:** Good for new developers. Ensures your environment is ready
   doing development after having completed the tutorials.
-- **Vagrant:** Similar to VirtualBox, but requires to also have Vagrant 
-  installed. 
+- **Vagrant:** Similar to VirtualBox, but requires to also have Vagrant
+  installed.
 
 ## VirtualBox (for workshops)
 

01-getting-started/README.md

@@ -13,8 +13,8 @@ First ensure you have prepared your environment according to
 First, open a terminal and checkout the trainings' source code:
 
 ```bash
-$ cd ~/src
-$ git clone https://github.com/inveniosoftware/training.git
+cd ~/src
+git clone https://github.com/inveniosoftware/training.git
 ```
 
 **Tip:** To copy/paste into the terminal inside the Ubuntu virtual machine
@@ -25,42 +25,42 @@ use: Ctrl+Shift+V (paste), Ctrl+Shift+C (copy), Ctrl+Shift+X (cut).
 Scaffold the skeleton for your first Invenio instance:
 
 ```bash
-$ cookiecutter gh:inveniosoftware/cookiecutter-invenio-instance -c v3.4 --no-input
+cookiecutter gh:inveniosoftware/cookiecutter-invenio-instance -c v3.4 --no-input
 ```
 
 ## Step 4: Install
 
 Navigate to the scaffolded code, and start the Docker services (database, Elasticsearch, RabbitMQ and Redis cache):
 
 ```bash
-$ cd my-site
-$ docker-compose up -d
+cd my-site
+docker-compose up -d
 ```
 
 Install and build the Python and NPM dependencies:
 
 ```bash
-$ ./scripts/bootstrap
+./scripts/bootstrap
 ```
 
 ## Step 5: Run
 
 Setup the database tables, search indexes, queues and caches:
 
 ```bash
-$ ./scripts/setup
+./scripts/setup
 ```
 
 Start a development server and background job worker:
 
 ```bash
-$ ./scripts/server
+./scripts/server
 ```
 
 Last, open [https://127.0.0.1:5000/](https://127.0.0.1:5000/) in your browser:
 
 ```bash
-$ firefox https://127.0.0.1:5000/
+firefox https://127.0.0.1:5000/
 ```
 
 Firefox and other browsers will display a security warning because we are trying

03-infrastructure-tour/README.md

@@ -28,11 +28,11 @@ commands:
 
 ```bash
 # Build our Invenio application images first
-$ ./docker/build-images.sh
-$ docker-compose -f docker-compose.full.yml up -d
+./docker/build-images.sh
+docker-compose -f docker-compose.full.yml up -d
 ```
 
-To make sure our instance is running properly, open <https://localhost>
+To make sure our instance is running properly, open <https://localhost:5000>
 
 Here's a full diagram of what the `docker-compose.full.yml` infrastructure
 looks like:
@@ -232,11 +232,11 @@ The load balancer, being at the edge of our infrastructure, besides serving
 the web application at <https://localhost>, is also exposing a statistics
 panel at <http://localhost:8080>:
 
-![](./images/haproxy.png)
+![HAProxy](./images/haproxy.png)
 
 ## What did we learn
 
-![](./images/diagram-labels.png)
+![Diagram Labels](./images/diagram-labels.png)
 
 - The different services composing an Invenio instance
 - How to interface with them on a basic level

04-running-invenio/README.md

@@ -22,8 +22,8 @@ First, let's bring back the basic development container setup:
 
 ```bash
 # Bring down the full setup
-$ docker-compose -f docker-compose.full.yml stop
-$ docker-compose up -d
+docker-compose -f docker-compose.full.yml stop
+docker-compose up -d
 ```
 
 We are now running only the database, Elasticsearch, Redis and RabbitMQ

05-customizing-invenio/README.md

@@ -155,7 +155,7 @@ If we want to be more precise and change a concrete CSS rule we can add it direc
 After changing the file, we have to rebuild our assets using the `invenio
 webpack` command:
 
-```bash
+```console
 (my-site) $ invenio webpack buildall
 ...webpack
 ```
@@ -166,7 +166,7 @@ If we reload our page now we should see our brand new design:
 
 You can watch for changes and automatically rebuild the assets by running:
 
-```bash
+```console
 (my-site) $ invenio webpack run start
 ```
 
@@ -242,7 +242,7 @@ export const MysiteResultsGridItem = ({ result, index }) => {
 
 Again, we'll have to run the `invenio webpack buildall` command:
 
-```bash
+```console
 (my-site) $ invenio webpack buildall
 ...webpack
 ```

06-developing-with-invenio/README.md

@@ -48,7 +48,7 @@ The documentation has already written basic information for you. However you can
 
 Build documentation:
 
-```bash
+```console
 (my-site)$ python setup.py build_sphinx
 ```
 
@@ -80,7 +80,7 @@ To run the tests you can use the test script provided in the repository (the scr
 
 To run the test functions one by one you should activate the virtualenv of your project and use pytest command, like on the example below:
 
-```bash
+```console
 (my-site)$ pytest tests/api/test_api_record_files.py::test_record_creation
 ```
 
@@ -114,7 +114,7 @@ Run tests again:
 
 In order to test a new package, simply install it in the virtualenv using `pip` tool:
 
-```bash
+```console
 (my-site)$ pip install Pillow
 ```
 

07-data-models-new-field/README.md

@@ -109,7 +109,7 @@ We have created and started a new DB and ES along with the updated schemas and m
 **Note**: Make sure you have up and running our development server by running:
 
 ```bash
-$ ./scripts/server
+./scripts/server
 ```
 
 Run the below command to create our new record:
@@ -189,7 +189,7 @@ Our new record was successfully created!
 **Note**: Make sure you have up and running our development server by running:
 
 ```bash
-$ ./scripts/server
+./scripts/server
 ```
 
 Let's search now for our newly created record. Replace the `<id>` with the actual `id` of the

08-data-models-from-scratch/README.md

@@ -24,14 +24,18 @@ such as storing and searching.
 - [What did we learn](#what-did-we-learn)
 
 ## Step 1: Bootstrap exercise
+
 ### 1.1
+
 If you completed the previous tutorial, you can skip this step. If instead you would like to start from a clean state run the following commands:
 
 ```bash
 cd ~/src/training/
 ./start-from.sh 07-data-models-new-field
 ```
+
 ### 1.2
+
 **Note**: In order to reduce the amount of code that we need to write we have prepared beforehand the module structure in `/08-data-models-from-scratch/author_module` folder in which will go through and **uncomment** the needed code snippets to enable different functionalities and eventually build our module!
 
 Run the below command to copy the module over: