Documentation

Appearance

Get your project featured ​

Built something useful with Dataplicity? We welcome submissions from product teams, customers, educators, and independent makers. A strong submission helps readers understand the real device, the problem it solves, and the part Dataplicity plays after deployment.

Share a real build

Send the story and the evidence

Email the details to the Dataplicity support address with the subject Customer project submission.

Email support@dataplicity.com →

What to submit ​

Please include:

  • Project name and owner: your name, team, or organisation, plus a public website if there is one.
  • The problem and the device: what the project does, the Linux hardware or product involved, and where it operates.
  • Dataplicity's role: for example Remote Shell, Wormhole, fleet organisation, monitoring, logs, alerts, scheduled work, or a support workflow. Describe only features you actually use.
  • A public source where possible: a project page, repository, article, video, product page, or technical guide that corroborates the story.
  • A contact person: someone we can ask for clarifications and publication approval.

Short submissions are fine. Clear facts and useful evidence matter more than polished marketing copy.

Useful evidence and screenshots ​

Choose material that makes the workflow understandable without exposing secrets:

  • A photo of the complete device or product in its real setting
  • A simple architecture diagram showing the device, Dataplicity, and any integration
  • A screenshot of the relevant workflow, with device IDs, customer details, tokens, URLs, and personal data redacted
  • A short video showing the project working
  • A repository, build log, or published write-up
  • For fleet stories, a representative view or diagram rather than confidential fleet data

Use original, high-resolution files where practical. Add a short caption for each asset and tell us who should receive the credit.

Remove sensitive information

Do not send API keys, install commands, credentials, private Wormhole URLs, customer data, precise private locations, or unredacted dashboards. If an image contains operational data, redact it before sending.

Permission and editorial expectations ​

By submitting, you should be able to confirm that:

  1. You have permission to share the project details and every supplied image, video, logo, and quotation.
  2. The named people and organisations have agreed to be identified.
  3. Dataplicity may edit the submission for length, clarity, accessibility, and documentation style.
  4. Dataplicity may publish approved text and assets in its documentation and link to your public source.

Submitting a project does not guarantee publication. Before publishing, we may ask you to substantiate a claim or confirm permissions in writing. We will omit any metric, outcome, quotation, or product use that we cannot substantiate.

If your approval is limited (for example, documentation use only, a required credit line, or an image that must not be used on social media), state that clearly in the email.

A useful submission outline ​

Copy this into your email:

text
Project name:
Project owner / organisation:
Public link:
Contact person:

What the project does:
Device and operating environment:
How Dataplicity is used:
What changed or became possible:

Evidence attached or linked:
Required credits:
Permission or usage limits:

Ready? Email support@dataplicity.com or return to Customer projects.