Design Contributor and Funder Guide Pages

PixelantDesign commented 6 years ago

As a contributor/funder, I'd like to see an on brand developer and funder guide.

Why Is this Needed

Summary: It's in Google Docs

Description

Type: Feature

These pages will live under How It Works > Help menu

Definition of Done

[ ] Please review all content and ensure layout will work for all scenarios
[ ] Design must be responsive
[ ] Design must be on brand, see creative repo for brand guide

Developer Guide

Repo Maintainer guide

Additional Information

Please review with core team members" @PixelantDesign

owocki commented 6 years ago

i wonder if it'd be worth creating a lightweight django CMS so that anyone can create / edit content ... not just dev team

PixelantDesign commented 6 years ago

Maybe in this case, it makes sense to install the CMS and see what templates are available and updating colors and design after. Thoughts?

@owocki

olafghanizadeh commented 6 years ago

@owocki We were talking about this a few months back in the Slack, to implement a static site generator to compile the content when the site builds instead of having content spread into different files and hardcoded.

owocki commented 6 years ago

https://github.com/django-helpdesk/django-helpdesk

looks interesting and well supported by its community. what would the group think about provisioning a small bounty to integrate it into our system?

cc @mbeacom

PixelantDesign commented 6 years ago

Sounds good to me!

mbeacom commented 6 years ago

@owocki django-helpdesk looks alright. If we're looking to add a CMS component, https://github.com/wagtail/wagtail is fairly popular and highly customizable (for a django cms). In any case, either of those should do the job.

thelostone-mc commented 6 years ago

+1 wigtail

gitcoinbot commented 6 years ago

Issue Status: 1. Open 2. Cancelled

Work has been started.

These users each claimed they can complete the work by 5 months ago. Please review their action plans below:

1) justpixel has been approved to start work.

The design should look like any other Gitcoin page or will be a customized django template?

Learn more on the Gitcoin Issue Details page.

owocki commented 6 years ago

i'm down to try wigtail. looks powerful

gitcoinbot commented 6 years ago

@justpixel Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

[x] warning (3 days)
[ ] escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

PixelantDesign commented 6 years ago

Are we able to do something like this with Wigtail?

olafghanizadeh commented 6 years ago

That should be just a matter of creating the layouts.

Perhaps there are some options to Wigtail? Wouldn't it be better to have a git-based system that uses markdown for content so people could contribute to the docs without having to be added as users.

PixelantDesign commented 6 years ago

Hmmm..that's a good point @olafghanizadeh.

olafghanizadeh commented 6 years ago

I would like to take on the challenge of integrating Hugo with this if I could some help with integrating it with the current Docker setup.

There is a docker image: https://github.com/jojomi/docker-hugo

mbeacom commented 6 years ago

Honestly, I am a huge fan of Hugo, but I rather we keep the project aligned and we can simply integrate wagtail into the existing platform versus having multiple separate services. The templating would be handled in this same repo without adding the complexity to contributors to understand multiple templating engines. We should be able to reuse a decent amount of what we already have with minimal adjustments.

justpixel commented 6 years ago

This is the contributor guide page. I'll get back with the funder guide soon.

olafghanizadeh commented 6 years ago

Looks cool :)

@mbeacom Perhaps there is a static site generator with markdown files that works with the current setup? I feel like it would be more intuitive to implement something that uses git to version content, it also allows people to contribute without having to go through one of the admins to get a user account.

owocki commented 6 years ago

this looks really good :)

note- i dont have any special attachment to having my face/avatar on this page. though it is nice for developers to feel like there is a face / person behind the project

owocki commented 6 years ago

might be good to unify the icon set here => http://bits.owocki.com/121g0H0z3t07/Screen%20Shot%202018-07-23%20at%202.42.35%20PM.png

the issue explorer icon could certainly use an update

justpixel commented 6 years ago

@PixelantDesign @owocki I've made the changes to the "Tools" section and also added the funder page. funder contributor

gitcoinbot commented 6 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

Work for 0.25 ETH (117.77 USD @ $471.08/ETH) has been submitted by:

@justpixel

@PixelantDesign please take a look at the submitted work:

PR by @justpixel

Learn more on the Gitcoin Issue Details page
Questions? Checkout Gitcoin Help or the Gitcoin Slack $30,515.82 more funded OSS Work available on the Gitcoin Issue Explorer

PixelantDesign commented 6 years ago

Looks good!

What do the green dots on the left nav indicate?
Can we try one header for this page instead of two? @justpixel
Will you also mockup a developer guide?

mbeacom commented 6 years ago

@olafghanizadeh Why would a user need admin intervention to be able to submit content if we used something like wagtail? You would use the same gitcoin account and auth flow we have today, but you would submit content for review via a web ui. Also, there are pre-existing django static site generators (if we're discussing SSGs...) that wouldn't require some content to be written in MD while others are written in django templates. Feel free to open a SSG thread for discussion.

justpixel commented 6 years ago

@PixelantDesign

I've replaced the dots with a line that indicates the position in page
It's only one header now.
Developer Guide is already here.

owocki commented 6 years ago

looking really good!

PixelantDesign commented 6 years ago

yes! looks great! Thanks!

gitcoinbot commented 6 years ago

Issue Status: 1. Open 2. Cancelled

The funding of 0.25 ETH (108.3 USD @ $433.19/ETH) attached to this issue has been cancelled by the bounty submitter

Questions? Checkout Gitcoin Help or the Gitcoin Slack
$28,018.87 more funded OSS Work available on the Gitcoin Issue Explorer

gitcoinbot commented 5 years ago

Issue Status: 1. Open 2. Cancelled

Work has been started.

These users each claimed they can complete the work by 5 months ago. Please review their action plans below:

1) justpixel has been approved to start work.

Will this be a Django template or it will look like any other page on the Gitcoin website?

Learn more on the Gitcoin Issue Details page.

gitcoinco / web