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

Update design #367

Merged
merged 13 commits into from Jul 4, 2021
Merged

Update design #367

merged 13 commits into from Jul 4, 2021

Conversation

AaronDewes
Copy link
Member

@AaronDewes AaronDewes commented Apr 22, 2021

A preview should be available at https://aarondewes.github.io/probot.github.io soon, not sure how long GitHub pages takes to make it available. This updates primer, introduces dark mode and makes some minor tweaks to the design


View rendered node_modules/@primer/css/CHANGELOG.md
View rendered node_modules/@primer/css/README.md
View rendered node_modules/@primer/css/alerts/README.md
View rendered node_modules/@primer/css/autocomplete/README.md

@AaronDewes AaronDewes requested a review from a team as a code owner April 22, 2021 14:49
@gr2m
Copy link
Contributor

gr2m commented Apr 22, 2021

Thank you for all your contributions @AaronDewes. https://probot.github.io/ really needs some love!

A preview should be available at https://aarondewes.github.io/probot.github.io soon

I think the preview is there, but the assets are loaded with a / prefix, so they all result in 404 because they are tried to being loaded from https://aarondewes.github.io/ instead of https://aarondewes.github.io/probot.github.io, e.g https://aarondewes.github.io/assets/logo.png

Unfortunately I cannot manage to set up the jekyll locally, bundle install always fails for me. I'd love to get rid of jekyll altogether and use something else, so Probot contributors don't need to worry about yet another toolchain besides node. Do you have any preference yourself?

Probot
GitHub Apps to automate and improve your workflow
Probot
GitHub Apps to automate and improve your workflow

@AaronDewes
Copy link
Member Author

I'd love to get rid of jekyll altogether and use something else, so Probot contributors don't need to worry about yet another toolchain besides node. Do you have any preference yourself?

How about Gatsby? I can try to implement it if you want.

@gr2m
Copy link
Contributor

gr2m commented Apr 22, 2021

Gatsby might be overkill? And I'm not very familiar with it, it looks rather complex and I'd be nervous that we wouldn't be able to maintain it when you move on to other projects. But if you think it's simple enough and you would like to give it a try to convince us, please feel free :)

As an alternative suggestion: are you familiar with https://www.11ty.dev/?

Eleventy
Eleventy is a simpler static site generator.

@AaronDewes
Copy link
Member Author

Not really familiar with it, but I can try it the day after tomorrow if you want.

@gr2m
Copy link
Contributor

gr2m commented Apr 22, 2021

Another option is next.js, which might be a bit more complicated, but it would permit us to easily add dynamically generated pages later

you choice! I'm a bit familiar with 11ty and next.js, these would be my preferences, but feel free to give Gatsby a go

@AaronDewes
Copy link
Member Author

Next.js isn't optimized for GitHub pages though, it's better for vercel. But I have a bit of next experience, so I might try it. I'll create some concepts the day after tomorrow.

@tcbyrd
Copy link
Contributor

tcbyrd commented Apr 22, 2021

11ty is the most similar to Jekyll in the Node space. My vote would be that since it doesn't introduce any React dependencies, and since Pages doesn't really have the best experience today with SPA frameworks like Gatsby and Next.

@gr2m
Copy link
Contributor

gr2m commented Apr 22, 2021

okay lets do 11ty then, okay @AaronDewes? I'd be open to experiment with next.js in future if the need for dynamic page rendering comes up. We will of course need to change the domain then to something like probot.dev, but let's take one step at a time

@AaronDewes
Copy link
Member Author

grafik
I made some progress on the 11ty site, but it's not finished yet.

@AaronDewes
Copy link
Member Author

@gr2m This would require changes to the main probot repo because Jekyll and 11ty work slightly different and there are some issues with the docs. Would that be okay for you?

@AaronDewes
Copy link
Member Author

AaronDewes commented Apr 24, 2021

Apps & docs not working, but https://probot-testsite.github.io/

@gr2m
Copy link
Contributor

gr2m commented Apr 25, 2021

@gr2m This would require changes to the main probot repo because Jekyll and 11ty work slightly different and there are some issues with the docs. Would that be okay for you?

yes, let me know what we need to change

Apps & docs not working, but https://probot-testsite.github.io/

😍

@AaronDewes
Copy link
Member Author

AaronDewes commented Apr 26, 2021

PR to the main repo is open, https://probot-testsite.github.io/ has been updated. After successfully merging this PR (#367), you need to change the github pages branch from master to gh-pages. But please note that after probot/probot#1516, I still need to do some minor changes, updating the submodule & removing the docs folder from .eleventyignore.

@AaronDewes
Copy link
Member Author

I still need to fix the docs, but it's nearly finished.

This is a separate commit to make reviewing easier, no real changes have been done here except removing that folder
- Updated all data
- Fixed slug for rezensent and untrivializer

Again, a separate commit for this should hopefully make reviewing easier
This is the most interesting commit about the 11ty port, where all changes have been dome
@AaronDewes
Copy link
Member Author

Just force-pushed to make the review a bit easier: commit 99072ea contains all the important changes, the other two only autogenerated, but big changes

@AaronDewes
Copy link
Member Author

@gr2m It's getting late here, but probot-testsite seems to work now (except the things you said can be done in a follow-up PR), so you can merge this if you want, I'll do follow-up work tomorrow

@AaronDewes
Copy link
Member Author

AaronDewes commented Jul 2, 2021

No, it's not working, all doc examples are one line right now, I'll do it tomorrow then

@AaronDewes
Copy link
Member Author

@gr2m It should be ready now, can you have a look again?

Copy link
Contributor

@gr2m gr2m left a comment

Choose a reason for hiding this comment

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

Code changes look good to me! Let's go 🚀

@gr2m gr2m merged commit b13e952 into probot:master Jul 4, 2021
@gr2m
Copy link
Contributor

gr2m commented Jul 4, 2021

New page is now deployed to and served from the gh-pages branch and live at https://probot.github.io/

If you like we could deploy to Netlify to get the previews on PRs?

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.

None yet

3 participants