Improve documentation on how to collaborate

Question

Improve documentation on how to collaborate

anibalsolon opened this issue 5 years ago · comments

Anibal Sólon commented 5 years ago

Update README.md with details about how it works and how to edit it.

Pradeep Reddy Raamana · Answer 1 · Thu May 09 2019 23:04:04 GMT+0800 (China Standard Time)

Hi Annibal, did you get a chance to work on this?

Anibal Sólon · Answer 2 · Fri May 10 2019 04:17:17 GMT+0800 (China Standard Time)

Hi @raamana

I've updated it with the basic structure of the repo, could you give some directions on how to improve it?

Pradeep Reddy Raamana · Answer 3 · Fri May 10 2019 21:06:01 GMT+0800 (China Standard Time)

Thanks, that's great and helpful now. I had to install gatsby for some reason, but perhaps that might not be needed for everyone.

We might have to distinguish between blog posts (news) and regular pages.

As I use it, I will also update README.

Anibal Sólon · Answer 4 · Fri May 10 2019 21:08:07 GMT+0800 (China Standard Time)

Cool! Yes, I guess I also need to add some documentation on how to develop and test locally.

…

On Fri, May 10, 2019, 09:06 Pradeep Reddy Raamana ***@***.***> wrote: Thanks, that's great and helpful now. I had to install gatsby for some reason, but perhaps that might not be needed for everyone. We might have to distinguish between blog posts (news) and regular pages. As I use it, I will also update README. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#2 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAEJKXJEFC3YJWHKTDQHDQLPUVXLVANCNFSM4HFTE3CQ> .

Pradeep Reddy Raamana · Answer 5 · Fri May 10 2019 21:24:54 GMT+0800 (China Standard Time)

Exactly - I was just about to say the same. How can I check how the commit changes the website before I push it to remote?

Pradeep Reddy Raamana · Answer 6 · Fri May 10 2019 21:59:10 GMT+0800 (China Standard Time)

I added a new page Get Involved with latest commits
https://circleci.com/gh/INCF/niQC/41

it doesn't seem to get added to the website - perhaps I missed a step in creating and adding a new page?

Anibal Sólon · Answer 7 · Fri May 10 2019 22:22:04 GMT+0800 (China Standard Time)

Hi @raamana

About the page you created, it is deployed in https://incf.github.io/niQC/getinvolved
I will add an extra meta-data field for pages to indicate if it should appear on the header menu, and in which order.

Pradeep Reddy Raamana · Answer 8 · Fri May 10 2019 22:32:47 GMT+0800 (China Standard Time)

Thanks.

I thought the header is generated automatically! I guess I am wrong.

Pradeep Reddy Raamana · Answer 9 · Fri May 10 2019 22:36:36 GMT+0800 (China Standard Time)

header menu is managed by editing NavBar in src/layouts/NavBar.jsx ?

Anibal Sólon · Answer 10 · Fri May 10 2019 22:40:28 GMT+0800 (China Standard Time)

Yes, in a list of elements!

Anibal Sólon · Answer 11 · Fri May 10 2019 23:58:01 GMT+0800 (China Standard Time)

So no it is not a list anymore, I will update the README on how it works now.

Pradeep Reddy Raamana · Answer 12 · Sun May 12 2019 22:42:36 GMT+0800 (China Standard Time)

Okay - please do.

I added another new page Resources
adb9d89

~~it doesn't seem to show up on the live page yet.~~ Works now.

Anibal Sólon · Answer 13 · Mon May 13 2019 06:36:09 GMT+0800 (China Standard Time)

Sometimes it may take some time, given Github Pages cache