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

Transition Website to Jekyll #1

Open
3 of 5 tasks
KobaKhit opened this issue Oct 21, 2022 · 3 comments
Open
3 of 5 tasks

Transition Website to Jekyll #1

KobaKhit opened this issue Oct 21, 2022 · 3 comments

Comments

@KobaKhit
Copy link
Contributor

KobaKhit commented Oct 21, 2022

We are planning to convert the dc.js website (https://dc-js.github.io/dc.js/) to Jekyll. Below are some of the preliminary goals that were discussed:

  • Use dc.js CDN
  • Make website responsive/mobile friendly
  • Show the difficulty of the examples (use Added new Bootstrap version to three examples dc.js#1870)
    • Simple
    • Intermediate - requires programming experience
    • Advanced - requires knowledge of dc.js internal
  • Be ready to parametrize the website (dc version, other parameters)
  • Make the structure modular taking advantage of Jekyll includes

My next steps are to take the existing website and spend minimal effort to make it work in Jekyll . Please feel free to add feedback. The goals list is not exhaustive and will grow.

@kum-deepak
Copy link
Contributor

I have committed the documentation and examples from the dc-v5 branch and created a new repository https://github.com/dc-js/dc-js.github.io. Please create PRs against this repository.

I have added a robots.txt to prevent search engine indexing. We will adjust that when we are ready.

Public URL: https://dc-js.github.io/

@kum-deepak kum-deepak transferred this issue from dc-js/dc.js Oct 31, 2022
@KobaKhit
Copy link
Contributor Author

KobaKhit commented Feb 16, 2023

Hello. I have pushed updates to my fork. You can see the examples difficulty page added here

I also added d3.js, crossfilter and dc.js cdns to 1/3 of examples. I am utilizing Jekyll's _includes functionality. See example here

If that looks sensible I will add the cdns to the rest of the examples and create a PR against this repo. CDN paths are parametrized in the _config.yml . I could not find dc version 5 cdn readily available and just used the one in the website's js folder served by jsDelivr.

A few notes regarding the dc.js examples. Following examples are using dc-compat.js :

  • background-drawing.html
  • compare-unfiltered.html
  • focus-dynamic-interval.html
  • scatter-orig.html

Following examples do not work and are throwing errors. Should be an easy fix if need be.

  • bar-colors.html - added dc-compat.js and graph renders but without colors
  • brush-ordinal-dynamic.html

Neither have links displayed on the examples page, so I am assuming it might be legacy work.

@kum-deepak
Copy link
Contributor

Thanks, @KobaKhit.

For the non-working examples:

  • brush-ordinal.html is the updated version of brush-ordinal-dynamic.html - so it can be dropped safely.
  • bar-colors.html - I will check.

kum-deepak pushed a commit that referenced this issue Mar 16, 2023
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

No branches or pull requests

2 participants