creativecommons
[Feature] Include links to tutorials and references for the technology dependencies required to set up the project locally
Problem
It's very confusing and time taking process of setting up the project locally and hosting it on a local host.
Description
Based on my understanding of the problem and the user's perspective, I suggest the addition of a set by step procedure of local hosting of the website. By this feature, we eliminate confusion. This could increase clarity, improve usability, or a better overall user experience. I personally spent an hour trying to understand how to set up the project locally. It could enhance user engagement and motivates them to work on things that truly matters rather than just being on setting up.
Alternatives
An alternative solution can be docker , but based on my understanding Setting up GitHub Pages using Jekyll can be better than using Docker for a few reasons:
Simplicity: GitHub Pages and Jekyll are relatively straightforward to set up and use. Jekyll is a static site generator that allows you to create a website from plain text files, and GitHub Pages is a hosting service that allows you to publish your Jekyll site to the web. Docker, on the other hand, is a more complex tool that requires additional knowledge and configuration.
Cost: GitHub Pages is free, while Docker requires you to set up and maintain your own server infrastructure, which can be expensive.
Maintenance: With GitHub Pages and Jekyll, you don't have to worry about maintaining server infrastructure, as GitHub takes care of that for you. With Docker, you would need to ensure that your server infrastructure is up to date and secure.
Version control: GitHub Pages is tightly integrated with Git, so you can easily version control your website and collaborate with others. Docker, on the other hand, doesn't have the same level of integration with Git.
Implementation
- [x] I would be interested in implementing this feature.
I hope the most significant issues in setting up the project were resolved by #53.
The documentation in the CC repositories should be limited and project/repository specific. The primary focus of our projects/repositories is not teaching technologies. There are other sites that focus on education or reference that are already doing a better job than we could. We can use their excellent work! I do think it would be helpful to include technology dependencies and links to authoritative sources for learning those dependencies (CLI, CSS, git, GitHub, HTML, JavaScript, etc.).
Also, more detailed instructions related to the specifics of a project/repository can make a great blog post. Take us on your learning journey!
I second @TimidRobot's suggestion of perhaps linking out to helpful resources.
I'd love to see what links or resources anyone suggests? And I'm moving this to ticket work required until there's sound proposals on what that would entail.
Otherwise I think that these Issue help clarify things and make setup smoother going forward:
- #53
- #56
Also, @nishchay-veer thankyou for this contribution ❤️ , can you please amend the Issue to use the proper Issue Template, rather than deleting out the extra parts (like the checklist at the bottom). Thanks!
Sure @possumbilities I'll do that. Also the suggestion of including links to tutorials and references by @TimidRobot sounds good and would smoothen the process of setting up. Can you please assign this work to me ?
@possumbilities Here are some tutorials and documentation to help us to set up GitHub Pages using Jekyll/Docker that I find best and most precise. Resources to set up project locally using Jekyll:
- Youtube Tutorial on How to install and run Jekyll on Windows 10- https://youtu.be/HlfvhkDuicc
- Setting up Jekyll and Github pages locally with Ruby on Windows 8.1 x64 https://youtu.be/t9qDNe7xk4c
- Jekyll official documentation: The Jekyll documentation provides detailed information on how to install and use Jekyll to build your website. It covers topics like creating a new site, adding pages and posts, and customizing your theme. You can find it here: https://jekyllrb.com/docs/
Resources to set up project locally using Docker:
- Youtube tutorial on How to set up a docker container to run your GitHub pages site? https://www.youtube.com/watch?v=6UAf8b_2juk
- Documentation for the given youtube tutorial - https://takacsmark.com/how-to-set-up-docker-container-for-your-github-pages-jekyll-site/
@nishchay-veer haven't had a chance to watch/read the suggestions yet.
The only thing I can offer is that tutorials put put by the technologies theirselves (preferably hosted on their blog or docs) are more longterm stable than other places. That may help shift things until I dig in further.
@possumbilities If its possible i would like to work on this issue please assign me to get started
