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 Carbon ads #4891

Merged
merged 28 commits into from Mar 6, 2020
Merged

docs: add Carbon ads #4891

merged 28 commits into from Mar 6, 2020

Conversation

@jackmu95
Copy link
Member

jackmu95 commented Mar 5, 2020

Describe the PR

A clear and concise description of what the pull request does.

PR checklist

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Enhancement
  • ARIA accessibility
  • Documentation update
  • Other (please describe)

Does this PR introduce a breaking change? (check one)

  • No
  • Yes (please describe)

The PR fulfills these requirements:

  • It's submitted to the dev branch, not the master branch
  • When resolving a specific issue, it's referenced in the PR's title (i.e. [...] (fixes #xxx[,#xxx]), where "xxx" is the issue number)
  • It should address only one issue or feature. If adding multiple features or fixing a bug and adding a new feature, break them into separate PRs if at all possible.
  • The title should follow the Conventional Commits naming convention (i.e. fix(alert): not alerting during SSR render, docs(badge): update pill examples, chore(docs): fix typo in README, etc). This is very important, as the CHANGELOG is generated from these messages.

If new features/enhancement/fixes are added or changed:

  • Includes documentation updates (including updating the component's package.json for slot and event changes)
  • Includes any needed TypeScript declaration file updates
  • New/updated tests are included and passing (if required)
  • Existing test suites are passing
  • CodeCov for patch has met target
  • The changes have not impacted the functionality of other components or directives
  • ARIA Accessibility has been taken into consideration (Does it affect screen reader users or keyboard only users? Clickable items should be in the tab index, etc.)

If adding a new feature, or changing the functionality of an existing feature, the PR's
description above includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)
@jackmu95 jackmu95 added the Type: Docs label Mar 5, 2020
@jackmu95 jackmu95 requested a review from tmorehouse Mar 5, 2020
@jackmu95 jackmu95 added this to In progress in 2.7.0 via automation Mar 5, 2020
@codecov

This comment has been minimized.

Copy link

codecov bot commented Mar 5, 2020

Codecov Report

Merging #4891 into dev will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #4891   +/-   ##
=======================================
  Coverage   99.93%   99.93%           
=======================================
  Files         269      269           
  Lines        6114     6114           
  Branches     1595     1595           
=======================================
  Hits         6110     6110           
  Misses          3        3           
  Partials        1        1

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 b1eb8cf...9a309e1. Read the comment docs.

@jackmu95 jackmu95 added the Status: WIP label Mar 5, 2020
@tmorehouse tmorehouse changed the title feat(docs): add Carbon ads docs: add Carbon ads Mar 5, 2020
docs/layouts/docs.js Outdated Show resolved Hide resolved
docs/components/ad.js Outdated Show resolved Hide resolved
@tmorehouse

This comment has been minimized.

Copy link
Member

tmorehouse commented Mar 5, 2020

Should we limit displaying the ads only on bootstrap-vue.js.org and *.netlify.com domains?

jackmu95 added 6 commits Mar 5, 2020
@tmorehouse

This comment was marked as resolved.

Copy link
Member

tmorehouse commented Mar 6, 2020

I think we might need to v-if out the ad component and back in in a next tick when the TOC update is emitted (otherwise I think the same ad is showing on all pages when the route changes (in the docs layout)

@jackmu95 jackmu95 removed the Status: WIP label Mar 6, 2020
@jackmu95 jackmu95 marked this pull request as ready for review Mar 6, 2020
@jackmu95 jackmu95 requested a review from tmorehouse Mar 6, 2020
@jackmu95 jackmu95 added this to In progress in 2.6.1 via automation Mar 6, 2020
@jackmu95 jackmu95 removed this from In progress in 2.7.0 Mar 6, 2020
tmorehouse and others added 3 commits Mar 6, 2020
tmorehouse added 7 commits Mar 6, 2020
@tmorehouse

This comment has been minimized.

Copy link
Member

tmorehouse commented Mar 6, 2020

Updated the positioning of the ads a bit to be better in line with the carbonads placement requirements (specifically for mobile) https://www.carbonads.net/faq

Do you have any policies about how ads should behave on a mobile site?

The advertisement must be visible within 3x of the mobile viewport height, starting from the top of the mobile browser. An iPhone 6, with a viewport height of 375 pixels, needs to have advertisement visible within 1125 pixels from the top of the browser. The ratio is the same for both portrait and landscape views.

The general principle is that the site visitors should be able to view the ad with only one-tap scroll. Optionally, you can choose to prevent the ad from loading when viewed on mobile site.

tmorehouse added 7 commits Mar 6, 2020
@tmorehouse tmorehouse self-requested a review Mar 6, 2020
@jackmu95 jackmu95 added the PR: Patch label Mar 6, 2020
@jackmu95 jackmu95 merged commit 706926c into dev Mar 6, 2020
9 checks passed
9 checks passed
License Compliance All checks passed.
Details
ci/circleci: build Your tests passed on CircleCI!
Details
ci/circleci: lint Your tests passed on CircleCI!
Details
ci/circleci: setup Your tests passed on CircleCI!
Details
ci/circleci: test Your tests passed on CircleCI!
Details
codecov/patch Coverage not affected when comparing b1eb8cf...9a309e1
Details
codecov/project 99.93% remains the same compared to b1eb8cf
Details
netlify/bootstrap-vue/deploy-preview Deploy preview ready!
Details
security/snyk (pi0) No manifest changes detected
Details
2.6.1 automation moved this from In progress to Done Mar 6, 2020
@jackmu95 jackmu95 deleted the feat-docs-add-carbon-ads branch Mar 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
2.6.1
  
Done
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.