Skip to content

docs: Added maximum height to output execution cells in mkdocs to prevent large tables to fill the whole site#446

Merged
lars-reimann merged 7 commits intomainfrom
fix-warning-in-data-processing-tutorial-and-set-max-height-for-output-cells
Jul 12, 2023
Merged

docs: Added maximum height to output execution cells in mkdocs to prevent large tables to fill the whole site#446
lars-reimann merged 7 commits intomainfrom
fix-warning-in-data-processing-tutorial-and-set-max-height-for-output-cells

Conversation

@Marsmaennchen221
Copy link
Copy Markdown
Contributor

@Marsmaennchen221 Marsmaennchen221 commented Jul 11, 2023 •
edited by lars-reimann
Loading

Closes #447.

Summary of Changes

docs: Added maximum height to output execution cells in mkdocs to prevent large tables to fill the whole site
docs: Removed a warning in the data processing tutorial
docs: Added table of contents to data processing tutorial
docs: Shorten output in "Data Processing" tutorial to speed up loading the page

Used the html note like we discussed in #419

@Marsmaennchen221
docs: Removed a warning in the data processing tutorial
b73392f 
docs: Added maximum height to output execution cells in mkdocs to prevent large tables to fill the whole site
docs: Added table of contents to data processing tutorial
@Marsmaennchen221 Marsmaennchen221 requested a review from a team as a code owner July 11, 2023 23:10
@codecov
Copy link
Copy Markdown

codecov bot commented Jul 11, 2023 •
edited
Loading

Codecov Report

Merging #446 (ad314b3) into main (6e9ff69) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #446   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           49        49           
  Lines         2667      2667           
=========================================
  Hits          2667      2667

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jul 11, 2023 •
edited
Loading

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ CSS stylelint 1 0 0 1.04s
✅ JSON prettier 1 0 0 0.54s
✅ REPOSITORY git_diff yes no 0.06s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security

@lars-reimann
Copy link
Copy Markdown
Member

lars-reimann commented Jul 12, 2023 •
edited
Loading

  • Good idea and I'd definitely keep the max height. However, we also need to keep in mind that the data will still bloat the generated HTML, so truncating the output is still required to keep its size down.

  • For some reason the data processing tutorial loads extremely slowly now. It's fine on stable but already slow on latest, so probably unrelated to your changes. It's likely the sheer size of the page (see previous point). -> Data processing tutorial loads very slowly #447.

  • There's also still one warning:

image

@zzril
Copy link
Copy Markdown
Contributor

zzril commented Jul 12, 2023

docs: Added table of contents to data processing tutorial

There should be more chapters. At the very least, a "General" section for everything before the Transform Table/Colunm sections.
Possible use a separate section for loading the data as well.

Also, now with #419 merged, that one should probably also get such a table of content now.

@lars-reimann
Copy link
Copy Markdown
Member

lars-reimann commented Jul 12, 2023 •
edited
Loading

I've added a fix for #447 here too since you were working on that notebook anyway.

lars-reimann
lars-reimann approved these changes Jul 12, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@lars-reimann lars-reimann left a comment

Choose a reason for hiding this comment

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

There's now another warning:

image

I don't find that helpful though since the example code is perfectly valid and will remove it in another PR.

@lars-reimann lars-reimann merged commit e92c862 into main Jul 12, 2023
@lars-reimann lars-reimann deleted the fix-warning-in-data-processing-tutorial-and-set-max-height-for-output-cells branch July 12, 2023 19:29
@lars-reimann
Copy link
Copy Markdown
Member

lars-reimann commented Jul 13, 2023

🎉 This PR is included in version 0.15.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lars-reimann lars-reimann added the released Included in a release label Jul 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lars-reimann lars-reimann lars-reimann approved these changes

Assignees

No one assigned

Labels

released Included in a release

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Data processing tutorial loads very slowly

4 participants

@Marsmaennchen221 @lars-reimann @zzril @megalinter-bot