Site participation / media

Add images with technical context.

Images can make a packet diagram, terminal result, or platform note easier to understand. This guide explains how to prepare useful media for Tping while keeping permissions, metadata, accessibility, and sensitive network details in view.

media-review — checklist
$ review-image --page "tcp-notes
data:      diagram.png
alt:       present
scope:     non-sensitive
license:   documented
status:    ready for review

[note ] crop private hostnames
[note ] include source details
result useful, attributable media

Before uploading

Make every image explain something.

A strong image supports a specific technical point. Prefer clear diagrams, carefully redacted captures, and platform illustrations over decorative media that adds visual weight without evidence.

Good candidates

Useful media is legible at documentation width and directly connected to the surrounding text.

  • Protocol diagrams showing fields, flows, or relationships.
  • Terminal or tool output with credentials and private identifiers removed.
  • Platform-specific screenshots that clarify an installation or configuration step.
  • Original figures with a short explanation of what readers should notice.

Review questions

Before submitting, check the image as carefully as you would check a command example.

  • Can the important labels be read on a small screen?
  • Is the image necessary for the page rather than merely attractive?
  • Do you have permission to share the image and its underlying material?
  • Could it expose a private network, user, token, or internal hostname?

Submission workflow

Prepare, describe, review.

A consistent process keeps the archive understandable and reduces the chance that an image carries hidden operational or licensing risk.

01 / Prepare

Remove sensitive detail

Crop or redact credentials, addresses, hostnames, private diagrams, and anything not required to explain the technical point.

02 / Describe

Write useful metadata

Choose a descriptive filename and concise alternative text. State what the image shows, not just what file type it is.

03 / Review

Confirm rights and context

Record the source or license, link the image to the relevant page, and explain where it belongs before requesting review.

Safety baselineNever upload packet captures, screenshots, or diagrams containing credentials, personal data, private infrastructure details, or information from a system you are not authorized to disclose.

Practical specification

A compact media brief.

Use this checklist in the edit notes accompanying an image. It gives reviewers enough context to evaluate the contribution without requiring sensitive material.

Include with the submission

  • Page or section where the image should appear.
  • One-sentence purpose and the key visual detail.
  • Alternative text for readers who cannot see the image.
  • Source, author, or license information.
  • Any edits, redactions, or simplifications made.

Have media to review?

Send the page context, a rights note, and a safe preview. Do not email private captures or confidential network information.

Contact Tping