opentechinstitute/commotion-docs

Commotion web documentation

commotion-docs's Issues

Broken image links in HIG introduction

http://commotionwireless.net/developer/hig/introduction has two broken image links in the first section.

1. https://commotionwireless.net/sites/commotionwireless.net/files/browserscreen.png
2. https://commotionwireless.net/sites/commotionwireless.net/files/introduction_androidintroscreens.png

Looks like sites/commotionwireless.net/ should be removed from each.

Add a serval key-chain documentation needs to read as follows.

Add a new key-chain

• Go to the “Basic –> Security –> Shared Mesh Keychain” menu

• If the menu is populated with the options to "upload, download, and create" a shared mesh keychain follow the "Delete a keychain" instructions below and then continue.

• Click the add button

• Click the "Create a new Shared Mesh Keychain file" button.
• Click "Save and Apply" when asked to confirm the configuration.

• Wait for the "Applying Changes" page to redirect you back to the status page.

Update CCK pages with CSS styles from current site

The styles for CCK modules need to be updated to match the current production site.

Sample flier links to wrong document in CCK / Get the Word Out

In Get the word out, the "Download an example flyer" link goes to a PDF of the module, not an example flyer.

The proper file is here:
http://commotionwireless.net/sites/commotionwireless.net/files/get_the_word_out_flyer_design_support003_0.pdf

Add warning label to download/computers

The Commotion Warning label should be on all download pages, but is missing on this page download/computers/.

Broken link in CCK / Gather tools and equipment

In Gather Tools and Equipment there is a broken link.

The link is:
http://staging.commotionwireless.net/construction/learn-about-rooftop-mounts
and should be:
http://staging.commotionwireless.net/docs/cck/building-mounting/learn-about-rooftop-mounts/

Document Application Recommendations

We have a number of application recommendations or requests for recommendations stemming from live commotion networks.

Where strong preferences have emerged, we should document our preferred chat/streaming audio/filesharing apps and their use.

Add "top" navigation links to the blogindex page

Provide "top of page" links and id tag to the blog index page to provide better in-page navigation.

Add contact form

Web forms in Jekyll are basically a static html web form or a cgi script. Implement a contact form replicating the functionality of the current site

Mesh over ethernet instructions incorrect for 1.0

User feedback from the website and IRC was received about the "Common Configurations" CCK module. The section "Two wireless nodes meshed over an Ethernet connection" needs to be tested with Commotion Router 1.0 and updated if needed. https://commotionwireless.net/docs/cck/installing-configuring/common-configurations

improve CSS on blogindex.html for better readability

The blog index page could have better heading and link formatting to aide in readability.

Elements bridge pages in CCK PDFs

There are several points at which either key illustrations or lines of text bridge two pages.

Part 1

• pg 1 - Tool Bag header
• pg 5 - POE box illustration
• pg 7 - Mount illustration

Part 2

• pg 2 - sentence bridged onto two pages
• pg 3 - Working on roofs diagram
• pg 5 - sentence bridged

Part 3

• pg 1 - Illustration
• pg 2 - Materials layout could be better
• pg 3 - Chimney illustration
• pg 8 - text bridged

Part 4

• pg 2 - lists of equipment required could be formatted better
• pg 6 - Wireless Node Installation illustration bridged

format updates to imported blog content

Insert teaser break tags, replace comma separated categories with space separated, implement front matter ariable teaser image for teasers display.

Add bug report form

Add a bug report form that emails results.

Document Commotion Security Architecture

Document design decisions and security architecture options discussed during 2013 meetings with security researchers.

README files for Commotion-Router packages should point to parent

Because repos are not well organized in Github, Commotion-Router packages should indicate that they are children of Commotion-Router, and that users should start with that repo for build instructions. This should only be 1-2 lines of text.

@andygunn, @areynold

Broken link in CCK / Wireless Challenges

There is a broken link in Wireless Challenges.

The link is:
http://staging.commotionwireless.net/docs/cck/design-your-network-every-network-tells-story
and should be:
http://staging.commotionwireless.net/docs/cck/planning/design-your-network-every-network-tells-story

Created mesh key-chain use documentation for commotion-router menu's

@areynold @critzo
See:
https://wiki.commotionwireless.net/doku.php?id=general_resources:documentation:router:signed_routes

Follows up from #45

Developer Resources page should have more introduction text

Language on http://commotionwireless.net/developer/resources should change:

• Intro paragraph or language -- "If you are interested in helping develop the Commotion Wireless software, or want to create your own software images for specific routers or other devices, please read below"
• Change Platforms section language -- Embedded routers should be just "some routers" or "network routers". "Software development on each platform moves at a different pace, but we are working towards unifying the code across all of the platforms. If you are interested in developing software or creating custom images for any of the platforms, click through here:
  "

Wrote basic mesh over ethernet instructions

Instructions can be found here:

https://wiki.commotionwireless.net/doku.php?id=general_resources:documentation:router:mesh_over_ethernet

blog front page formatting

Blog landing page needs to be written, showing recent posts with teasers, a date index, a tag index, RSS and promo post (tagged release).

implement contextual menus for sub sections

Section menus are needed for the right sidebar in each of the content sections of the site. Use a plugin for the contextual menu.

refine default and front layouts and include files

Split the current layout for default and front into multiple include files, segmenting page regions and content areas for easier template updating.
The blog layout can be used as an example.

add piwik integration

Insert code from piwik into Jekyll template and enable.

Provide intro page content for main CCK category pages

The following pages need to automatically provide a list of the pages in their sub-section:

• docs/cck/planning
• docs/cck/installing-configuring
• docs/cck/building-mounting
• docs/cck/networking

