Skip to content

fix(docs): Fix console errors and improve play directive #2176

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 8 commits into from
Nov 15, 2018
Merged

fix(docs): Fix console errors and improve play directive #2176

merged 8 commits into from
Nov 15, 2018

Conversation

jacobmllr95
Copy link
Member

@jacobmllr95 jacobmllr95 commented Nov 14, 2018 •
edited
Loading

Description of Pull Request:

This PR addresses several console errors in the docs and improves the play directive.
The example name defined in markdown is now omitted for the live example on the docs page.

PR checklist:

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

  • Bugfix
  • Feature
  • Enhancement to an existing feature
  • ARIA accessibility
  • Documentation update
  • Other, please describe:

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

  • Yes
  • No

If yes, please describe the impact:

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 #xxxx[,#xxxx], where "xxxx" is the issue number)
  • The PR 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.
  • PR titles should following the Conventional Commits naming convention (i.e. "fix(alert): not alerting during SSR render", "docs(badge): Updated pill examples, fix typos", "chore: fix typo in docs", 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)
  • New/updated tests are included and passing (if required)
  • Existing test suites are passing
  • 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)

@codecov
Copy link

codecov bot commented Nov 14, 2018 •
edited
Loading

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #2176   +/-   ##
=======================================
  Coverage   65.94%   65.94%           
=======================================
  Files         158      158           
  Lines        3004     3004           
  Branches      836      836           
=======================================
  Hits         1981     1981           
  Misses        741      741           
  Partials      282      282

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 aacc7c0...f5f3f7e. Read the comment docs.

@tmorehouse
Copy link
Member

tmorehouse commented Nov 14, 2018 •
edited
Loading

Looks awesome!

I wonder if we should maybe give the editor a red outline if there is an error during compilation, or maybe show an error in the rendered live example (or below the render)? Maybe just a simple error like javascript compile error, or template compile error? rendered in a simple warning alert markup.

Or would that be too cumbersome?

Overall this is a great fix!

@tmorehouse tmorehouse mentioned this pull request Nov 14, 2018
Closed
89 tasks
@tmorehouse
Copy link
Member

tmorehouse commented Nov 14, 2018 •
edited
Loading

Also Wondering if something similar could be done with the docs playground as well?

It has issues if you reference a variable in the template that is not defined in the component definition JS... creates an endless loop of console errors and hangs the page. (and also stores the invalid template in localStorage).

@jacobmllr95
Copy link
Member Author

An error indicator or even output would be an awesome addition. I will look into that later on.

The Playground definitely needs some love. I'am going to take a further look into it after this PR has shipped.

@tmorehouse
Copy link
Member

Excellent...

just taking a boo at the playground now... I can see one simple improvement (updating the localstorage after compilation, rather than before)

@jacobmllr95
Copy link
Member Author

I've added a super simple error indication but I'am quite happy with it :)

tmorehouse
tmorehouse reviewed Nov 15, 2018
View reviewed changes
@tmorehouse
Copy link
Member

Looks good! all ready to merge?

@jacobmllr95
Copy link
Member Author

Yes, looks good to me.

@tmorehouse tmorehouse merged commit cc02130 into bootstrap-vue:dev Nov 15, 2018
@jacobmllr95 jacobmllr95 deleted the fix/docs-play-and-other-console-errors branch November 15, 2018 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tmorehouse tmorehouse tmorehouse left review comments

Assignees
No one assigned
Labels
Type: Docs Type: Fix
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jacobmllr95 @tmorehouse