Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add docs for impression data #1328

Merged
merged 15 commits into from
Feb 8, 2022
Merged

Conversation

FredrikOseberg
Copy link
Contributor

@FredrikOseberg FredrikOseberg commented Feb 3, 2022

  • Add documentation that details the new impression data feature

@vercel
Copy link

vercel bot commented Feb 3, 2022

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/unleash-team/unleash-docs/4vEGoWA3qu3mJ4XrVRvdVzrEXm8u
✅ Preview: https://unleash-docs-git-docs-impression-data-unleash-team.vercel.app

@github-actions
Copy link

github-actions bot commented Feb 3, 2022

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements 91.39% 4734/5180
🟢 Branches 80.27% 724/902
🟢 Functions 86.63% 1108/1279
🟢 Lines 91.31% 4636/5077

Test suite run success

789 tests passing in 116 suites.

Report generated by 🧪jest coverage report action from 8ef9fed

Copy link
Contributor

@thomasheartman thomasheartman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work 🙌🏼 I think this is a really good starting point and that it covers a lot of the most important parts of the feature. I think it could benefit from some work on the structure, though.

Personally, I'd like to see a clearer description of what impression data is, what form it takes (e.g. what data does it carry), and how you use it.

Outlined the way it is now, it's more like a how-to guide (which is great, but not the same as reference documentation as defined by diataxis). I can see a single paragraph on "how to enable it" being useful though.

That said, I'm very happy to discuss this, and I also wouldn't mind taking a stab at reorganizing it a bit if you'd want?

Edit

Oh, and I chucked in a couple minor suggestions that jumped out at me regarding syntax highlighting, documentation ordering, and a sentence potentially missing a word 🤓

website/docs/advanced/impression_data.md Outdated Show resolved Hide resolved
website/docs/advanced/impression_data.md Outdated Show resolved Hide resolved
website/docs/advanced/impression_data.md Outdated Show resolved Hide resolved
website/sidebars.js Outdated Show resolved Hide resolved
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
@FredrikOseberg
Copy link
Contributor Author

Great work 🙌🏼 I think this is a really good starting point and that it covers a lot of the most important parts of the feature. I think it could benefit from some work on the structure, though.

Personally, I'd like to see a clearer description of what impression data is, what form it takes (e.g. what data does it carry), and how you use it.

Outlined the way it is now, it's more like a how-to guide (which is great, but not the same as reference documentation as defined by diataxis). I can see a single paragraph on "how to enable it" being useful though.

That said, I'm very happy to discuss this, and I also wouldn't mind taking a stab at reorganizing it a bit if you'd want?

Edit

Oh, and I chucked in a couple minor suggestions that jumped out at me regarding syntax highlighting, documentation ordering, and a sentence potentially missing a word 🤓

Thanks for the feedback! If you want to take a stab at reorganizing it that would fantastic.

Copy link
Contributor

@thomasheartman thomasheartman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! 🚂 Thanks for putting this together 🙌🏼

@FredrikOseberg FredrikOseberg merged commit acb98db into main Feb 8, 2022
@thomasheartman thomasheartman deleted the docs/impression-data branch February 11, 2022 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants