Skip to main content

GitHub Access

The safest way to let people edit the docs is through GitHub.

  1. Invite the person to the GitHub repository.
  2. Give the lowest permission level they need.
  3. Have them make changes through a branch or pull request.
  4. Review the change before it goes live.
  5. Deploy the update from the server after approval.

Permission Levels​

Use these as a simple guide:

Read: Can view the repo.
Triage: Can help manage issues and discussions.
Write: Can push branches and edit docs.
Maintain: Can manage more repo settings.
Admin: Full control. Use carefully.

For most documentation helpers, Write access is enough.

Do Not Share Server Root Access By Default​

Most contributors do not need SSH or root access to the server.

Give server access only to people who need to deploy, manage Nginx, or manage certificates.

Safer Editing Options​

People can edit docs using:

  • GitHub's web editor.
  • A local Git clone.
  • A branch and pull request.
  • GitHub Codespaces, if enabled.

Suggested Contributor Rule​

Anyone helping with docs can update Markdown pages, but only trusted maintainers should update deployment settings, Nginx config, DNS, secrets, or server commands.