mozilla / network-api

Development moved to https://github.com/mozilla/network

De-activation Notice

This codebase has been merged into the network repository.

network-api's Issues

[NEWS] Add serializers, urls and views

Expose the News model via the API

[ADMIN] Add sort order for resources

Details

Allow administrators to set up an ordering scheme for resources. For e.g. they should be able to control the order in which people are shown in the front-end.

Implementation

This one is a bit convoluted to solve (it's a general problem with ORMs). We probably want to create an integer field in the model and use this library to handle the ordering logic for the admin view. We can customize the UI if needed.

[AUTH] Admin Authentication

Add non-django authentication to the admin interface.

[PEOPLE] Create application

Create the people app

Create migration plan for network-api

two options here:

• network-api becomes Mezzanine
• django network-api and Mezzanine in some kind of coexistence with synergetic data sharing

[PAGES] Determine structure/constraints for a page

Details

Elicit the schema that authors of pages need to follow in order to create a new page specific to a resource (like Offerings).

Enforce a specific language that needs to be followed as well, i.e. Markdown/HTML, etc., along with any restrictions we want to impose on it.

[AUTH] Add social auth and configuration

• Add social-auth-app-django as a dependency
• Add configuration to settings.py specific to whatever provider we're going with
• Add migrations

Dig into mezzanine

• how we build templates
• how we migrate django apps

Add "featured" flag on people

Admins should be able to mark people as "Featured".

If it's at all possible, can this state show up on the "reorder" card view?

Ensure deploys happen on user input for content for: People, News, Features

On a post-save hook in Mezzanine, trigger Jenkins to build and deploy a fresh site based on the cached (last committed) code and the new REST data.

[NEWS] Create scaffolding

Create application and add to INSTALLED_APPS

Bio shouldn't be required field in People module

Bio is only displayed on Featured cards, so this field should work just like the "Quote" field—where it only appears if the Featured box is selected.

Create Opportunity Model

Define staff workflow for adding content

Apologies if this has been discussed elsewhere.

We need to determine how staff members will trigger an update to the production site based on changes to the CMS. Ideally they have a way to preview their changes on a staging server, and they can update the site without engineer involvement.

[ADMIN] Add ability to control when a resource is public

Description

Authors using the administrative interface to publish new resources (pages, news, featured offerings, etc.) should be able to control when the resource is visible on the front-end by setting a publish_date similar to the corresponding functionality on Wordpress

Implementation

We can possibly just have that stored in the model and let the admins update it. We can customize the view to do checks based on the date and send back the response accordingly. Caveats include dealing with timezones. We might want to expose the local time (or give them a choice) in the admin interface (so that the admins use the time that is relative to them) and we convert it to UTC time for calculations. This will involve us storing timezone data as well in the db.

Create Opportunity App

refine the "eventual flow" diagram

There is a picture on my desktop, it needs to be a lucid chart.

Add publish date and expiry date to People and Opportunities

According to the the schema, we should also allow admins to enter the publish date and expiry date for our three models.

We probably don't need to expose these through the serializer. However, we should let the view filter out the right models to serve based on these dates.

[UPCOMING] Add model

Model schema found here: https://github.com/mozilla/network/tree/master/source/json

Update People Schema

[AUTH] Add authentication

Allow authentication via Github with permissions scoped using teams.

Create Django Scaffolding

Create the scaffolding for a new django project sans any apps.

[PEOPLE] Add data

Add data from existing json file into staging/production databases: https://github.com/mozilla/network/blob/master/source/json/people.json

Decide on Auth system

We're trying to decide on what auth strategy to use for the network-api and for our CMS work in general. It would be good to consolidate our Auth strategy across our CMS implementations.

Our current thought is to use Github authentication here.

Rationale for Using Github

• Allows us to manage permissions for existing staff using the Github Mozilla org's teams to assign who has access to what
• Allows us to easily add contributors and assign permissions based on the org teams

Network Pulse uses Google Auth instead. We would like to understand the rationale behind choosing that for the pulse api as well as understanding the pros/cons of using google auth vs. github auth vs. something else.

[PEOPLE] Add serializers/views/urls

Add serializers and views for GET one/all

Make "Affiliations" not a required field in People module

Not everyone is working with us in relation to their employer/organization, so would be good to be able to leave this blank in some cases.

[ADMIN] Add ability to upload images

Details

Allow administrators to upload images for resources that need an image in their models. For e.g., each People model needs a photo of the person. Admins should be able to upload this via the admin interface.

Implementation

Use S3 to back this. Use https://github.com/boto/boto3 to allow uploading to s3. Have an image_url to store the resulting url.

Validate user flow for creating a LandingPage for FeaturedOpportunities that includes an inline image

• Walk Kevin through this process, gather feedback
• Generate issues for training and follow-on heartbeat

Create staging/production instances

Add app.json and Procfile and create the staging/production instances on Heroku.

[PEOPLE] Figure out data structure for bio

Currently, the front-end displays bio as a list. This is a bit weird on the back-end as it suggests making "bio" a complex data structure, the implication being figuring out how to show this via the admin interface in a way that is not confusing.

Since this is the first "text-rich" field that we have encountered, let's have a decision on what type of data structure this should be.

Options

• Bullet points (like in the comps)
  • We will need to fix the number of bullet points in this case (we can't change this later on)
  • We need a max character length
• Markdown
  • This is more free form. We can probably show a preview of the rendered markdown in the admin view
  • Don't know what the repercussions are to design
  • We can set a max char count if it makes sense
  • Front-end would need to parse this markdown into markup

It would be nice to have a decision on this soon so that we can finish off the people app without being blocked on this.

cc @xmatthewx, @simonwex, @gvn, @alanmoo, @cadecairos

[UPCOMING] Create Scaffolding

Create application and add to INSTALLED_APPS

People need fields for twitter/linkedin profiles

Text field for username on twitter. URL for linkedin?

[AUTH] Add permission handling to admin views

Allow team based permissions for admin views via AuthZ.

Add dependencies and configuration

Add:

• Rest framework
• Static file server
• CORS
• Environ

[PAGES] Figure out how images can be incorporated into pages

Details

Wordpress allows you to drag-and-drop images into your posts and pages. We should allow something similar.

Implementation

We would need to figure out the UX for this but can probably keep it simple. Again, use S3 to back the images using Boto3. Generate the url and insert it into their page data somehow. This will mainly involve using some JS/HTML to get this working.

[PAGES] Allow administrators to create stand-alone pages

This epic tracks issues that allow administrators to create all the data needed to set up a stand-alone page representing a resource.

[NEWS] Add model

Model schema found here: https://github.com/mozilla/network/tree/master/source/json

Affiliations / Links UX on People module

The UX for both the Affiliations and Links fields aren't appropriate for the use case.

• The list shouldn't be populated by data from other records. People will never have the same affiliations or links as others.
• Items should be editable
• Items should be deleteable

[NEWS] App

Tracking META bug for the News application

Does Django not like svgs?

Tried to upload a couple org logos that were svgs and got this error: "Upload a valid image. The file you uploaded was either not an image or a corrupted image."

Formatting on bio field in People module

I can't see the bio field being displayed right now, so I can't confirm this, but I'm assuming the bullet points I'm adding (using markdown) aren't going to render.

I'm not sure if we'll solve this on the back end in Django, on the front end, or simply by requiring that the content in this field not include bullets.

partnership_logo should be nullable

Right now Django happily defaults to the fallback image url.

Add CI

Enable Travis. For now, we can simply run flake8 for linting until we add actual tests.

Reference: https://github.com/mozilla/api.mozillascience.org/blob/master/.travis.yml

Create Opportunity serializers/views/urls

[ADMIN] Add CMS administrative functions

This epic tracks all the administrative requirements for the CMS that are needed for it to be usable by staff.

This focuses on requirements for the Network site specifically.

Build MVP Network API

• Python/Django
• PosgreSQL 9.6
• Admin interface for changing structured data
• GitHub login (use org teams to determine if access is granted)

related: MozillaFoundation/foundation.mozilla.org#42

Add docker

Wrap the app in docker to avoid python/django OS-specific issues.

Opportunity App

Create the Opportunity app, models, views, serializers

[PEOPLE] Add model

Create model and migration

[UPCOMING] App

Create Upcoming events app