Promote contributors more

[cannikin]

Maybe it gets its own page in the left nav, rather than being inside Docs?

[simarpreetsingh-019]

Can you define it a bit more so as to understand the issue?

Are you referring about taking out the contributors page outside of the docs and showing it in left nav-bar as a whole topic like docs/roadmap/ video section?

If so, I would like to work on this issue.

[thedavidprice]

Hi @simarpreetsingh-019 We'd be grateful to have your help! Thank you in advance.

Please take a look at the info below and confirm if you'd like to take this on. We'll assign it to you if so.

Contributor Getting Started Info

If you haven't already, please do take a look at this information about getting started as a Redwood contributor: https://github.com/redwoodjs/redwoodjs.com/issues/393

Issue Description

For this Issue, we'd like to see this Contributors section (currently at the end of /docs/introduction) be a standalone page in the left nav:

• https://redwoodjs.com/docs/introduction#contributors

So the Left Nav would be:

• Roadmap
• Contributors
• Docs
• ...

The steps to implement would be something like:

• choose an icon from Google Material Icons, the two-tone version
• add the Nav menu item
• parse the source markdown file to get the Contributors section (it's the README.md file in the Framework repo): https://github.com/redwoodjs/redwood/blob/main/README.md
  • I'm not sure if it matters whether or not docs/introduction will also contain the #contributors Seems like it would be better if not to avoid redundancy.

@cannikin any other thoughts/suggestions?

---

[cannikin]

Sounds good to me!

[simarpreetsingh-019]

@cannikin @thedavidprice thank you that you haven't assigned this issue to anyone else, as I am a bit late in replying to the task list, was having my exams. @thedavidprice what if instead of parsing, I just split the contributor's section from the introduction page and show it as a standalone? would that be okay?

And I got some SVG's, suggest to me which one would be good for using for this section.

1. 

2. 

3. 

4. 

And one for Roadmap also :

What say, which one should I add?

[thedavidprice]

I just split the contributor's section from the introduction page and show it as a standalone? would that be okay?

^^ Yes, this is probably what I meant to say. "Parse" was likely too technical for my suggestion 😆

Contributors Icon: I like option 3

Roadmap Icon: That looks good!

---

What do you think @cannikin?

[cannikin]

Yup I like 3 as well! Love the Roadmap icon, too.

[simarpreetsingh-019]

@cannikin been a long time, got affected by our novel virus during my exams. so was not able to do it much.

But have been back to work, i am facing problem, where is the introductory file in docs? and where should i be adding the details? like where is the main source code file like index.html? I just got confused with the js.

[cannikin]

Hi @simarpreetsingh-019 hope you're doing better!

So the site isn't based on any framework, just good old fashioned HTML (it actually uses my own framework CameronJS, but it's based mostly on just rendering HTML pages). If you're looking for a page it's probably in that same directory structure in the code/html directory, unless it's a generated doc (like ones that starts as Markdown and get turned into HTML). You can find the list of generated pages in the build script here: https://github.com/redwoodjs/redwoodjs.com/blob/main/lib/build.js#L19-L144

You'll see the sections like tutorial and cookbook are the same as the sections in the nav. You can find the main left nav here: https://github.com/redwoodjs/redwoodjs.com/blob/main/code/html/_nav.html The sub-nav, like the links that are shown when you open up a nav section like "Cookbook," are generated by the build script based on all the Markdown files in that section.

[simarpreetsingh-019]

I am sorry, but I think that valuable time has been utilized, but I think it would be good that someone else could be solving this at the moment, it is taking much time from my side to properly understand the framework, although side by side I will be trying to do it, but if there come someone else who could do it before me, would be great and will save your time also.

P.S : it was an accidental click due to which the issue got unassigned by me. but it would be no problem if untill someone else is coming, you could reassign this to me or just keeping it without assigning anyone also, your call.

[cannikin]

@simarpreetsingh-019 It's okay, don't worry about it, I'm sure someone else will pick it up!