devops-exercises icon indicating copy to clipboard operation
devops-exercises copied to clipboard

[Suggestion] WebPage For Reader

Open Rahulsharma0810 opened this issue 4 years ago • 10 comments

HI,

This Project is awesome and I really like it, But it lacks readability. especially in the case of new question updates, will it be possible to publish this repo as web/Github Pages? Or publish a page for example every week for new questions only.

Example: https://rahulsharma0810.github.io/devops-exercises/

I used pandoc to generate HTML (with some styles), But there is a challenge of keeping the newest question on top or on a different page.

Rahulsharma0810 avatar Nov 19 '20 07:11 Rahulsharma0810

@Rahulsharma0810 The link isn't working for me, can you fix that?

As for readability, I get what you are saying. It's true, this is not a web page or a system, rather a simple markdown. I can't promise it will change anytime soon but I will definitely start looking into what we can do to improve readability and overall the learning experience. Thank you for your feedback.

I'll keep this issue opened so we can keep developing the idea and discuss the details.

bregman-arie avatar Nov 19 '20 17:11 bregman-arie

@bregman-arie you can check https://rahulsharma0810.github.io/devops-exercises, this is built with https://docsify.js.org/#/, from a single command.

I think docsify is something we can start with.

Thanks, Rahul Sharma

Rahulsharma0810 avatar Nov 20 '20 12:11 Rahulsharma0810

It looks good but still, it's static and requires some maintenance around keeping a page of "new questions". What do you think?

bregman-arie avatar Nov 21 '20 00:11 bregman-arie

I think we need to publish a page every week though diff from a single week, GitHub actions can help us in it to make the process automated.

Rahulsharma0810 avatar Nov 22 '20 16:11 Rahulsharma0810

Any updates? Why not just use Github page? It's just a few clicks away.(in settings/pages). Will have to deal with the /README.md links in the HTML code and escape {{}} tho.

For example, this is what I just forked and auto deployed https://dlccyes.github.io/devops-exercises/

dlccyes avatar Nov 06 '22 17:11 dlccyes

@dlccyes how did you associate devops-exercises fork with your user site? (dlccyes.github.io)

bregman-arie avatar Nov 07 '22 07:11 bregman-arie

In settings -> pages

image

It's pretty plug-and-play

dlccyes avatar Nov 07 '22 09:11 dlccyes

I've done exactly that but for some reason it doesn't work

bregman-arie avatar Nov 07 '22 10:11 bregman-arie

Well actually it did work, it's just that the job had failed due to {{}} not being escaped, as shown in https://github.com/bregman-arie/devops-exercises/actions/runs/3408200210/jobs/5668558828

Now that you've enabled it, I can help fix that with a PR when I have time

dlccyes avatar Nov 07 '22 10:11 dlccyes

Please approve this PR https://github.com/bregman-arie/devops-exercises/pull/310

dlccyes avatar Nov 07 '22 11:11 dlccyes

Thanks! looks good :)

bregman-arie avatar Nov 09 '22 18:11 bregman-arie