snowplow / snowplow/documentation

Add maxLength property to the docs page

Open
#703 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
8
Forks
9
Avg merge
1d 23h
Merged PRs (30d)
18

Description

Hi Team,

Can we please add the maxLength property to the canonical fields docs page?
This will help customers understand the failure reasons and max length allowed for canonical properties.

https://docs.snowplow.io/docs/understanding-your-pipeline/canonical-event/
https://github.com/snowplow/iglu-central/blob/master/schemas/com.snowplowanalytics.snowplow/atomic/jsonschema/1-0-0

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the canonical event docs page linked in the issue and compare its canonical properties with the linked Iglu schema. Confirm the maxLength value and related failure reasons, then document the maxLength property and allowed length on that page.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.