Review code blocks mixed with output

[lbroudoux]

As a follow-up of #324, we decided that code blocks must not mix commands and result outputs to ease copy/paste button usage. As a consequence we must review existing code blocks and split them into 2 different blocks when appropriate.

[Rupam-It]

hey @lbroudoux I've already implement this (separate the output and command)!

please clarify that , does output section contain copy button?

[divyansh-prks]

when i was researching about this in multiple documnentation i found out a similarity which is that if they need a specific terminal command they are using $ sign but if they need to show any comment then they are not using any $ sign .

Can we also do something similar @lbroudoux ?

[yada]

hey @lbroudoux I've already implement this (separate the output and command)! please clarify that , does output section contain copy button?

Ideally, no (the copy button is not of use for outputs).
But I'm not sure we can specify the "copy button" ON or OFF on the code block using the existing theme (I mean without hacking the theme... as we want to avoid these changes as much as possible): @Rupam-It can you check this point?

[yada]

when i was researching about this in multiple documnentation i found out a similarity which is that if they need a specific terminal command they are using $ sign but if they need to show any comment then they are not using any $ sign .

Can we also do something similar @lbroudoux ?

@divyansh-prks This is nice, but IMHO, we need and would like to use the theme features available and not hack the theme all around (a nightmare for the following theme upgrades). In other words, remove $ in front of commands so the copy button will work as expected and let's keep it simple ;) For output, see my comment to @Rupam-It

[Rupam-It]

hey @lbroudoux I've already implement this (separate the output and command)! please clarify that , does output section contain copy button?

Ideally, no (the copy button is not of use for outputs). But I'm not sure we can specify the "copy button" ON or OFF on the code block using the existing theme (I mean without hacking the theme... as we want to avoid these changes as much as possible): @Rupam-It can you check this point?

so, if the output section start with "output" word then we can on/off copy button!

in this section our motive can be

1. we split the whole section with two one is command and another one is output
2. as output section starts with output , so it's copy button will be off! (by javascript logic)

else we can do that

1. give only command section and give the picture of the output in jpg format!

[yada]

@Rupam-It : it will be simple to use the code block for both command (without $) and output. If the copy button can be enabled or disabled as a built-in feature (without any theme modification), then let's disable it for outputs.

But I do not think (I have not checked deeply) that the copy button can be enabled and disabled without a hack... So let's use the KISS principle and "just":

1. Remove $ from all commands,
2. Separate command from output and keep the copy button on all (command and output) as it is the default behavior...

Ok for all?

[Rupam-It]

@Rupam-It : it will be simple to use the code block for both command (without $) and output. If the copy button can be enabled or disabled as a built-in feature (without any theme modification), then let's disable it for outputs.

But I do not think (I have not checked deeply) that the copy button can be enabled and disabled without a hack... So let's use the KISS principle and "just":

1. Remove $ from all commands,
2. Separate command from output and keep the copy button on all (command and output) as it is the default behavior...

Ok for all?

yeah perfect !
hey @divyansh-prks did you start implementing this?

[Rupam-It]

@Rupam-It : it will be simple to use the code block for both command (without $) and output. If the copy button can be enabled or disabled as a built-in feature (without any theme modification), then let's disable it for outputs.

But I do not think (I have not checked deeply) that the copy button can be enabled and disabled without a hack... So let's use the KISS principle and "just":

1. Remove $ from all commands,
2. Separate command from output and keep the copy button on all (command and output) as it is the default behavior...

Ok for all?

hey Yacine, please take a look the slack once . i have upload one video by implementing the solution!

[yada]

Hi @Rupam-It ,
I saw the video in the Microcks channel in CNCF Slack, but please always update the issue, as it is the source of truth for all exchanges to better follow and track decisions/changes.

But a few comments:
1/
It looks like you have some spaces before the command!

2/
Could you please tell me why you're creating 3 output blocks here? Please use a single block, as it has the same output and no input in the middle.

For me (using https://microcks.io/documentation/guides/installation/podman-compose/ as same example as you), it needs to be:

• block 1 (input with $):
  ./run-microcks.sh

• block 2 (output):

On macos, need to get the userid and groupid from postman machine.
Assuming this machine is named 'podman-machine-default'. Change name in script otherwise.

Starting Microcks using podman-compose ...
------------------------------------------
Stop it with: podman-compose -f microcks.yml --podman-run-args='--userns=keep-id:uid=501,gid=1000' stop
Re-launch it with: podman-compose -f microcks.yml --podman-run-args='--userns=keep-id:uid=501,gid=1000' start
Clean everything with: podman-compose -f microcks.yml --podman-run-args='--userns=keep-id:uid=501,gid=1000' down
------------------------------------------
Go to https://localhost:8080 - first login with admin/microcks123
Having issues? Check you have changed microcks.yml to your platform

• block 3 (input with $):
  podman-compose -f microcks.yml --podman-run-args='--userns=keep-id:uid=501,gid=1000' up -d

In this case, a text explanation and a picture to illustrate it should make your proposition easier to understand (a video is overkill, IMHO).

Important

My recommendation order for this important task 🙏

1. The guidelines should be agreed upon first and written down based on the info above. See: Write a GUIDELINES.md file to provide recommendations on contributions #362
2. Then, assess all documentation and blog pages to be updated and create a sub-issue per page (doc or blog).
   So we are sure to fix all the necessary pages and better follow and ask for collaboration for each sub-issue to share the work.
3. Create a PR per sub-issue (doc or blog) to make it easier to review and merge and ensure we will not miss anything.