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

Adding map and reorganizing pages #25

Merged
merged 18 commits into from May 21, 2019

Conversation

Projects
None yet
4 participants
@vsoch
Copy link
Member

commented May 18, 2019

This will be a work in progress to update the site. I'll keep a list of running changes here, and remove the WIP status when it's ready for review. Changes so far include:

Competed

Saturday, 5/18/2019

  • reorganizing pages to be in a pages folder. It is/will get messy as we add more pages, and it's hard to distinguish between markdown files that are pages, and those that are changelog, readme, etc.
  • added map from the blog, and the data file.
  • groups page renders from the map.yml data file.
  • jobs read programatically from data file, rendered if not expired.
  • reorganized assets to be under assets, instead of scattered around root folder.

Remaining

  • testing for data files
  • automatic generation of site (nightly?) to update jobs, if necessary (this would be nice to do with GitHub actions...)

Note that the lbnl job posting (again!) went 404, so I just removed it.

I'm going to be adding continuous integration with testing and preview, dynamic generation of jobs, and some other general fixing up. If possible, it would be cool to submit this org to GitHub actions so we can use them eventually for other kinds of automated tasks (I'm not able to do this, I'm only a member).

This is not ready for review.

Signed-off-by: Vanessa Sochat vsochat@stanford.edu

adding map and reorganizing pages
Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>
@cosden

This comment has been minimized.

Copy link
Member

commented May 18, 2019

Great idea!

vsoch added some commits May 18, 2019

adding jobs to read from file, remove from site when expired
Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>
reorganizing assets to be neater, all in assets folder
Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>
@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 20, 2019

I didn't get a chance to finish work this weekend, if you need me to triage finishing up adding tests I can shuffle things around, otherwise we can integrate what is currently here, or move the merge/update to later in the week.

@cferenba

This comment has been minimized.

Copy link
Member

commented May 20, 2019

One thing to keep in mind: the more changes we make to the beautiful-jekyll theme files, the more difficult it will be to pull in fixes/updates to the theme if we ever want to do so. Not necessarily a problem, but something to consider.

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 20, 2019

I don't think the theme is particularly special or outstanding, and actually I don't think it (out of the box) is so great. I'd advocate for fixing to a better organization and maintaining most of the core style / design docs, and if there is some functionality that is added to beautiful jekyll that we want? Then we add it. I personally offer to do this - I think our daily usage / ease of updating the site and finding things is far more important than any tweaks for a simple web template.

@cferenba

This comment has been minimized.

Copy link
Member

commented May 20, 2019

If you are willing to do it, that's great. I was hesitant to make any significant mods because I'm not very literate in website design, but it sounds like you are more knowledgeable about such things.

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 20, 2019

I can start on the automated builds (for jobs) and testing, but first I want to check with @cosden if we would want to use GitHub Actions to do this? I can create the workflow on circleci for now, and then if/when an owner of the organization can request to be added to the beta, I can migrate it then.

@cosden

This comment has been minimized.

Copy link
Member

commented May 20, 2019

@cferenba - good point. I think it's probably ok, as the updates are unlikely to significant enough for us to require them. I'm in the same boat as not being particularly literate with these things. That said some of the actions like the reorganization of the directory structure is definitely necessary. It was getting ugly.

@vsoch - I've never used actions and my personal account is on the wait list to get the beta release. The tinkerer in me wanted to try it out first before I attempted to offer an opinion. That's, realistically, unlikely to happen soon. It certainly seems reasonable, but that's based off the website description. I don't think it can hurt to request actions.

@cferenba

This comment has been minimized.

Copy link
Member

commented May 20, 2019

@vsoch : by the way, the custom.css file was completely created by me, so that I could make some minor tweaks to the theme without modifying the original .css files. Given that you're modifying those files anyway, it would work equally well to make those changes directly in the original files, if you think that would be a better choice.

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 20, 2019

hey @cosden I got fairly early access to actions, so I have a bit of experience and can share! It's not currently out of beta, and this means it shouldn't be used for (external to GitHub) services that would warrant even encrypted envars. However, for things that stay within GitHub (e.g., deployment back to pages) since we get a GITHUB_TOKEN envar by default, it's (in my opinion) a better solution than using an external CI (and needing to put a token there). Tokens can always be revoked, but you know, it's one more step to be extra careful.

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 20, 2019

@cferenba your approach is probably okay, it doesn't hurt to have more than one css file :)

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 20, 2019

And the waiting time is a crapshoot - I got it almost immediately, and I know of others that are still waiting. So that said, I'm happy to add the initial checks to the current travis, and the jobs page will be naturally updated with other changes to the site. If / when Actions is available, we can set up an automated nightly check. Does that sound reasonable?

@cosden

This comment has been minimized.

Copy link
Member

commented May 20, 2019

I requested it for the org. I don't see how starting the request process can possibly hurt. My biggest concern is relying on anything beta. What if it doesn't materialize, or they change the business model to charge for it, etc? There are alternatives, so it doesn't seem like it would be the end of the world either way.

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 20, 2019

okay, that sounds good to me :) I totally agree, CI / services go in and out of style (cough, .travis) and as long as your builds don't rely on much more than "use this base and run these tests" it's fairly easy to migrate.

adding circle ci setup, will need to be connected
Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>
@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 20, 2019

okay - I just pushed the files for circle, which we can use to do nightly builds. If someone that is admin on the repo can do as before and connect the project to circle, I should be able to start debugging.

@cosden

This comment has been minimized.

Copy link
Member

commented May 20, 2019

Sorry - you asked about enabling circle a while ago didn't you...I didn't connect it for the blog, but I'll do it now.

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 20, 2019

No worries! It should be a matter of selecting the project "usrseweb" and then turning it on. I think circle (at least should be) smart enough that when we merge and rename the repo, the settings will persist.

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 20, 2019

@cosden one more thing to ask of you (I was able to do this for the blog repo because I had permissions, but I can't here). We need to add @manbat as a collaborator on the repo, he's my robot to deploy things.

@vsoch vsoch referenced this pull request May 20, 2019

Closed

Add/circle #23

@cosden

This comment has been minimized.

Copy link
Member

commented May 20, 2019

We need to add @manbat as a collaborator on the repo, he's my robot to deploy things.

Done!

vsoch added some commits May 20, 2019

trivial addition of circle badge, to hopefully trigger build
Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>
trivial change to trigger build
Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>
@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 20, 2019

@manbat says thank you! A little history - his name is inspired from some of the comments here https://www.reddit.com/r/funny/comments/f95sz/what_is_your_batman_name/

I'll need to work a bit on the circleci build.

exclude vendor
Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>
@cferenba

This comment has been minimized.

Copy link
Member

commented May 20, 2019

Note that the lbnl job posting (again!) went 404, so I just removed it.

Yeah, I just checked and it looks like the other posting is no longer open either. Nobody tells me anything around here... :-)

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 20, 2019

@cosden would it hurt to rename this repo to usrse.github.io now so we don't have to change it later? It's relevant for the URL that the static files render to (right now set to that).

default branch here is gh-pages
Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>

vsoch added some commits May 21, 2019

double slashes dont need to be replaced, messes with preview
Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>
try baseurl again
Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>
got it working! last bit is the title image
Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>

@vsoch vsoch changed the title [WIP] adding map and reorganizing pages Adding map and reorganizing pages May 21, 2019

@vsoch vsoch changed the title Adding map and reorganizing pages [WIP] Adding map and reorganizing pages May 21, 2019

adding test for jobs data
Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>
@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 21, 2019

Update 5/21/2019

Completed

  • testing for the map data file is done now in Circle, we parse over the entries and ensure that each has required fields name, url, type, and coords, and then validate that the urls provided exist (image and url).
  • testing for jobs data is also done - we look for required fields expires, location, name, and url, and ensure that the url exists, name and location are not null / empty string, and that expires is a datetime.date
  • automatic generation of the site nightly is ready to go - since the build of the site will change the jobs page based on expiration, when jobs expire the page will build differently and they won't show up. Given no changes, the push will just alert that there is no change.
  • GitHub Actions will be pushed to some future time when we get repo access.
  • The site preview looks good. When it's time to change the repo url (so that the domain can serve all "subpages" like /blog, we can tweak the circle_urls.sh script to not hard code the name.

This is now ready for review.

@vsoch vsoch changed the title [WIP] Adding map and reorganizing pages Adding map and reorganizing pages May 21, 2019

@cosden
Copy link
Member

left a comment

Nice work! I wholeheartedly agree that organizing into /pages and /assets was the way to go. I haven't looked at anything closely, but took a look at the artifacts on circle and everything looks great. I think we can safely merge and fix/change/update as time goes.

I have a couple suggestions/ideas about the jobs page:
I don't love the expiration date approach. Jobs can get removed for a number of reasons and putting an expiration date next to the posting implies (at least to me) that the job will be open and accepting applications until the expiration date, which is likely untrue. Also, I think we should keep the institution/organization name next to the posting; it's a critical piece of information. As a slightly different approach (and I'm thinking out loud here) could we do some kind of a diff on the link, and if/when it changes (404, positing removed, etc) the job gets either pulled or we get notified to take action? I'm happy to be the recipient of such a thing.

@danielskatz

This comment has been minimized.

Copy link
Collaborator

commented May 21, 2019

I'm not sure about the jobs part either, but I think the worst thing we could do is to have a page of old posts that either don't work or have past the dates that they say are their deadlines

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 21, 2019

Ah, I added the expiration date to the interface after we talked about it in slack, and didn't think that it might not be desired to actually show (note that it's used to know when to remove the job from rendering on the page). We can very easily not render it on the page! Would this be desired?

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 21, 2019

To jog your memory:
image

remove job expires, replace with location!
Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>
@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 21, 2019

okey doke, I replaced the expires with the location (makes sense, right?) https://14-120906408-gh.circle-artifacts.com/0/usrse.github.io/jobs/index.html

@danielskatz

This comment has been minimized.

Copy link
Collaborator

commented May 21, 2019

what do we do when the work could be remote?

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 21, 2019

The user adding the job would just add location as remote, e.g. any of the following:

- name: Top Dinosaur Job
  location: Remote
  url: http://www.dinosaur-jobs.com/1
  expires: 2020-01-01

- name: Top Dawg Job
  location: Boulder, CO or Remote
  url: http://www.dawg-jobs.com/1
  expires: 2019-08-01
@cferenba

This comment has been minimized.

Copy link
Member

commented May 21, 2019

What about putting a "posted" date instead of an expiration date?

The ideal would be for expired jobs to be removed in a reasonable timeframe, but reasonable isn't always as easy as you'd like. The two LANL jobs I posted expired within the last week, but I knew nothing about it till others found the links broken.

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 21, 2019

We could add a posted date, but it seems not so useful given that the person reading has no idea when it expires. If the goal is to get the post to automatically show up and then disappear when it’s old, if we only had a posted date we would require all jobs to have the same duration. Or we would have to force the poster to specify a duration along with a posted date which seems excessive. It’s simpler and cleaner should just ask for an expiry date.

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 21, 2019

The implicit knowledge is that showing up on the page period indicates not expired. Perhaps it would be better then to add a note to tell this to the reader?

sneaking in GSB group to add to list/map
Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>
@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 21, 2019

Just snuck in the GSB group at Stanford, who just got back to me they want to be added!

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 21, 2019

oooh wait! I need to update the README with docs for how to add stuffs!! Do not merge!!

adding instructions to readme for adding content
Signed-off-by: Vanessa Sochat <vsochat@stanford.edu>
@cosden

This comment has been minimized.

Copy link
Member

commented May 21, 2019

In the end, I don't think there are enough eyes on the site (at least not yet) to let perfect be the enemy of the good! We'll inevitably iterate as time goes on and this is clearly a very big step in the right direction. I can merge tonight if no one else objects or if someone wants to go ahead and do it, go for it.

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 21, 2019

okay, looks like we are good again!

@vsoch

This comment has been minimized.

Copy link
Member Author

commented May 21, 2019

I'll merge now so that I can check that everything looks okay when it updates gh-pages. When I've confirmed that, I'll merge USRSE/blog#20 to remove the map from the blog site. Thanks y'all!

@vsoch vsoch merged commit 604fa8f into USRSE:gh-pages May 21, 2019

2 checks passed

ci/circleci: build-site Your tests passed on CircleCI!
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@vsoch vsoch deleted the vsoch:update/site branch May 21, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.