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

Fix: docs should soft fail when vf-design-tokens aren't present #431

Merged
merged 2 commits into from
Jun 24, 2019

Conversation

khawkins98
Copy link
Contributor

This is a workaround so the doc compilation in fractal will softfail when vf-design-tokens aren't present.

A few notes:

  1. When the docs don't compile, the fractal components aren't available
  2. This is mostly an issue for vf-eleventy sites, but fractal should be compiling the vf-core docs anyways 🤷‍♂
  3. ☝️ That could also be an issue in vf-core if/when we move vf-design-tokens as an npm install

To me all that continues to suggest that we still need a more "holistic" way to approach the docs, so this PR is more of an "alpha-level" fix.

@auto-comment
Copy link

auto-comment bot commented Jun 24, 2019

Have you added any relevant labels to this PR?
To help this process please make sure you have these things ready (if applicable).

  • package.json updated accordingly. - [ ] README.md fill out with required documentation. - [ ] any .scss files correctly documented. - [ ] a detailed outlin on what this PR is expected to do

@auto-comment
Copy link

auto-comment bot commented Jun 24, 2019

Thank you for requesting a review for this pull request (PR).
If this PR has an associated issue - please add that to the PR description.
If you have not done so already - please fill out the PR description with as much context as possible.

@sturobson
Copy link

It's bizarre we're hitting this - I wonder if there's a better way. I really want to tie up the design-system site this week or next - so I'll be taking another look.

@sturobson sturobson merged commit 152ced7 into develop Jun 24, 2019
@sturobson sturobson deleted the fix/docs-requiring-vf-design-tokens branch June 24, 2019 08:35
@khawkins98
Copy link
Contributor Author

Yeah, wonder if this sort of docs should just live at the design system level?

@sturobson
Copy link

the reason for the separation at the moment is that design system is really only 'high level' so people looking at it shouldn't really care what the CSS custom property is.

Although, we could re-jig bigzing! So that the design system is actually where everything lives.

Which gets my vote :)

@khawkins98
Copy link
Contributor Author

It kinda feels like things are tilting that way-ish. Would be a more natural fit if, sya, EMBL and EMBL-EBI "VFs" have slightly different colour palettes.

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.

2 participants