search

saadpasta / developerFolio

🚀 Software Developer Portfolio Template that helps you showcase your work and skills as a software developer.
https://developerfolio.js.org/
GNU General Public License v3.0
5.33k stars 2.74k forks source link

Wiki for complete deployment of DeveloperFolio #190

Open saadpasta opened 4 years ago

saadpasta commented 4 years ago

Summary

I have received lots of messages that people are facing issues in deploying their portfolio to Github pages.

What's new?

We would create a simple video on how to clone our project and change details and deploy it to Github pages.

Motivation

It would help lots of newcomers to deploy their portfolio without any hassle.

kartikcho commented 4 years ago

A video walkthrough seems too much (maybe a youtube link if we want to do it), maybe a page on the "demo" portfolio that would be a step by step instruction with images to help set it up for deployment. Open to discussion on this.

naveen521kk commented 4 years ago

The video if required should be a YouTube link and according to me is way too much for this project. Also, create a wiki page for Deploying step by step with pictures would help instead of doing it in Readme file or the demo portfolio. The demo portfolio is intended for people 👫 to check how it actually works.

saadpasta commented 4 years ago

@naveen521kk @kartik918 so should we go with the readme with pictures.

naveen521kk commented 4 years ago

According to me, Readme looks pretty filled up. Rather, we could use GitHub Wiki for it. With pictures.

kartikcho commented 4 years ago

Pinging @saadpasta @naveen521kk for status on this issue. Anyone up for technical writing in the Wiki?

naveen521kk commented 4 years ago

Anyone up for technical writing in the Wiki?

Currently very busy for rest of year :(( Sorry.

warengonzaga commented 3 years ago

@kartikcho I'm a technical writer at Vultr and I guess you could use my help.... also If you guys need a video for it I can create one but it is needed to be uploaded to my YouTube channel is it good for you? @kartikcho if it is good assign this task to me.

kartikcho commented 3 years ago

Hey @WarenGonzaga that's awesome! I think a video would be unconventional and a bit overkill. A detailed step by step guide for setup + deployment, with some tips in customizing the portfolio for the user would be really great! Thanks for offering your help, assigning this to you.

warengonzaga commented 3 years ago

Alright thank you @kartikcho the documentation should be on Github wiki right?

kartikcho commented 3 years ago

the documentation should be on Github wiki right?

Yes. I don't have experience using GitHub Wiki for writing docs before so let me know if there's an access issue or something.

warengonzaga commented 3 years ago

Cool @kartikcho I'll let you know.

warengonzaga commented 3 years ago

Hi guys... sorry I'm a bit busy but still working on this.

MrAsimZahid commented 2 years ago

https://mrasimzahid.medium.com/how-to-deploy-developer-folio-on-github-pages-29c282f56749

If this is good, and the right way then I can convert it into the wiki. This works for me. So, I wrote it Thanks.

kartikcho commented 2 years ago

Hey @MrAsimZahid thanks for writing a blog to help people out! I took a look and it seems good for the wiki (although we could improve it by simplifying the terminal commands section and further explaining it for beginners).

The wiki should contain steps on deploying to .github.io and if possible, explaining how to deal with .env file secrets so users stop accidentally pushing them to their public repos (see #403).

Assigning this to you!

MrAsimZahid commented 2 years ago

@kartikcho How can I push the wiki to the repository. I have completed writing it. Need to publish it.

kartikcho commented 2 years ago

@MrAsimZahid this guide should have everything you need to know. Let me know if there are any issues or if you're having trouble with this guide, I can publish the page to the wiki on your behalf (with proper attribution of course) and add you to contributors.

AleixMT commented 1 year ago

Yeah... I have been trying to deploy this awesome project as a github.io user page for an hour and I do not understand what do I need to do. There are a lot of guides linked in the README.md but it is not clear exactly what you need to do to deploy the project to your own page. I actually followed the instructions but the page is not deploying. I do not think a video is necessary, instead, you should include all the steps in order to use the project as your own in the README.md instead of linking to many guides that only explain a fraction of the process. I will open an issue anyway to see if someone can help me but I am happy to see that the contributors are aware of the poor state of the documentation that covers the basic usage of this project. Thank you for your effort.

MrAsimZahid commented 1 year ago

@AleixMT I faced the same issue when I was working for my own site. I hope this will help.

https://mrasimzahid.medium.com/how-to-deploy-developer-folio-on-github-pages-29c282f56749