Skip to content

refactor(docs): Change console to shell and remove unused elements #5960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 1, 2023

Conversation

BrunoQuaresma
Copy link
Collaborator

  • Replace console by shell because it is supported by highlight.js and github
  • Remove -- element. For some reason, our markdown parser is parsing some commands as images

@BrunoQuaresma BrunoQuaresma self-assigned this Feb 1, 2023
@BrunoQuaresma BrunoQuaresma requested a review from bpmct February 1, 2023 17:10
@BrunoQuaresma BrunoQuaresma enabled auto-merge (squash) February 1, 2023 17:11
@@ -59,7 +59,7 @@ downloaded from Maven (https://repo1.maven.org/maven2) and store all data in the
If you are using the built-in PostgreSQL deployment and need to use `psql` (aka
the PostgreSQL interactive terminal), output the connection URL with the following command:

```console
```shell
$ coder server postgres-builtin-url
Copy link
Member

@mafredri mafredri Feb 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should remove these $ signs at the beginning as well since we're using the shell format (and wherever else applicable).

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the diff between keeping the $ and not using it?

@BrunoQuaresma BrunoQuaresma merged commit 61dcf64 into main Feb 1, 2023
@BrunoQuaresma BrunoQuaresma deleted the bq/update-docs branch February 1, 2023 18:27
@github-actions github-actions bot locked and limited conversation to collaborators Feb 1, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants