djaodjin / djaopsp

Practices Survey Platform - Assess against best practices assessment and improvement planning

DjaoDjin Practices Survey Platform

This repository contains the code for DjaoDjin practices sharing platform. To learn more visit DjaoDjin's Website.

The practices sharing platform is built on Django, Vue.js, Bootstrap frameworks and many more Open Source projects. Thank you for the support!

If you are looking to add features, this project integrates

• djaodjin-pages for content management
• djaodjin-survey for assessments

Tested with

• Python: 3.10, Django: 3.2 (LTS)

Install

First you will need to create a workspace environment, download the 3rd party vendor prerequisite packages and build the static assets.

    $ python -m venv installTop
    $ source installTop/bin/activate
    $ pip install -r requirements.txt
    $ make vendor-assets-prerequisites
    $ make install-conf
    $ make build-assets

At this point, all the 3rd party vendor prerequisite packages (Python and Javascript) have been downloaded and installed in the environment.

Then create the database, and start the built-in webserver

$ python manage.py migrate --run-syncdb
$ python manage.py createsuperuser
$ python manage.py runserver

Development

You will want to toggle DEBUG on in the site.conf file.

    $ diff -u installTop/etc/djaopsp/site.conf
    -DEBUG = False
    +DEBUG = True

    # Create the tests databases and load test datasets.
    $ make initdb

    # To generate some sample data run:
    $ python manage.py generate_test_data

    # Spins up a dev server that re-compiles the `.css` files
    # on page reload whenever necessary.
    $ python manage.py runserver --nostatic

The app will be accessible at http://localhost:8000/djaopsp

Release Notes

See release notes

djaopsp's Issues

Profile pages: change title of button from submit to update

Clicking an org from My Organizations takes you to scorecard, or to multiple scorecards

dashboard: click through on a organization name leads to an error.

Investigate what kind of errors.

Changing value in cell leads to a different cell being updated

Might be a cascading-effect of #2.

welcome screen layout

1. left justify the text, or
2. remove the bullet points from the centered version.

duplicate access requests

When a request is sent multiple times it shows as many times on the dashboard.

clicking more than 3 times in a cell freezes edition

The logic to toggle edition on/off for RangeEditor is incorrect.

The current workaround is to refresh the page.

Be able to edit content sponsors list.

missing "edit" class on ul element in sponsors page.

switching to default org name when clicking to platform pages

generic_navbar.html uses logic specific to envconnect that leads to inconsistencies in menubar.

Resize the font in benchmark graphs to fit titles

Special characters are automatically transformed when they shouldn't.

ex: titles with “&” shows up as “&amp”.

No spelling autocorrect on registration fields

Be able to duplicate best practice heading, plus its content

There are multiple headings that duplicate between industry segments, and sometimes even icons, so being able to select from already-created best practices would be a big time saver.

signup: defaults to blank when switching between countries

Add ability to add sub-bullets to text editing

I find it is needed in 1 out of every 3 best practices I develop.

3. Change “Share with client” to “Share scorecard”

more accurate, because sharing may happen beyond clients

Best practice duplication -universal updating

For best practice duplication, one should be able to edit one best practice and elect to update all instances of that best practice in TSP. (Apologies for not realizing this earlier).

Make "value summary" default view for best practices. + shrink columns

Shrink font to help shrink the columns

Revisit value summary "Average value" logic

Needs sense check. For example, currently 2 medium green cell values and 2 dark green cell values result in an average value of dark green.

Icons shouldn't wrap; have scroll bar instead

Be able to pin a heading for use in a scorecard

Green values: Add a 5th level that is "gold".

Label on the legend: "Global".
Assign a numeric value of 6.

Errors adding best practices under the basic section

• Click the top most "Add best practice..." link inserts the best practice correctly.
• Click an "Add best practice..." link next to a header inserts the best practice at the bottom instead of under the header.
• Click the top most "Add best practice..." link, then click an "Add best practice..." link next to a header leads to an exception "TypeError: Cannot read property '1' of null".

There does not seem to be any issues inserting best practices under the sustainability section.

Promote/demote of best practices

Under certain, yet undefined circumstances, if you try to move a best practice one up in a list, it
doesn't change the order of the list as it would be expected.
Current workaround is to move the best practice and drop it on the header to make it first in the list, then do the same to move other best practices above it.

