sudomesh / peoplesopen-front Goto Github PK

Front landing page for the peoplesopen.net website.

License: MIT License

CSS 86.55% JavaScript 3.37% HTML 10.08%

peoplesopen-front's Introduction

PeoplesOpen.Net

This repo stores the content and builds the static html for the peoplesopen.net website, excluding the blog/ and gardenmesh/ directories.

Make changes

If you want to change the text/links/images on a page, simply edit the index.md file in the corresponding page directory in src/.

If you want to add a new page that will live at, say, https://peoplesopen.net/sour-raccoons, create the src/sour-raccoons directory, and put an index.md in it.

View your changes locally

First you'll need to install node.js. Then:

cd peoplesopen-front
npm install               (install all the dependencies needed by our gulpfile)
npm install -g npx        (npx comes with new versions of npm)

Now you're ready. This command runs a local webserver:

npm run dev

And this one rebuilds the web/ directory with your latest changes:

npm run build

Publish

After gaining ssh access to the peoplesopen.net webserver, run:

npm run publish

which is just an alias for npx gulp && scp -r web/* [email protected]:/var/www/peoplesopen.net/public-current.

Structure

- lib/                    # helpers used by the gulpfile

- src/                    # page content and assets live here
-- about/                 
--- index.md              # every page has an index.md that lives
                          # in a directory corresponding to the page's url
                          # (e.g. peoplesopen.net/about)

                          # at the top of the index.md, you can specify
                          # the page title and the name of the template to use
                          # to render the page (see templates/)

-- assets/
--- files/
--- fonts/
--- images/
--- javascript/
--- stylesheets/

- templates/              # reused html lives here (e.g. page layouts)
-- html.twig              # this is the base html used for all pages
-- layout/
--- homepage.twig         # this is the html used for the homepage
--- two-columns.twig      # this is the layout used for pages with the "Let's Hack" sidebar

- config.yml              # project settings (e.g. website title)

- gulpfile.js             # turns .scss and .md files into css and html files
                          # in the web/ directory

- package-lock.json       # these files keep track of dependencies used by the gulpfile 
- package.json

peoplesopen-front's People

Contributors

Stargazers

Watchers

Forkers

opendata imclab optimist2309 jeffreychung nanomonkey bennlich gobengo kaldari peppernrino elimisteve amberinitiative qsymmachus msgpo

peoplesopen-front's Issues

markedjs vulnerability

Recent update to using gulp method of building peoplesopen-front as a static site produced a vulnerability with a npm package named markedjs. Update to newer version in package.json and test build process.

Maybe we should include something about cost?

That's one of the first questions a lot of people ask about it.

Explain what join the network means

It would be cool if the "Join the network" link on the homepage went to a quick explanation of what that means in material terms. Something like "Set up a home node ($20 and half hour work), help other people set up nodes (meet on a Sunday), special bonus awesome for having a house on a hill, ..." Related to #5. There could also be a link to the map but with some context like "See current nodes/sign up for a node setup party"

Add FAQ page (in particular, security, privacy, and the mesh)

We got some great questions talking to tenants at a new potential install location:

How will it impact our internet use (eg. speed, possibility of dropped access/having to re-boot) short-term? Long-term?
What is the risk of EMF radiation?
Where will the antennas go? Who maintains them? What happens to them when we replace our roof in a few years?
Is there any security risk? eg. Are we liable for any content that runs over the network?
How safe/encrypted is this network?
What are the benefits to the building? To our neighborhood?
What are the building tenants' responsibilities for maintaining the antennas? What's the plan if People's Open dissolves? What happens if there's a conflict or change of plans between People's Open and the building? aka how do we resolve conflict, like if new tenants move in and don't want the antennas here anymore?

Let's make an FAQ page that answers these questions and more. I want to expand on the security/privacy question too. We should be clear that:

the mesh is not intended to be an encryption/obfuscation service (like, say, the Tor network)
that you are relying on the neighbors to whom you're connected to route your packets
that the HTTPS protocol still makes the same guarantees about your privacy that it would with a normal ISP (i.e. the content of your traffic is encrypted, but not the source or destination ip)

Since part of our mission is education, I think it would also make sense to talk a little bit about security on the normal Internet, the anatomy of an IP packet, etc. (I.e. explain security from first-ish principles.)

Some of this could involve some fun research. E.g. I'm not sure off the top of my head what a packet looks like traveling from an exitnode to the Internet.

Please correct me if I got any of the above wrong!

redesign navigation

Suggestions on improved top nav bar:

Change 'Home' to small logo?
About w/ dropdown menu items: Docs, Wiki, Map, Swag
Participate w/ dropdown menu items: Join, Help Out, Develop
Blog
Donate

workshop page broken

gumbypress: wordpress theme for gumby

Useful to use this? https://github.com/tubiz/gumbypress

delete stale gh-pages branch / make master the default branch

@paidforby

The latest version of peoplesopen.net is now in the master branch. Let's make that the default branch and delete the old gh-pages branch.

Finish migrating html -> markdown

The developer, documentation, how-to-help, and join-the-network files are still html dumped inside of markdown files. As much as possible, it would help to rewrite this html as real markdown. See the workshop markdown for an example.

Set up etherpad-lite instance at peoplesopen.net/notes

source and readme at https://github.com/ether/etherpad-lite

Fix various bugs with mobile layout

the buttons that expand the menu items are difficult to tap w/o tapping the menu headers themselves
the hamburger menu icon covers the peoplesopen.net banner
the banner's y position is slightly too high
the participate column below the main content blends into the main content

Add SEO keywords

Someone tonight mentioned the SEO has room for improvement.

The easiest way to start would be to add some keywords to the homepage HTML by adding a <meta name=keywords /> element.

What keywords should we advertise? Contribute some. Whenever I or someone gets around to implementing this, we will just use all of them.

monitoring links defunct

replace the monitoring tool widgets on the peoplesopen.net sidebar with functioning monitoring tools

Direct "Join the Network" to a different page

Instead of having the "Join the Network" link jump directly to the map with no explanation, have it goto another page (or a different part of the front page) that explains a bit about the network, getting a node, setting up an antennae, making a donation, and then link to the map.

Issue with https certificate

Not sure where this is managed exactly but just wanted to let someone know.

user flows

How will users interact with this page?

We have two primary actions already "Join" i.e. buy a node, and "Help" i.e. participate in the group somehow, look at our wishlist, join the newsletter, etc.

Need to grow content out on the landing page.

replace colors

seems this is using the Gumby framework, so we should be able to generate new styles with colors and fonts from our palette using this: http://gumbyframework.com/customize