Remove dollar sign on command shells (#216)

* fix: remove dollar sign on command shells

Signed-off-by: Reza Rachmanuddin <[email protected]>

* Revert a few changes and complete the work

Signed-off-by: Venu Vardhan Reddy Tekula <[email protected]>

Signed-off-by: Reza Rachmanuddin <[email protected]>
Signed-off-by: Venu Vardhan Reddy Tekula <[email protected]>
Co-authored-by: Venu Vardhan Reddy Tekula <[email protected]>

Author: retry19

CONTRIBUTING.md

@@ -18,10 +18,10 @@ or suggest something. Any feedback is appreciated!
 
 If you are willing to setup the tutorial locally
 ```bash
-$ git clone https://github.com/chaoss/grimoirelab-tutorial
-$ cd grimoirelab-tutorial
-$ bundle
-$ bundle exec jekyll serve
+git clone https://github.com/chaoss/grimoirelab-tutorial
+cd grimoirelab-tutorial
+bundle
+bundle exec jekyll serve
 ```
 
 **Note:** Make sure you have git and ruby (version 2.7.x) installed.
@@ -43,37 +43,37 @@ which is a fork (copy) of the GrimoireLab Tutorial.
 2. Clone the forked git repository, and create in a local branch for your 
 contribution.
 
-```
-$ git clone https://github.com/username/grimoirelab-tutorial/
-$ cd grimoirelab-tutorial/
-$ git checkout -b new-branch-name
+```bash
+git clone https://github.com/username/grimoirelab-tutorial/
+cd grimoirelab-tutorial/
+git checkout -b new-branch-name
 ```
 
 3. In this repository, set up a remote for the upstream (original grimoirelab-tutorial) 
 git repository.
 
-```
-$ git remote add upstream https://github.com/chaoss/grimoirelab-tutorial/
+```bash
+git remote add upstream https://github.com/chaoss/grimoirelab-tutorial/
 ```
 
 4. Now you can change the documentation and then commit it. Except that the 
 contribution really needs it, use a single commit, and comment in detail in the 
 corresponding commit message what it is intended to do. If it fixes some bug, 
 reference it (with the text "_Fixes #23_", for example, for issue number 23).
 
-```
-$ git add -A
-$ git commit -s
+```bash
+git add -A
+git commit -s
 ```
 
 5. Once your contribution is ready, rebase your local branch with `upstream/master`, 
 so that it merges clean with that branch, and push your local branch to a remote 
 branch to your GitHub repository.
 
-```
-$ git fetch upstream
-$ git rebase upstream/master
-$ git push origin new-branch-name
+```bash
+git fetch upstream
+git rebase upstream/master
+git push origin new-branch-name
 ```
 
 6. In the GitHub interface, produce a pull request from your branch (you will 
@@ -97,7 +97,7 @@ For ensuring it, a bot checks all incoming commits.
 For users of the git command line interface, a sign-off is accomplished with the 
 `-s` as part of the commit command:
 
-```
+```bash
 git commit -s -m 'This is a commit message'
 ```
 

basics/dockerhub.md

@@ -7,14 +7,14 @@ For using these container images, ensure you have a recent version of `docker` i
 To try `grimoirelab/full`, just type:
 
 ```bash
-$ docker run -p 127.0.0.1:5601:5601 \
-    -v $(pwd)/credentials.cfg:/override.cfg \
-    -t grimoirelab/full
+docker run -p 127.0.0.1:5601:5601 \
+  -v $(pwd)/credentials.cfg:/override.cfg \
+  -t grimoirelab/full
 ```
 
 `credentials.cfg` should have a GitHub API token, in  `mordred.cfg` format:
 
-```
+```cfg
 [github]
 api-token = XXX
 ```
@@ -28,15 +28,15 @@ The resulting dashboard will be available from Kibiter, and you can see it by po
 What is even more interesting: you can get a shell in the container (after launching it), and run arbitrary GrimoireLab commands (`container_id` is the identifier of the running container, that you can find out with `docker ps`, or by looking at the first line when running the container):
 
 ```bash
-$ docker exec -it container_id env TERM=xterm /bin/bash
+docker exec -it container_id env TERM=xterm /bin/bash
 ```
 
 If you're running the container on Windows through Docker Quickstart Terminal and Oracle VirtualBox, additional steps need to be taken to access the dashboard from your Windows machine. First, you then want to go into the settings for the virtual machine through the VirtualBox manager. To accomplish this, click on your VM, and click on 'Settings'. Now go to the 'Network' tab and you should see two adapters, we want to reconfigure adapter 1. Change the 'Attached to' setting to 'Bridged Adapter', open up the Advanced dropdown, and change the Promiscuous Mode to 'Allow VMs'. Now change Bridged Adapter to NAT and click on Port Forwarding. Here you need to set up a rule that allows port 5601 on the VM to talk to localhost:5601 on your host machine. To do this, click the green diamond with a '+' inside it to add a new rule. Name this rule whatever you wish, set its protocol to TCP, host IP to 127.0.0.1, Host Port to 5601, leave Guest IP blank, and set Guest Port to 5601 and click OK. While you're in settings, I recommend upping the memory for your VM to 2048MB, and setting display memory to 10MB. After you've done this you can now exit all the way out of settings. You now need to stop the docker container if it's currently running, shut down your VM, and restart your VM. Once the VM is restarted, you'll need to run ``ifconfig | grep inet`` on the virtual machine the container is running on to find its local IP address, most likely it will be along the lines of 10.0.2.x. Now rerun 
 
 ```bash
-$ docker run -p x.x.x.x:5601:5601 \
-    -v $(pwd)/credentials.cfg:/override.cfg \
-    -t grimoirelab/full
+docker run -p x.x.x.x:5601:5601 \
+  -v $(pwd)/credentials.cfg:/override.cfg \
+  -t grimoirelab/full
 ```
 but replace the x'ed out IP address with the IP address of your VM that you got from `ifconfig`. If all goes well, once you see the docker command line print out "Elasticsearch Aliased: Created!", you should be able to go to 127.0.0.1:5601 on your host machine web browser and be able to access the GrimoireLab dashboard.
 
@@ -48,7 +48,7 @@ Have a look at the section
 
 If you happen to run the container in Windows, remember that you should use backslash instead of slash for the paths related to Windows. That means that paths internal to the container will still include slashes, but those that refer to files or directories in the host machine will include backslashes, and maybe disk unit identifiers. For example:
 
-```
-$ docker run -p 127.0.0.1:5601:5601 -v D:\test\credentials.cfg:/override.cfg \
+```bash
+docker run -p 127.0.0.1:5601:5601 -v D:\test\credentials.cfg:/override.cfg \
   -v D:\test\projects.json:/projects.json -t grimoirelab/full
 ```

basics/install.md

@@ -104,7 +104,7 @@ This should produce a banner with information about command line arguments, and
 
 Assuming everything was fine, next thing is getting information about an specific backend. Let's start with the git backend, which will be a good starter for testing:
 
-```
+```bash
 (gl) $ perceval git --help
 ```
 
@@ -208,14 +208,14 @@ Some of GrimoireLab dependencies need non-Python packages as pre-requisites to b
 
 * For `dulwich` to be installed, you need to have some Python libraries present. In Debian-derived systems (such as Ubuntu), that can be done by installing the `python3-dev` package:
 
-```
-$ sudo apt-get install python3-dev
-$ sudo apt-get install build-essential
+```bash
+sudo apt-get install python3-dev
+sudo apt-get install build-essential
 ```
 
 Usually, you know you need this when you have a problem installing `dulwich`. For example, you check the output of `pip install` and you find:
 
-```
+```bash
 dulwich/_objects.c:21:10: fatal error: Python.h: No such file or Directory
 ```
 
@@ -230,7 +230,7 @@ Previous instructions are for installing the Python packages corresponding to th
 It is designed to work standalone, with just a few dependencies. It is easy to produce a Python virtual environment with all GrimoireLab tools (and dependencies) installed, corresponding to the latest version in the master branch of each of the development repositories. Just the utility, and run:
 
 ```bash
-$ python3 build_grimoirelab --install --install_venv /tmp/ivenv
+python3 build_grimoirelab --install --install_venv /tmp/ivenv
 ```
 
 This will create a virtual environment in `/tmp/ivenv`, which can be activated as follows
@@ -248,19 +248,19 @@ $ source /tmp/ivenv/bin/activate
 [releases directory](https://github.com/chaoss/grimoirelab/tree/master/releases) and run (assuming you downloaded the release file `elasticgirl.21` to the current directory):
 
 ```bash
-$ python3 build_grimoirelab --install --install_venv /tmp/ivenv --relfile elasticgirl.21
+python3 build_grimoirelab --install --install_venv /tmp/ivenv --relfile elasticgirl.21
 ```
 
 If you want, you can also produce the Python packages (wheels and dists) for any release, or the latest versions in development repositories. For example, for building packages for the latest versions in directory `/tmp/dists`:
 
 ```bash
-$ python3 build_grimoirelab --build --distdir /tmp/ivenv
+python3 build_grimoirelab --build --distdir /tmp/ivenv
 ```
 
 You can get a listing of all the options of `build_grimoirelab` by using its `--help` flag:
 
 ```bash
-$ python3 build_grimoirelab --help
+python3 build_grimoirelab --help
 ```
 
 There is some explanation about some of them in the

basics/quick.md

@@ -29,13 +29,13 @@ Please check the [section on installing non-Python
 packages](install.html#non-python-pkgs) if you have any trouble.
 
 ```bash
-(gl) % pip3 install grimoirelab
+(gl) $ pip3 install grimoirelab
 ```
 
 If everything went well, you can just check the version that you installed:
 
 ```bash
-(gl) % grimoirelab -v
+(gl) $ grimoirelab -v
 ```
 
 And that's it. You can now skip the rest of this chapter
@@ -54,7 +54,7 @@ standard Debian distro, so you can run those directly.
 To run that image, just type:
 
 ```bash
-% docker run -p 127.0.0.1:9200:9200 \
+docker run -p 127.0.0.1:9200:9200 \
     -p 127.0.0.1:5601:5601 \
     -p 127.0.0.1:3306:3306 \
     -e RUN_MORDRED=NO \
@@ -74,7 +74,7 @@ Once the container is running, you can connect to it,
 and launch any GrimoireLab command or program in it:
 
 ```bash
-$ docker exec -it container_id env TERM=xterm /bin/bash
+docker exec -it container_id env TERM=xterm /bin/bash
 ```
 
 That container can be used also, as such,

basics/supporting.md

@@ -33,20 +33,20 @@ provided the right version of Python is available. In other platforms, your mile
 Python3 is a standard package in Debian, so it is easy to install:
 
 ```bash
-$ sudo apt-get install python3
+sudo apt-get install python3
 ```
 
 Once installed, you can check the installed version:
 
 ```bash
-$ python3 --version
+python3 --version
 ```
 
 For installing some other Python modules, including GrimoireLab modules, you will need `pip` for Python3. For using `venv` virtual environments, you will also need `ensurepip`. Both are available in Debian and derivatives as packages `python3-pip` and `python3-venv`:
 
 ```bash
-$ sudo apt-get install python3-pip
-$ sudo apt-get install python3-venv
+sudo apt-get install python3-pip
+sudo apt-get install python3-venv
 ```
 
 More information about installing Python3 in other platforms is available in [Properly installing Python](http://docs.python-guide.org/en/latest/starting/installation/). In addition, you can also check information on [how to install pip](https://pip.pypa.io/en/stable/installing/).
@@ -56,7 +56,7 @@ More information about installing Python3 in other platforms is available in [Pr
 If you are retrieving data from git repositories, you will need git installed. Pretty simple:
 
 ```bash
-$ sudo apt-get install git-all
+sudo apt-get install git-all
 ```
 
 More information about installing git in other platforms is available in
@@ -71,7 +71,7 @@ For installing Elasticsearch you can follow its [installation instructions](http
 Assuming the installed ElasticSearch directory is `elasticsearch`, to launch it you will just run the appropriate command \(no need to run this from the virtual environment\):
 
 ```bash
-$ elasticsearch/bin/elasticsearch
+elasticsearch/bin/elasticsearch
 ```
 
 This will launch Elasticsearch that will listen via its HTTP REST API at `http://localhost:9200`. You can check that everything went well by pointing your web browser to that url, and watching the ElasticSearch welcome message.
@@ -91,7 +91,7 @@ You can install Kibana instead of Kibiter. Maybe you will lose some functionalit
 Assuming the installed Kibana directory is `kibana`, to launch it, again just run the appropriate command:
 
 ```bash
-$ kibana/bin/kibana
+kibana/bin/kibana
 ```
 
 This should serve a Kibana instance in `http://localhost:5601`. Point your web browser to that url, and you´ll see the Kibana welcome page.
@@ -105,7 +105,7 @@ Now, we´re ready to go.
 Instead of following the installation instructions mentioned above, you can also install ElasticSearch and Kibana as a Docker container, by using pre-composed images. For example:
 
 ```bash
-$ docker run -d -p 9200:9200 -p 5601:5601 nshou/elasticsearch-kibana
+docker run -d -p 9200:9200 -p 5601:5601 nshou/elasticsearch-kibana
 ```
 
 Then you can connect to Elasticsearch by localhost:9200 and its Kibana front-end by localhost:5601. See [details about these Docker images in DockerHub](https://hub.docker.com/r/nshou/elasticsearch-kibana/)
@@ -116,7 +116,7 @@ Then you can connect to Elasticsearch by localhost:9200 and its Kibana front-end
 If you are going to use SortingHat, you will need a database. Currently, MySQL-like databases are supported. In our case, we will use MariaDB. Installing it in Debian is easy:
 
 ```bash
-$ sudo apt-get install mariadb-server
+sudo apt-get install mariadb-server
 ```
 
 That's it, that's all.

docs/data-sources/add-configurations.md

@@ -66,8 +66,8 @@ out_index = git_study_forecast
 Once you have made the following changes, run your containers with
 docker-compose
 
-```console
-$ docker-compose up -d
+```bash
+docker-compose up -d
 ```
 
 Give it some time to gather the data and after a while your dashboard and data

docs/getting-started/dev-setup.md

@@ -130,8 +130,8 @@ mariadb:
 ```
 
 Save the above into a docker-compose.yml file and run
-```console
-$ docker-compose up -d
+```bash
+docker-compose up -d
 ```
 to get Elasticsearch, Kibiter and MariaDB running on your system.
 
@@ -159,26 +159,26 @@ Each local repo should have two `remotes`: `origin` points to the forked repo,
 while `upstream` points to the original CHAOSS repo.
 
 An example is provided below.
-```console
-$ git remote -v
+```bash
+git remote -v
 origin	https://github.com/valeriocos/perceval (fetch)
 origin	https://github.com/valeriocos/perceval (push)
 upstream	https://github.com/chaoss/grimoirelab-perceval (fetch)
 upstream	https://github.com/chaoss/grimoirelab-perceval (push)
 ```
 
 In order to add a remote to a Git repository, you can use the following command:
-```console
-$ git remote add upstream https://github.com/chaoss/grimoirelab-perceval
+```bash
+git remote add upstream https://github.com/chaoss/grimoirelab-perceval
 ```
 
 #### ProTip
 
 You can use this use this
 [script](https://gist.github.com/vchrombie/4403193198cd79e7ee0079259311f6e8) to
 automate this whole process.
-```console
-$ python3 glab-dev-env-setup.py --create --token xxxx --source sources
+```bash
+python3 glab-dev-env-setup.py --create --token xxxx --source sources
 ```
 
 ### Setting up PyCharm
@@ -255,7 +255,7 @@ url = http://localhost:9200
 Run the following commands, which will collect and enrich the data coming from
 the git sections and upload the corresponding panels to Kibiter:
 
-```console
+```bash
 micro.py --raw --enrich --cfg ./setup.cfg --backends git cocom
 micro.py --panels --cfg ./setup.cfg
 ```