Skip to content

Add more spacing for a better readability #1124

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jmaitrehenry
Copy link
Contributor

After reading the documentation, I found the information hard to find, but not because the search engine or the structure don't work, but because the text was hard to read.

I adjust some CSS rules:

  • adding more spacing and for having a font-size a little bigger
  • adjust the size for having the same inside and outside tables
  • simplify th text alignment*
  • rework the hX element for having a better distinction between elements and for having an h4 more visible

*I see some places where we use <center>title</center> syntax for th cell. I remove the rules inside bootstrap-custom.min.css for force align the text to the right.

Some before/after screenshots:
screen shot 2017-12-08 at 2 09 52 pm
screen shot 2017-12-08 at 2 10 10 pm
screen shot 2017-12-08 at 2 10 24 pm
screen shot 2017-12-08 at 2 10 50 pm

@codecov-io
Copy link

codecov-io commented Dec 8, 2017

Codecov Report

Merging #1124 into master will increase coverage by 0.29%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1124      +/-   ##
==========================================
+ Coverage   34.25%   34.54%   +0.29%     
==========================================
  Files          36       36              
  Lines        2362     2362              
==========================================
+ Hits          809      816       +7     
+ Misses       1450     1442       -8     
- Partials      103      104       +1
Impacted Files Coverage Δ
libstorage/api/types/types_localdevices.go 84.21% <0%> (-1.76%) ⬇️
...storage/drivers/storage/vfs/storage/vfs_storage.go 42.15% <0%> (+2.61%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6ed0b78...8a153d7. Read the comment docs.

@akutz
Copy link
Member

akutz commented May 18, 2018

Hi @jmaitrehenry,

Please rebase this onto master. After that, I will need to ponder this a bit. I agree with some of your changes, while others I find a matter of preference.

@jmaitrehenry jmaitrehenry force-pushed the update_documentation_style branch from 9e3e8c1 to 8a153d7 Compare June 22, 2018 15:22
@jmaitrehenry
Copy link
Contributor Author

@akutz Done, let's discuss on the changes, maybe I can split this PR in two, the first one on thing we agree, and the other one as a proposal where we can discuss.

@akutz
Copy link
Member

akutz commented Jun 22, 2018

Hi @jmaitrehenry,

Thank you! Instead of modifying a minified CSS file I'd prefer you override those rules with !important in a separate file. Or would that not work?

@akutz
Copy link
Member

akutz commented Jun 22, 2018

Hi @jmaitrehenry,

FYI, I've no issues with this PR other than the one I raised above (the modification to a minified CSS file). Once we resolve that discussion I will merge the change. Thank you again for this!

@jmaitrehenry
Copy link
Contributor Author

@akutz great, I try to find the change on the minified css, I don't know why is it modified, I do not do that normally.

@akutz
Copy link
Member

akutz commented Jun 22, 2018

Hi @jmaitrehenry,

Actually, I take all that back :) Will you please first test the changes by enabling your browser's dev mode and verifying the updates don't break mobile mode? For example, here's Safari's Responsive Design Mode:

image

Chrome also has this ability.

@akutz
Copy link
Member

akutz commented Jun 22, 2018

Hi @jmaitrehenry,

I try to find the change on the minified css, I don't know why is it modified, I do not do that normally.

You mean you didn't intend to modify that file? Except you say here that you did modify it...

I see some places where we use <center>title</center> syntax for th cell. I remove the rules inside bootstrap-custom.min.css for force align the text to the right.

@jmaitrehenry
Copy link
Contributor Author

Oh didn't see it, I made it months ago. Ok, let me check on mobile and remove the modification inside .min file.

@akutz
Copy link
Member

akutz commented Jun 22, 2018

Hi @jmaitrehenry,

Thank you. Please see if the change can be made using !important in one of the custom CSS files. If not...I mean...hmm. I just hate modifying stock files like that. Especially when they're minified. It makes it difficult to ensure changes are persisted if those stock files are updated.

@jmaitrehenry
Copy link
Contributor Author

For mobile:
screen shot 2018-06-22 at 12 04 11 pm
screen shot 2018-06-22 at 12 04 25 pm
screen shot 2018-06-22 at 12 04 57 pm
screen shot 2018-06-22 at 12 05 15 pm
screen shot 2018-06-22 at 12 05 34 pm
screen shot 2018-06-22 at 12 05 51 pm
screen shot 2018-06-22 at 12 06 04 pm

I will change the table rendering for phone, it's too big and the table is less readable than before.

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

Successfully merging this pull request may close these issues.

3 participants