Documentation for identifying and addressing Serval date mis-match

@areynold @critzo

Created user level documentation for testing and fixing problem https://github.com/opentechinstitute/olsrd-mdp/issues/1 using only the menu at
https://wiki.commotionwireless.net/doku.php?id=general_resources:documentation:router:signed_routes#troubleshooting

Sort right sidebar tags by # of posts per category

_includes/site-tag-could.html provides all post categories with the number of posts per category, linking to the appropriate place in blogindex.html. However, it would be better to have the categories ordered by # of posts in the category, and then alphabetically. Alternately, order the categories alphabetically regardless of number of posts.

Graphic assets document link is wrong in CCK / Construction Elements

In Construction Elements, the link to the graphics PDF is the wrong
document, it is just a PDF of the module, not the set of graphics.

The link is: http://staging.commotionwireless.net/files/cck/planning/7-Design_your_Network_Construction_Elements.pdf
and should be this document:
http://commotionwireless.net/sites/commotionwireles.net/files/construction_elements_CCK_0.pdf

FAQ Review

The Commotion team typically takes questions from our support queue and mines them for new FAQ items and updates to existing ones.

What additional FAQ questions should be included on our website?
What categories of questions would you suggest?

Add in redirect pages for blogs.

The Drupal site used different blog URL logic than we do on the site. We should use jekyll redirect pages to make sure that old links to our blog posts still work.

Add wireless gateway configuration instructions

review and update CSS for small screen layouts.

The current theme is pretty responsive, but should be reviewed for completeness. Additional CSS could add a lot to the formatting for small screens.

CCK: what additional modules?

What additional documentation would be useful for the Commotion Construction Kit or for the Commotion website in general?

Submit your ideas as comments here.

Review website layout, design, menu structure, usability; make recommendations

Do you have comments about https://commotionwireless.net ? Please submit your thoughts on usability, design, layout, and menu/placement, page naming, etc. as comments here.

Provide right menu for Downloads on download/verify-signatures

Use two-third / one-third layout for download/verify-signatures and include sub-sections-menu.html in the right one-third column.

Check page content for properly closed tags on developer/hig/key-concepts

There appears to be an tag that is improperly closed on this page.

Link to Commotion-Router Build Instructions

The Developer Resources and Download Commotion Router pages should include instructions (or links to instructions) on downloading and building Commotion-Router from source.

This could be included as a page on the commotion site or simply a link to the build instructions in Commotion-Router's README on github.

Tasks

• Link to Commotion-Router Build & Install from router download page
• Update Developer Resources language per andygunn's comment below.
• Add Commotion-Router developer's guide per andygunn's comment below, and link from developer resources page.
• Include Commotion-Router Build & Install instructions in developer's guide

@andygunn, @areynold

Order tags alphabetically on posts by tag section of blogindex.html

On the blog index page, sort categories alphabetically.

Clarify Build Requirements for Commotion-Router

Commotion-Router's build instructions should indicate any prerequisites. This can likely be pulled or linked from OpenWRT's Easy Build page

@andygunn, @areynold

review and update general print stylesheet.

The print stylesheet needs to be reviewed and updated.

create cck download includes for the right sidebar on cck pages

Current cck pages provide a download PDF button and a download all cck button in the right sidebar. Create an include file that can be placed dynamically based on a front matter variable. Link content of the PDF button should also be dynamic per page using a front matter variable.

layout and print stylesheet for cck pages

The print formatting for cck pages should be developed to provide as close to standard print formatting as possible, using current cck print versions and input from field team staff as a guide.

Commotion Construction Kit (CCK): review modules for utility, accuracy

Please review CCK modules for usability, utility, accuracy, etc.
Provide your feedback here as comments.

CCK modules are available in HTML or PDF here:
https://commotionwireless.net/docs/cck

standardize cck page titles

Some cck page titles have "Commotion Construction Kit" preceding the actual page title and some do not. Choose to include the section title or not and standardize the cck title front matter for each page.

In CCK / Building and Mounting links highlight instead of linking

Some links in the Building and Mounting modules merely highlight, instead of providing links. I'm not sure if this is a CSS thing, or if the link didn't transfer through. As an example, go to the Prep and Install Rooftop Nodes document, then:
Related Information -> Modules:
http://staging.commotionwireless.net/docs/cck/building-mounting/prep-install-rooftop-nodes/

Broken link in CCK / Configure Commotion

In Configure Commotion there is a broken link.

The link is:
http://staging.commotionwireless.net/docs/cck/install-ubiquiti-router
and should be:
http://staging.commotionwireless.net/docs/cck/installing-configuring/install-ubiquiti-router/

Add pagination to main blog page

Add pagination support and next/previous links on blog/index.html

https cannot be used to request internet access

The commotion splash screen only captures traffic on port 80 (http), since any attempt to redirect https traffic would throw an SSL certificate error warning (correctly) of a man in the middle attack.

Since the splash screen is used to grant internet access to AP clients, a user requesting a secure webpage (e.g., https://google.com) will not be able to connect to the internet and may not receive any indication that they need to visit a non-SSL webpage first.

Some OS level tools attempt to work around this problem, which is common to all captive portals, but there is no real technical fix. This should be documented in the startup materials.

Document Commotion-Router target selection

Target selection (e.g., TP-Link) is implied in Commotion-Router's build instructions, but should be made explicit. Full menuconfig documentation is out of scope, but users should understand how to build alternate images using Commotion defaults.

Instructions should also indicate how to choose a specific commotion release (e.g., 1.0) instead of master branch

@andygunn, @areynold

CCK / Common configurations page missing

The Common Configurations page appears to be missing.