Giter VIP home page Giter VIP logo

womenandweb's Introduction

Women and Web Literacy

Build Status Dependency Status Dev Dependency Status Uses Mofo Standards

This repository hosts the code used to power the Women and Web Literacy hub's website.

Development

Setup

Requirements: Node, npm, git.

Run the following terminal commands to get started:

  • git clone https://github.com/mozilla/womenandweb.git
  • cd womenandweb
  • npm start

This will install all dependencies, build the code, start a server at http://127.0.0.1:2040, and launch it in your default browser.

File Structure

.
├── dest <- Compiled code generated from source. Don't edit!
├── scripts <- Scripts run by npm tasks
└── source <- Source code
    ├── images <- Image assets
    ├── index.pug <- Pug/Jade template for index page
    ├── markdown <- Markdown partials
    └── sass <- Sass code

Deployment

Production

Any commits to the master branch on this repo will trigger an automatic build and deploy to GitHub Pages.

Staging

There is currently no common staging environment for this project. However, you can easily deploy a staged build to your own fork using the following command: npm run stage REMOTE. Be sure to substitute REMOTE with the name of your personal remote. Also, be sure not to have npm start or npm server running when you run the staging command.

Once this task completes, your currently checked out branch will be available at:

https://USERNAME_FOR_REMOTE.github.io/womenandweb

Note: It can take a minute for changes to become available.

womenandweb's People

Contributors

amirad avatar fitojb avatar flukeout avatar gideonthomas avatar gvn avatar mmmavis avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

womenandweb's Issues

Add links to the reports

The links to reports under the "Teaching Resources" section are broken links (because they are empty). They need to linked properly once the links are available.

@amirad any updates on turning those report Google Docs into Github pages?

Add case study links

The case study section of resources does not have any links attached yet. This was done on purpose since there was a comment in the spreadsheet containing the resources to not publicly expose them until they're ready.

Once they're ready, we should update the links.

Change clubs quote

Change existing quote to this instead:

"Through Mozilla clubs I aim to help end the gender technology gap and empower women and girls to create innovative solutions to advance equality in their communities." Baratang Miya, Mozilla Clubs Regional Coordinator.

Deployments don't seem to be running

It seems that the automated deployments triggered from commits to master aren't happening.

The last deploy to gh-pages was March 31, but there have been commits since then.

This may have something to do with the failure of this commit.

Wiki changes

FYI: The following changes were made to this repository's wiki:

These were made as the result of a recent automated defacement of publically writeable wikis.

Add CI

Add Travis to enable tests and deployment

Post-mortem / Debrief

Based on the project and its timeline outlined here: MozillaFoundation/plan#826, we should talk a little bit about what we can learn from the whole experience.

It would be awesome if @flukeout, @gvn, @hannahkane, @amirad and @kaythaney would share their thoughts that might help inform how we approach future projects similar to this. This is not a requirement at all so if you think that your thoughts are captured by other comments, it's ok to not repeat.

Some things you can comment on could be:

  • The development process
  • The QA process
  • Defining the scope of the project
  • Stakeholder communication
  • Team communication
  • Determining the timeline
  • Parallelization of work
  • etc.

You could talk about any/all of this and anything else you would like to add (things we did right as well as things we did wrong along with suggestions on how we can improve).

cc @simonwex and @xmatthewx

Set up scaffolding

  • A single web page will be generated from markdown partials.
  • We will leverage mofo-bootstrap for styling.
  • Editing of markdown will take place on master branch. Travis will monitor master for changes, run the build task, and deploy to gh-pages automagically. #6
  • For development purposes, there will be a live-reload task monitoring the markdown and CSS for changes, which will rebuild and reload the local page in browser.

Set up Deployment

When commits are made to master it should trigger a deploy task to gh-pages.

CODE_OF_CONDUCT.md file missing