(Ref #4)

Benchmark graphs: Not duplicating logical sequence from scorecard

graphs appear out of order e.g. electric procurement graphs should be grouped, etc

add popup documentation for click on bar graphs

text: "Click on a bar to view details".

Add one more (darker) shade of green to be value assignments

To indicate outstanding actors/ excellence. I have a number of questions like the one below, where it would make sense to have an "outstanding" category.

What percentage of the fleet has been replaced/updated/modified with lower carbon technology:
-- 0 to 10% (would currently get neutral value assignment)
-- 10 to 25% (could get light green)
-- 25 to 50% (medium green)
-- 50 to 75% (dark green)
-- 75 to 100% (new, highest value category to signify excellence. Either make it darker green, or yellow/gold)

Scores for organization with indirect access are visible

Access to scores is based on Organization, not User to make it simpler for everyone in an organization to see the same charts. This might need to be documented or changed.

Entering title of best practice longer than 150 characters

When that happens, a 500 error is thrown.

Customize text sent when a manager is added

Text:

"You are receiving this email, because you have been added by [insert Profile Manager who did the adding] as a Profile Manager on The Sustainability Project website for your organiza;on’s profile. You can access the account for your organiza;on by clicking on the previous link, or by cuRng and pas;ng the following link into your browser: _[insert link].
As a Profile Manager you able to add to view all informa;on relevant to your organiza;on on The Sustainability Project, and to update the “Self-assessment” and “Improvement planning” tools for your organiza;on. You are also able to invite other par;es to be Profile Managers, Contributors or Viewers of the informa;on in this profile. Contributors are able to help complete the Self Assessment and
Improvement Planning informa;on. Viewers are able to review the organiza;on’s scorecard."

Add ability to tab between cells

Update scoring

Values assigned to each best practice to indicate relative env. & financial value

color	points
Dark green	3
Medium green	2
Light green	1

Values assigned to responses to the question "Is this practice implemented".

answer	points
Yes	3
Yes, but needs a little improvement	2
Yes, but needs a lot of improvement	1
No or good as no	0

Resulting score is the multiplication of the color and answer points.

Be able to duplicate best practice detail content

add documentation for behavior of "request access"

Users get baffled when they enter the name of another user instead of an organization.

Change number and content of self-assessment columns

Self assessment columns should be:

• Yes
• Yes, but needs a little improvement
• Yes, but needs a lot of improvement
• No
• Not applicable

Value summary column headings: change to icons with pop ups.

Put current text headings in pop up definitions when one puts cursor on the icon.
This will allow the column width to be shrunk.

Be able to disable a best practice row from the self-assessment

I am occassionally using a best practice row to create a sub-heading within our blue heading sections. To reduce instances of non-complete self-assessments (and therefore no scorecard display), it would be valuable to be able to disable the self-assessment response options for these rows.

Registration: The fields on the Sign Up page and the Profile details page should match.

"Full name" to "Organization name"
Locality should be City/Town
Region should be "State/province/county
Include 'Postal code'.

Add self-assessment response options to columns and heading rows

Those completing the self-assessment may have to select the Not Applicable option for all best practices in an entire best practice list e.g. Energy utility > Electric procurement > Transmission > Materials, or for a section within a list. Being able to select Not Applicable at for an entire list of best practices, or a section therein will significantly facilitate ease of completing the self-assessment for those to whome this will apply.

Some best practice pages are not associated with an icon graphic

If one moves a practice, it becomes a heading

TODO: Detail exactly under which conditions it happens (first/last section, moving up/down, across section, etc.)

“Implemented” should read “Standard practice for applicable activities/projects”.

Edit title of icon does not change the title

Somehow after clicking save, the title of an icon still shows the old value.

Left justify all lines of a best practice row to same margin

For best practices that wrap onto two or three lines, they should align to the same left margin. At present (in the value summary view), the top line is indented.

signup: move question mark and make it clickable

using mouse over is not intuitive enough for many people.

Performance optimization: time to present graphs and scorecard

residual rangeUpdate when clicking on toggle

As part as testing fix for #3, I found the following:

1. Click on a green-shade cell once
2. Click on the "Profitability" toggle.

The left over of the rangeUpdate controller remains drawn on the screen.

Clicking ‘Complete’ must take one back to the best practice list

Improvement dashboard: show updated score as percentage and line

Be able to override and select different shade of green in "Average Value" column