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: Restructure tables in docs page for improved readability #835

Merged
merged 4 commits into from
May 7, 2021

Conversation

kayayarai
Copy link
Contributor

@kayayarai kayayarai commented May 6, 2021

Motivation

This page is pulled into the official Datadog public docs (here: https://docs.datadoghq.com/real_user_monitoring/browser/). The docs team is restructuring some Markdown tables into Description Lists so that they are more readable on the docs site. These changes don't look that impressive here on the rendered github page, but they look a LOT better on the docs site.

Changes

Converts tables that had hard-to-read columns or were overrunning docs site margins, into Description Lists so that they're more readable.

Testing

On this docs page on staging:
https://docs-staging.datadoghq.com/kari/test-remote-updates/real_user_monitoring/browser/
See the new tables under:

  • Choose the right installation method
  • Initialization parameters

I have gone over the contributing documentation.

@kayayarai kayayarai requested review from a team as code owners May 6, 2021 21:39
@bits-bot
Copy link

bits-bot commented May 6, 2021

CLA assistant check
All committers have signed the CLA.

@codecov-commenter
Copy link

Codecov Report

Merging #835 (1485000) into main (b59268d) will increase coverage by 0.17%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #835      +/-   ##
==========================================
+ Coverage   86.66%   86.84%   +0.17%     
==========================================
  Files          82       82              
  Lines        3914     3914              
  Branches      884      884              
==========================================
+ Hits         3392     3399       +7     
+ Misses        522      515       -7     
Impacted Files Coverage Δ
...ckages/core/src/domain/automaticErrorCollection.ts 100.00% <0.00%> (+1.72%) ⬆️
packages/rum-core/src/domain/parentContexts.ts 100.00% <0.00%> (+1.75%) ⬆️
...omain/rumEventsCollection/error/errorCollection.ts 100.00% <0.00%> (+5.00%) ⬆️
packages/rum-core/src/transport/batch.ts 74.28% <0.00%> (+11.42%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b59268d...1485000. Read the comment docs.

@kayayarai kayayarai merged commit 9802931 into main May 7, 2021
@kayayarai kayayarai deleted the kari/docs-table-layout branch May 7, 2021 18:55
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.

5 participants