Update important Giveth docs

[c0ric0ri]

Please think about recording or documenting this in some way for onboarding purposes

[c0ric0ri]

@divine-comedian

[franculio]

I am copying @divine-comedian 's comment on the previous post about the things that need updating in the docs:

I could take a stab at this unless you had someone in mind.

I also was hoping to update some of these useful docs:

https://docs.giveth.io/dapps/projectdonating https://docs.giveth.io/dapps/createproject https://docs.giveth.io/dapps/gettingStarted https://docs.giveth.io/dapps/faq (Make it match - https://giveth.io/faq) https://docs.giveth.io/dapps/torusUserGuide https://docs.giveth.io/dapps/torusonramp https://docs.giveth.io/dapps/donatingmetamask

Replace photos https://docs.giveth.io/dapps/givethIO

It could be worth getting a newbie's eye on this I thought if @tropicalmangos wanted to own a task this may be good for her.

[divine-comedian]

I think the most important step will be to get yourself familiar with markdown syntax - this is what we use to format text in the docs to make it beautiful - it also is used in the forum as well!

https://www.markdownguide.org/

After that's there's basically two routes to editing the docs:

1. The less technical but more cumbersome/prone to breakage route is editing the docs directly from github. You can edit the docs right in github but adding in images can be annoying and there's no way to test if you did things right until the website breaks when you upload your changes.

2. The more technical but safer and efficient route is setting yourself up with a code editor like vscode and linking it to github. It's a steep learning curve since you're basically setting yourself up to be a developer but once you get the ropes it's very easy, fast and safe to edit docs.

Most people have been editing the docs with option 1, I think kay and myself are the only ones maintaining the docs through a code editor.

I would say it's probably not worth everyone's time to learn option 2 but if someone is serious about helping keep the docs trim and up to date then taking a dive into the technical realm will be worth their while.

[franculio]

Thanks @divine-comedian !

I already learned route 1 in a masterclass about markdown, hackmd and how to do update through github with Lauren. So I'm familiar with this way.

I do have vscode installed in my computer but I never really played with it much, maybe it's time! I'll do research on this.

My one question is about the images uploading, last time I updated through github I just copied them and they were available through imgur server and you changed to the local server (makes sense) but I don't know how to do that.

[laurenluz]

I think it would be great to decentralize Mitch on the docs here, and tbh would even love to know how to edit things on the docs using a code editor. I remember you (@divine-comedian ) taught this to jay a while ago...

Would you be down to teach Franco (and me! if I can jump in) how to do it properly? we can record the call/calls & keep them private so that in the future, others can do be onboarded more easily.

Then, I think we should make this issue an epic w/ each doc as a separate issue... QA is still important (even if only by 1 other person).

[divine-comedian]

Okay yes I'm down!

If you guys want to go the vscode route here's some things to get started:

• generate an ssh key and link it to your github account https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh

• set your username and email in git https://docs.github.com/en/get-started/getting-started-with-git/setting-your-username-in-git#setting-your-git-username-for-every-repository-on-your-computer

[divine-comedian]

maybe this friday we can plan something?

[laurenluz]

I could do 9-10am Friday Costa Rica time, or else can't make it. We'll be heading to SJO Friday.

[franculio]

Friday works for me! Just to be sure 9am Costa Rica is 5pm CET right?

[divine-comedian]

Okay I made the event - it should be on the giveth calendar https://calendar.google.com/event?action=TEMPLATE&tmeid=MWJtdWlvczVjcXFqM3VhZWo1MXZ0YzJjYTIgZWNwLm96ekBt&tmsrc=ecp.ozz%40gmail.com

[divine-comedian]

@franculio another side note - we also need to maintain our spanish translation of the docs As you're updating some key docs I am making a note here to show you how to put in the spanish versions as well

[franculio]

Perfect, thanks @divine-comedian !

[franculio]

Thanks @c0ric0ri for making this an epic! I've already created the issues for each update. I'll be working on this this week.

[oyealmond]

@franculio can we close this epic? Or are we still using it?

[franculio]

Closing epic