-
Notifications
You must be signed in to change notification settings - Fork 225
fix: documentation styling codeblocks #2802
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
base: develop
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some blocks need revisiting, overall looks good.
|
||
For example, the following Central Server packages are currently installed. | ||
|
||
```bash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why remove bash
from some of these?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The reason is, at first I only paid attention to remove the indented blocks. only afterwards I thought about correct format and changed the blocks again.
Error: The locale requested by the environment is invalid. | ||
Error: could not create default cluster. Please create it manually with pg_createcluster 10 main –start, | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some of these error notification example blocks use bash
. This one doesn't, we should decide on one approach or the other and then use it consistently.
If generation was successful the output should be simply: | ||
|
||
```bash | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here as well, why remove bash
?
Add the key id to `/etc/xroad/conf.d/local.ini` file (editing the file requires restarting X-Road services), e.g.: | ||
```bash | ||
```basinih |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am guessing this should be ini
?
* Network connections to PostgreSQL port (tcp/5432) are allowed from the Central Server to the remote database server. | ||
1. Shutdown X-Road processes. | ||
1. Shutdown X-Road processes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Two spaces between the numbering and text seems strange, is this intended?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did so, because it was also done in other documents, like ug-sc_x-road_signer-console_user_guide.md:306
But its not done in this file, so I will make it 1.
ChallengeResponseAuthentication no | ||
PasswordAuthentication no | ||
```bash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is probably more ini
than bash
.
[message-log] | ||
archive-transfer-command=/usr/share/xroad/scripts/archive-http-transporter.sh -r http://my-archiving-server/cgi-bin/upload | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should probably be ini
.
|
||
[op-monitor-buffer] | ||
size = 0 | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably should be ini
.
To edit the value of a system parameter already inserted into the *system_parameters* table: | ||
|
||
UPDATE system_parameters SET value = '*parameter_value*', updated_at = (now() at time zone 'utc') WHERE key = 'parameter_name'; | ||
```bash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have a sql
option, it would be more appropriate?
No description provided.