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

Docs: Integration documentation gets cut off #11967

Closed
kennethstoltz-db opened this issue Oct 30, 2020 · 4 comments · Fixed by #12227
Closed

Docs: Integration documentation gets cut off #11967

kennethstoltz-db opened this issue Oct 30, 2020 · 4 comments · Fixed by #12227
Assignees

Comments

@kennethstoltz-db
Copy link

There are many wide tables in the documentation, for example here:
https://airflow.readthedocs.io/en/latest/operators-and-hooks-ref.html#id19

On a very wide browser the width is still fixed. It is not obvious that the table is cut off and I was very confused that I never found the operator reference documentation I was looking for.
Screenshot 2020-10-30 at 13 36 57

I would suggest either:

  • refactoring the table into many separate tables either by provider or by column
  • reformatting the tables into nested lists
  • truncating the long token names that push the table wide
  • choosing a theme that is responsive

I'm new to the project and docs so I don't want to force my formatting decisions, but I'm happy to make a PR if someone can suggest what to do.

@kennethstoltz-db kennethstoltz-db added the kind:bug This is a clearly a bug label Oct 30, 2020
@boring-cyborg
Copy link

boring-cyborg bot commented Oct 30, 2020

Thanks for opening your first issue here! Be sure to follow the issue template!

@mik-laj
Copy link
Member

mik-laj commented Oct 30, 2020

reformatting the tables into nested lists

Can you prepare a little POC that would show what it would look like?

@VBhojawala
Copy link
Contributor

VBhojawala commented Nov 9, 2020

Before

In my humble opinion this issue can be fixed with following css changes :

/* override the maximum width restriction for large screen */
.wy-nav-content {
   max-width: none;
} 

/* override table width restrictions and allow multiple line td  */
@media screen and (min-width: 720px) {
   .wy-table-responsive table td {
      white-space: normal !important;
   }
}

Screen shoot of 1080p screen web browser after applying above changes

After

Same can be tested inside developer option of browser
On firefox

  1. Press F12 on documentation site page
  2. Go to style editor
  3. Choose css and add above code and test the changes.

Firefox

@mik-laj
Copy link
Member

mik-laj commented Nov 9, 2020

I will want to delete this page and replace it with a list of operators in another form. Ideally, it would be like we managed to create something similar to the Terraform Registry.
See: #11423

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants