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

Pa table header refresh #24

Open
wants to merge 29 commits into
base: main
Choose a base branch
from
Open

Pa table header refresh #24

wants to merge 29 commits into from

Conversation

aschwanden1
Copy link
Collaborator

Hi everyone. I created several new directories (js, css, img, img_logos) and updated the references to all the stuff in those directories. Also, I've restyled the header and updated the look and feel of the tabs and overall site. Also, I've added a localstorage persistance layer which will be very easy to use. I've also implemented a new Vue Component called IntroBlurb. The idea that these blurbs would only be shown to the user until he/she decides to close them. Also, I've added configuration file, as we discussed, such that all the text strings will be configurable. So, if you don't like the intro blurbs or the Dashboard name, we can change them in the config file.

@hategan
Copy link
Collaborator

hategan commented Aug 6, 2022

I think this is a great start.

We might want to split this into multiple PRs. In principle, each PR should fix one problem or add one new feature.

There are two reasons for this. One is that large PRs are hard to review. The second is that it is hard to reach consensus when there are many unrelated things to consider. For example, having assets split into subdirectories is something that is fairly straightforward and could go straight in. Other things, such as theming, have historically required lots of discussion, and, in this case we'd want to get closer to the theme on the exaworks.org web site, so that part is not as ready to go in.

@aschwanden1
Copy link
Collaborator Author

Hi Mihael,

could we hold off on the exaworks themeing project for now? since that is a lower priority.

I can make smaller pull requests in the future, as you suggested.

@aschwanden1
Copy link
Collaborator Author

aschwanden1 commented Aug 8, 2022

Hi Mihael,

I have an idea. Maybe we could just consider the styling changes provisional for now? Dan Laney and I are working towards a Sept 30th deadline. We want to be able to wow the potential new users.

Then, later on when we do the exascale reskin, I can meet up with you online to discuss the color scheme. that way you can approve it before I implement the reskin.

sound okay?

@hategan
Copy link
Collaborator

hategan commented Aug 9, 2022

I have an idea. Maybe we could just consider the styling changes provisional for now?

I see no reason to commit something that we plan not to use.

@hategan
Copy link
Collaborator

hategan commented Aug 9, 2022

I can make smaller pull requests in the future, as you suggested.

Are you planning to split this PR or would you like me to review it as is?

@aschwanden1
Copy link
Collaborator Author

Please review as is. Thank you.

Copy link
Collaborator

@hategan hategan left a comment

Choose a reason for hiding this comment

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

This looks good, but I think there are some things that shouldn't be merged. I added some comments inline.

README.md Outdated
Comment on lines 14 to 18
https://www.mongodb.com/docs/manual/tutorial/install-mongodb-on-os-x/

the last step is:
brew services start [email protected]
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is OS X specific. Perhaps that should be made more clear.

Comment on lines +21 to +23
cd ~/psi-j-testing-service;
python3 src/psij/testing/service.py
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe this belongs in a README-dev.md document or under a section that specifies that this allows one to create a local development environment.

README.md Outdated

then you can see it at this url:
http://0.0.0.0:9909/summary.html
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not sure about 0.0.0.0. It seems to work, but, from what I understand, it's not meant to signify "loopback address", which is 127.0.0.1

README.md Outdated
Comment on lines 30 to 31
you need to edit testing.conf first and, at a minimum, update the url to point to your server
Copy link
Collaborator

Choose a reason for hiding this comment

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

There's both first person and third person here. Is this document meant for other people? If so, it may be a bit confusing.

@@ -1,5 +1,5 @@
body {
background-color: #f0f0f0;
background-color: #ffffff;
Copy link
Collaborator

Choose a reason for hiding this comment

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

As discussed, can we hold off on temporary style changes?

src/psij/web/js/lib.js Show resolved Hide resolved
@@ -0,0 +1,79 @@
// Global Storage, shortcut for sqs.
Copy link
Collaborator

Choose a reason for hiding this comment

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

What is the purpose of this library?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I needed persistence to prevent IntroBlurbs from showing up after the user has closed them. We can use it for many purposes.

Copy link
Collaborator

Choose a reason for hiding this comment

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

That sounds unusual in that I'm not familiar with any sites that do this except in very special cases when required by law or some such (like cookies preferences). But those are quite annoying and intrusive. We could simply have a brief introductory text that users can ignore after reading it once and, in case they forget it, read it again.

Additionally, the code already has a library that saves settings in cookies, which is used to remember the summary view type and other settings.

Comment on lines +31 to +33
<div class="highlightable button view-mode-group" id="view-mode-curated-sites" title="Curated Sites" onclick="setViewMode('curated-sites')">
<span class="material-icons">home</span>
</div>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Does the curated-sites view mode exist and is functional? If not, perhaps this belongs in another PR.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Not functional yet. Just a work in progress. Ok, i am commenting this out for future PR.

Copy link
Collaborator

Choose a reason for hiding this comment

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

If the comment does not help understand the code, it should probably not be there.

Comment on lines 515 to 518
#status-calendar tr:nth-child(even) td,
tr:nth-child(even) th {
background-color: #f2f2f2;
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

May I recommend Butterick's Practical Typography (https://practicaltypography.com/), in particular the sections on tables and grids? It's a good resource in general for creating readable textual content, but it applies in good measure to other things, like websites.

Comment on lines 212 to 213
border-top-right-radius: 5px;
border-top-left-radius: 5px;
Copy link
Collaborator

Choose a reason for hiding this comment

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

Think of the view modes more like the "view as list" / "view as icons" in windows explorer and Finder. They are not tabs, since the information doesn't change. What changes is how the same information is represented.

@hategan hategan mentioned this pull request Jan 24, 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

Successfully merging this pull request may close these issues.

2 participants