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.

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

docs(maps): jupyter notebook now auto-updates docs site #27003

Merged
merged 4 commits into from
Apr 27, 2024
Merged

docs(maps): jupyter notebook now auto-updates docs site #27003

merged 4 commits into from
Apr 27, 2024
+144 −106

Conversation

rusackas
Copy link
Member

@rusackas rusackas commented Feb 3, 2024 •
edited
Loading

SUMMARY

So we have this Jupyter notebook to generate maps, and typescript for the control panel.

Now, it also outputs JSON to the docs site, and the docs site in turn renders the JSON with React (in three columns!) to keep an ever-current list of countries available on the docs.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Before:
image

After:
image

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

Sorry, something went wrong.

@rusackas rusackas requested a review from villebro February 3, 2024 07:40
@github-actions github-actions bot added the doc Namespace | Anything related to documentation label Feb 3, 2024
@codecov Codecov
Copy link

codecov bot commented Feb 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (2602527) 67.20% compared to head (d0153ad) 67.20%.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master   #27003   +/-   ##
=======================================
  Coverage   67.20%   67.20%           
=======================================
  Files        1899     1899           
  Lines       74347    74347           
  Branches     8263     8263           
=======================================
  Hits        49964    49964           
  Misses      22334    22334           
  Partials     2049     2049
Flag Coverage Δ
javascript 56.93% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rusackas rusackas requested a review from justinpark February 5, 2024 19:11
@rusackas
Copy link
Member Author

rusackas commented Feb 6, 2024

Thanks for the review... just need a maps codeowner stamp from @villebro

@rusackas rusackas force-pushed the auto-docs-for-country-map branch from d0153ad to e7428d7 Compare February 15, 2024 22:12
@rusackas rusackas added the hold:testing! On hold for testing label Feb 20, 2024
@rusackas rusackas marked this pull request as draft March 22, 2024 05:23
@rusackas rusackas force-pushed the auto-docs-for-country-map branch from e7428d7 to e4892da Compare April 27, 2024 05:28
@rusackas rusackas marked this pull request as ready for review April 27, 2024 06:14
@rusackas
Copy link
Member Author

@villebro I just need a notebook codeowner stamp, and we'll be all good :)

@rusackas
Copy link
Member Author

@mistercrunch we can make you a codeowner too for the notebook, if you promise to guard against map PRs being made without notebook updates

villebro
villebro approved these changes Apr 27, 2024
View reviewed changes
Copy link
Member

@villebro villebro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@rusackas rusackas requested a review from dpgaspar as a code owner April 27, 2024 18:20
@github-actions github-actions bot added plugins github_actions Pull requests that update GitHub Actions code labels Apr 27, 2024
@rusackas
Copy link
Member Author

rusackas commented Apr 27, 2024 •
edited
Loading

I keep getting this error, so I'm setting FetchDepth = 0 here. Hope that doesn't cause issues (i.e. perf problems) elsewhere.

image

@rusackas rusackas force-pushed the auto-docs-for-country-map branch from 4cb2fa0 to 2af571d Compare April 27, 2024 18:59
@codecov-commenter
Copy link

codecov-commenter commented Apr 27, 2024 •
edited by codecov bot
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.48%. Comparing base (9db431b) to head (2af571d).
Report is 1117 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master   #27003      +/-   ##
==========================================
+ Coverage   60.47%   60.48%   +0.01%     
==========================================
  Files        1933     1931       -2     
  Lines       76295    76236      -59     
  Branches     8533     8568      +35     
==========================================
- Hits        46137    46114      -23     
+ Misses      28065    28017      -48     
- Partials     2093     2105      +12
Flag Coverage Δ
javascript 57.71% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rusackas rusackas merged commit 76d897e into master Apr 27, 2024
28 checks passed
@rusackas rusackas deleted the auto-docs-for-country-map branch April 27, 2024 20:33
qleroy pushed a commit to qleroy/superset that referenced this pull request Apr 28, 2024
@rusackas @qleroy
docs(maps): jupyter notebook now auto-updates docs site (apache#27003)
469037f
mistercrunch
mistercrunch reviewed Apr 30, 2024
View reviewed changes
.github/workflows/superset-frontend.yml
@@ -20,6 +20,7 @@ jobs:
- name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )"
uses: actions/checkout@v4
with:
fetch-depth: 0 # Fetch all history
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey, curious why this was/is neeeded?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was indeed to get around this:

image

jzhao62 pushed a commit to jzhao62/superset that referenced this pull request May 16, 2024
@rusackas @jzhao62
docs(maps): jupyter notebook now auto-updates docs site (apache#27003)
93ac5bf
vinothkumar66 pushed a commit to vinothkumar66/superset that referenced this pull request Nov 11, 2024
@rusackas
docs(maps): jupyter notebook now auto-updates docs site (apache#27003)
c5a61d6
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 4.1.0 labels Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mistercrunch mistercrunch

@villebro villebro

@justinpark justinpark

@geido geido

@eschutho eschutho

@betodealmeida betodealmeida

@nytai nytai

@craig-rueda craig-rueda

@john-bodley john-bodley

@kgabryje kgabryje

@dpgaspar dpgaspar

Assignees
No one assigned
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels doc Namespace | Anything related to documentation github_actions Pull requests that update GitHub Actions code plugins preset-io size/L 🚢 4.1.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@rusackas @codecov-commenter @mistercrunch @villebro @john-bodley