As of January 1 2019, Mozilla requires that all GitHub projects include this CODE_OF_CONDUCT.md file in the project root. The file has two parts:

  1. Required Text - All text under the headings Community Participation Guidelines and How to Report, are required, and should not be altered.
  2. Optional Text - The Project Specific Etiquette heading provides a space to speak more specifically about ways people can work effectively and inclusively together. Some examples of those can be found on the Firefox Debugger project, and Common Voice. (The optional part is commented out in the raw template file, and will not be visible until you modify and uncomment that part.)

If you have any questions about this file, or Code of Conduct policies and procedures, please see Mozilla-GitHub-Standards or email [email protected].

(Message COC001)

Onboarding for website edits

It would be good to setup a video call to onboard Amira to this repo and explain how the site goes live, how to make edits to the site, when will a dev be needed etc.

This will have to wait until the implementation is done (mostly).

QA the site on a Staging URL

@gideonthomas will spin up a heroku instance on the changes in #27 so that we can do some QA. Once the link is ready, I'll add it to this issue and assign some tasks to the holders of the stakes.

Front end implementation notes

Thoughts I'm having as I go along...

  • Not a fan of these .p-y-3 and .m-x-3 classes
    • Why are their rules !important?
    • Mostly I just want to ditch them, but not sure if that has some unforseen repercussions
    • The difference between a 2 and 3 is often too big
  • The indented HTML style is hard to work with, especially when borrowing markup from existing properties (like for the footer)
  • Hard to implement proper footer styling, even though it exists in a few places
    • Tried taking markup and CSS from the Science site
    • Had to copy over a few SCSS variables in the process
    • Would like a one-stop-shop link or copy & paste source for complete footer styling
  • When adding new images to a subfolder in the /images folder the server needs a manual restart for the image to be available to the front end
  • Several times I've "lost" images, they've either reverted to a previous version or disappeared entirely. Not sure how to reproduce. Could it be something in the build process?

Create preliminary wireframes

Create preliminary wireframes based on this content doc.

Main Goals

  • Determine navigation style
    • Side-menu with different sections like the Clubs Guides
    • Fixed header when page scrolls
    • None - just a long scrolling page
  • Determine order and placement of content
    • Desktop & mobile
  • Identify any missing content or asserts

Questions

  • What is the primary objective of the site?
    • To get people to Sign Up?
  • What is the main title of the site?
    • Women and Web Literacy?
    • Is there a tagline to go with that?

Assets & copy needed

  • Large hero image
  • Partner org logos

Quote missing in mobile view

The opening quotation mark is almost fully out of view in mobile view. Side-note, can we change the quotes to be less typewriter-y and more like what the design shows?

Implement Women & Web Lit Site

We are moving forward with this design...

We're still deciding some aspects of the intro text treatment, but it's not important.

Plan of Attack

  • @gvn will set up the necessary HTML scaffolding and markdown files
    • Includes setting up columns where necessary
    • Use placeholder content roughly in the length of what is in the design
  • @flukeout will populate with final content and style the page
  • @amirad will dig up Collaborator logos
  • @amirad to shorten the 2 existing Blog Post descriptions
  • @amirad to provide 3rd piece of content for Inclusion section
    • Where the two existing blog posts are

Some extra files

Design Women & Web Lit site

Moving on from #4 - let's get into some visual design. I made two options based on the wireframes.

Please leave your thoughts and feedback, looking for big-picture stuff like

  • Overall feel & tone
  • Color palette
  • Choice of imagery for the header
  • etc.

Will ping the design team for a review as well.

cc @amirad

We've also gathered feedback on the Wireframes during our crit, which raised some good questions. I haven't acted on them yet so as not to delay the visual design phase, but it would be good to address them so we can make changes now or soon...

  • Should we include content & calls to action for people looking to find an existing club?
    • We only really target the organizers with our current CTA
  • Should we include a case study or a more personal story of some sort?
    • We could expand on the quote that is currently in there maybe, add a face and name?

Add footer

Add the footer to the site with all the relevant links

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.