Skip to content

samples of instructional and informational content

Jinah Yun-Mitchell edited this page May 30, 2024 · 2 revisions

The following sample paragraphs reflect the style our documents should strive to maintain:

Informational Content Sample

Overriding SSH settings on the GitLab server

GitLab integrates with the system-installed SSH daemon and designates a user (typically named git) through which all access requests are handled. Users who connect to the GitLab server over SSH are identified by their SSH key instead of their username. SSH client operations performed on the GitLab server are executed as this user. You can modify this SSH configuration. For example, you can specify a private SSH key for this user to use for authentication requests. However, this practice is not supported and is strongly discouraged as it presents significant security risks.

Instructional Content Sample 1

The service needs to be installed from a Terminal window logged in as your current user. Only then will you be able to manage the service.

To sign in as your current user, run the command su - in the terminal. You can obtain your username by running the command ls /users. Currently, the only proven way for it to work in macOS is by running the service in user-mode.

Since the service will be running only when the user is logged in, you should enable auto-login on your macOS machine.

The service will be launched as a LaunchAgent. By using LaunchAgents, the builds will be able to perform UI interactions, making it possible to run and test in the iOS simulator.

Instructional Content Sample 2

To use Git on the command line, you'll need to download, install, and configure Git on your computer. You can also install GitHub CLI to use GitHub from the command line. For more information, see "About GitHub CLI."

If you want to work with Git locally, but don't want to use the command line, you can instead download and install the GitHub Desktop client. For more information, see "Installing and configuring GitHub Desktop."

Download and install the latest version of Git. Set your username in Git. Set your commit email address in Git.