Bug 4617 - Clean up command lines in documentation - use sudo everywhere
Summary: Clean up command lines in documentation - use sudo everywhere
Alias: None
Product: ThinLinc
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 4.0.0
Hardware: PC Unknown
: P2 Normal
Target Milestone: 4.14.0
Assignee: Pierre Ossman
Keywords: prosaic, samuel_tester
Depends on:
Reported: 2013-04-24 11:27 CEST by Peter Åstrand
Modified: 2021-10-29 18:05 CEST (History)
1 user (show)

See Also:
Acceptance Criteria:


Description Peter Åstrand cendio 2013-04-24 11:27:23 CEST
In our TAG, the way we are presenting command lines is not fully consistent: In some cases, we are documenting that you should use "sudo". In many cases, we are not. We should use the same style everywhere.
Comment 2 Pierre Ossman cendio 2021-10-26 14:56:02 CEST
All examples should now follow the same style. As a bonus they also got some basic highlighting.
Comment 3 Samuel Mannehed cendio 2021-10-28 15:41:36 CEST
It seems we have used both `.. code:: console` and `.. code-block:: console` tagging for these types of cases. We should probably standardize on one of them to avoid future problems with styling etc.
Comment 5 Pierre Ossman cendio 2021-10-29 10:47:58 CEST
Everything has now been standardised on code::.
Comment 6 Samuel Mannehed cendio 2021-10-29 13:42:08 CEST
Some sudo's are missing from the "Tip" for tl-ssh-all in commands.html:

> First, setup the SSH key-pair as described below:
>   #
>   # First time / One time procedure
>   #
>   # Generate a private and public key-pair for SSH with SSH keygen.
>   # When prompted pick a secret password for the key-pair.
>   #
>   ssh-keygen -t dsa
>   # Copy the public key to SSH authorized_keys
>   cp /root/.ssh/id_dsa.pub /root/.ssh/authorized_keys
>   # Make sure the authorized key has the right permissions
>   chmod 600 /root/.ssh/authorized_keys
>   # Copy the authorized key to all ThinLinc Agents
>   tl-rsync-all /root/.ssh/authorized_keys
> Next, before using tl-ssh-all, do as follows
>   eval `ssh-agent`
>   ssh-add
>   # Run your commands
>   tl-ssh-all rpm -Uvh /root/kdelibs-3.5.1-1.fc4.i386.rpm

Also, we should probably replace "dsa" with "rsa" there :)
Comment 7 Pierre Ossman cendio 2021-10-29 16:34:33 CEST
I think that tip should probably be removed. It doesn't really fit well with the sudo principle of avoiding switching user to root, since that is effectively what you do if you set up a SSH agent with a key that gives you root access.
Comment 9 Pierre Ossman cendio 2021-10-29 16:36:48 CEST
Section is now removed.
Comment 10 Samuel Mannehed cendio 2021-10-29 18:05:44 CEST
Looks good:

 * All commands now use sudo where appropriate. Note that the instructions for running "install-server" and "tl-setup" don't need sudo in this case since these programs have a built in prompt asking for that.
 * There are no "code-block" left
 * The command styling look good both in the HTML and the PDF
 * The commit removing the tl-ssh-all "Tip" looks good

Note You need to log in before you can comment on or make changes to this bug.