Add shell annotations on code blocks in English docs. #1801
Conversation
Added annotations for a lot of markdown code blocks that were missing the shell annotation to highlight them correctly.
| C:\Users\Name\djangogirls> myvenv\Scripts\activate | ||
| ``` | ||
|
|
||
| > __NOTE:__ On Windows 10 you might get an error in the Windows PowerShell that says `execution of scripts is disabled on this system`. In this case, open another Windows PowerShell with the "Run as Administrator" option. Then try typing the following command before starting your virtual environment: | ||
| > | ||
| >{% filename %}command-line{% endfilename %} | ||
| >``` | ||
| >```powershell |
There was a problem hiding this comment.
I like the idea but if it starts with $ (or #) and then a shell command it's actually console.
The problem is that we also have many examples where it writes the full prompt instead of $. That's usually not a bad thing because the path does provide additional context that's useful, but it doesn't work well with syntax highlighting. I'm not sure what's best there.
| @@ -24,7 +24,7 @@ Now you should see an interface with a sidebar, buttons at the left. | |||
| Click "Terminal" button to open terminal window with prompt like this: | |||
|
|
|||
| {% filename %}Terminal{% endfilename %} | |||
| ``` | |||
| ```shell | |||
There was a problem hiding this comment.
This isn't shell, but console
| @@ -53,7 +53,7 @@ Now you should see an interface with a sidebar, a big main window with some | |||
| text, and a small window at the bottom that looks something like this: | |||
|
|
|||
| {% filename %}bash{% endfilename %} | |||
| ``` | |||
| ```shell | |||
There was a problem hiding this comment.
This is more like console, but that doesn't recognize a full prompt (like a full PS1 variable: https://docs.pulpproject.org/pulpcore/configuration/settings.html#pulp-settings).
| @@ -69,7 +69,7 @@ bigger. | |||
| 4. Click on the Tools dropdown list (at the bottom left side of the window), then on Terminal button to open terminal tab with a prompt like this: | |||
|
|
|||
| {% filename %}Terminal{% endfilename %} | |||
| ``` | |||
| ```shell | |||
| @@ -29,7 +29,7 @@ All you need to do is find a directory in which you want to create the `virtuale | |||
| For this tutorial we will be using a new directory `djangogirls` from your home directory: | |||
|
|
|||
| {% filename %}command-line{% endfilename %} | |||
| ``` | |||
| ```shell | |||
There was a problem hiding this comment.
This is very common in this file, so I'm not commenting it on every line.
| ```shell | |
| ```console |
|
I used shell as the docs appear to be using HighlightJS, and the documentation says that Having never used Edit: |
|
Hello, could you enable me for write access to the repo? I would like to commit changes by resolving conflicts. |
Which repo, @shweta-borganve? For contributions to https://github.com/DjangoGirls/tutorial please "fork" it on GitHub, make your changes in your "fork" or push them there, then file a pull request. For https://github.com/techdragon/tutorial, @techdragon would have to decide whether to give you push access, but also there you could work with pull requests. Is this related to this PR here (#1801 «Add shell annotations on code blocks in English docs.»)? If needed I can give some pointers on how to get its commit into your own fork of https://github.com/DjangoGirls/tutorial, so that you can build upon it. |
|
@das-g Thank you very much for details, I will proceed accordingly and contact if needed. |
Changes in this pull request: