search

freeCodeCamp / mail-for-good

An open source email campaign management tool for nonprofits
BSD 3-Clause "New" or "Revised" License
3.83k stars 476 forks source link

Create a Website for Mail for Good based on GitHub pages #170

Closed karuppiah7890 closed 6 years ago

karuppiah7890 commented 7 years ago

In this website, we can mention the features of Mail for Good Beta and also put up more screen shots of the web app

seanWLawrence commented 6 years ago

@karuppiah7890 @AndrewGHC I took a few screenshots of the "Creating campaigns" and "Settings" screens (blank). Let me know if you think I should change anything and your thoughts on if I should a) add new sections to the site specifically for these instructions or b) add them to the deployment instructions?

Secondly, would you also like me to to write the instructions on how to do these?

screen shot 2017-11-21 at 4 51 01 pm screen shot 2017-11-21 at 8 56 21 am screen shot 2017-11-21 at 8 55 54 am

karuppiah7890 commented 6 years ago

@seanWLawrence The screenshots are good, and about instructions, I think we can add it to the Wiki later and then the site can get it through the wiki like how it currently gets other docs (installation and others)

seanWLawrence commented 6 years ago

@karuppiah7890 Sounds good, you can check out the screenshots on the home page here.

Two things worth mentioning are that my screen resolution is slightly smaller and the original screenshot (the Mail For Good landing page) has a faded color. I'm happy to redo the original one so they all match, but it'd be a little smaller-sized.

Lastly, and my name/email is on it the screenshots - which I don't mind - but I'm curious about your thoughts since they don't match the original.

karuppiah7890 commented 6 years ago

I don't think it's a problem, but if you want to make the user accounts to be the same, and redo the original ones, I am cool with that. 👍

seanWLawrence commented 6 years ago

@karuppiah7890 Cool, I'll just leave it then to keep things simple. Would you like me to get it ready and make a PR, or add anything else to it at this point?

karuppiah7890 commented 6 years ago

Let's start making a PR and merge to gh-pages branch

seanWLawrence commented 6 years ago

@karuppiah7890 Pull request: #248 This is my first pull request, so please advise if I need to alter the it in any way. Thanks!

zhakk-harn commented 6 years ago

@seanWLawrence I'll take a deeper look at your PR later but I think that reading the freecodecamp contributing guide might help you. The "Forking the project"->"Maintaining your fork" might help you to submit a PR which only contains the changes you are proposing.

But again it's 4am here and I'll give you better feedback tomorrow.

seanWLawrence commented 6 years ago

@zhakkarn Hey, thanks again for your help on the PR. Is there anything else that I can help with at this point to get the site up on GitHub Pages?

@karuppiah7890 Also, I'm happy to maintain it as the docs change/grow, and if new features need to be added if you're still open to it - just let me know what kind of workflow you'd like to have for me to stay updated, and if you'd like anything else added at this point.

zhakk-harn commented 6 years ago

@seanWLawrence Alright, I had to move just some bits here and there but now your baby is live at https://freecodecamp.github.io/mail-for-good/ thank you again for this.

QuincyLarson commented 6 years ago

@zhakkarn Wow - this looks great! There are a few minor things I think we should change to get it to conform to our design style guide but in general this looks solid, and does a nice job of bringing all the information scattered across the repo together into one browsable page.

How much maintenance would this page require? Will it automatically pull current versions of these files from GitHub ?

Once this is 100% ready, I think we can deploy this via Netlify and point the mail-for-good.freecodecamp.org subdomain to this.

seanWLawrence commented 6 years ago

@zhakkarn Thanks, it looks great, and I really appreciate your help!

@quincylarson I'm happy to update the css to conform to the style guide - thoughts?

It shouldn't require much maintenance, though if you guys would have me, I'd love to help add new features as needed and/or stay in the conversation about the site in case there are any bugs I missed, etc.

And yes, the markdown files for it are located in the /docs folder and will update the site as new changes are pushed.

PS. It's worth noting that the class "image" needs to be added to any image/screenshot that you want to pop up as a modal when clicked on desktop. The functions for this modal can be found in /docs/javascripts/modal.js