search

uillinois-community / uillinois-community.github.io

User-supported documentation for the University of Illinois github service.
6 stars 3 forks source link

Windows GitHub actions docs #16

Closed jtgorman closed 3 years ago

jtgorman commented 3 years ago

some docs on using GitHub Actions

areynold commented 3 years ago

Sorry, Jon, I saw this come in a while ago, but I thought it was on a different repo.

On the whole I think this is fine, but I have some suggestions that I think will make the docs more readable.

My biggest complaint is the side scrolling and lack of syntax highlighting in the preformatted text, but I don't have a ready solution to that problem. I will see what I can turn up.

There's also no way to get to these docs unless you know they're there. Should these be linked from the main index?

Additional comments inline on the file changes.

jtgorman commented 3 years ago

Good suggestion as far as the link on the main page, I'll add that in, will also make the various changes suggested as well in a bit and do another push.

areynold commented 3 years ago

I've come across a handful of syntax highlighting projects, but most of them seem to be archival, limited in scope, or both.

The quick and dirty solution would be to use something like hilite.me to handle code in pages on a case-by-case basis. I think I'd prefer an optional css class and syntax highlighting library, which could be used by any of our doc authors:

Happy to move this to an issue if you think it warrants it. I don't think this is enough of a problem to hold up your PR.

jtgorman commented 3 years ago

Btw, people wanting to see how this will look and don't want to skim the html can look at https://jtgorman.github.io/uillinois-community.github.io/. Not sure if there's another way to visualize the html easily.

I also wasn't entirely sure how we wanted to add links to the front page, so just added a Topics seciton with an unordered list and added the link there.

areynold commented 3 years ago

I think that's a reasonable solution. We can reevaluate if the topics start getting unwieldly.