From 2b0a85640729b013e3d702988667c6f77d46d859 Mon Sep 17 00:00:00 2001 From: Nicholas Long Date: Tue, 14 Nov 2017 13:38:42 -0700 Subject: [PATCH 1/2] release notes --- CHANGELOG.md | 21 +++++++++++++++++++++ docs/release_instructions.md | 6 +++--- docs/scripts/change_log.rb | 4 ++-- package.json | 2 +- 4 files changed, 27 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 923254a79d..b6aeed9a33 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,24 @@ +# SEED Version 2.2.1 + +Closed Issues: 5 +- Fixed [#1486]( https://github.com/SEED-platform/seed/pull/1486 ), Upgrade to Django 1.11 +- Fixed [#1502]( https://github.com/SEED-platform/seed/pull/1502 ), Fix password reset +- Fixed [#1363]( https://github.com/SEED-platform/seed/issues/1363 ), DQ Check - Add export to Inventory DQ Results modal +- Fixed [#1397]( https://github.com/SEED-platform/seed/issues/1397 ), DQ Admin: add indication of field source (tax lot or property) +- Fixed [#1398]( https://github.com/SEED-platform/seed/issues/1398 ), DQ: Add labels for exported records +- Fixed [#1404]( https://github.com/SEED-platform/seed/issues/1404 ), Inventory Detail - Related Properties - need to display more fields +- Fixed [#1439]( https://github.com/SEED-platform/seed/issues/1439 ), Strftime fails for buildings older than 1900 +- Fixed [#1496]( https://github.com/SEED-platform/seed/pull/1496 ), Export data from inventory (including labels) +- Fixed [#1482]( https://github.com/SEED-platform/seed/pull/1482 ), Remove the concept of projects +- Fixed [#1483]( https://github.com/SEED-platform/seed/pull/1483 ), Added `Custom ID 1` field for Related Properties +- Fixed [#1484]( https://github.com/SEED-platform/seed/pull/1484 ), Added a mapping button to `Map SEED fields to imported file fields` +- Fixed [#1481]( https://github.com/SEED-platform/seed/pull/1481 ), Hides `*_pint` columns in Property List Settings view +- Fixed [#1487]( https://github.com/SEED-platform/seed/pull/1487 ), Improved Column Saving +- Fixed [#1490]( https://github.com/SEED-platform/seed/pull/1490 ), Export DQ from Inventory +- Fixed [#1493]( https://github.com/SEED-platform/seed/pull/1493 ), Removes node_modules from fine-uploader after building +- Fixed [#1473]( https://github.com/SEED-platform/seed/pull/1473 ), Improved Angular unit tests +- Fixed [#1479]( https://github.com/SEED-platform/seed/pull/1479 ), Disable all client-side caching when the dev profile is used + # SEED Version 2.2 Closed Issues: 25 diff --git a/docs/release_instructions.md b/docs/release_instructions.md index 1674145b49..acbbb487ff 100644 --- a/docs/release_instructions.md +++ b/docs/release_instructions.md @@ -5,13 +5,13 @@ To perform a release make sure to do the following. 1. Update the `package.json` file with the most recent version number. Always use MAJOR.MINOR.RELEASE. 1. Run the `docs/scripts/change_log.rb` script and add the changes to the CHANGELOG.md file for the range of time between last release and this release. - + ruby docs/scripts/change_log.rb --token GITHUB_API_TOKEN --start-date 2017-07-01 --end-date 2017-09-30 -1. Paste the results (except the Accepted Pull Requests) into the CHANGELOG.md. Make sure to cleanup the formatting. +1. Paste the results (remove unneeded Accepted Pull Requests) into the CHANGELOG.md. Make sure to cleanup the formatting. 1. Create new PR against develop with the updates. 1. Once develop passes, then create a new PR from develop to master. 1. Draft new Release from Github (https://github.com/SEED-platform/seed/releases). -1. Include list of changes since previous release. (From the console output with the ![Fixed:] text. +1. Include list of changes since previous release (i.e. the content in the CHANGELOG.md) 1. Verify that the Docker versions are built and pushed to Docker hub (https://hub.docker.com/r/seedplatform/seed/tags/). 1. Go to Read the Docs and enable the latest version to be active (https://readthedocs.org/dashboard/seed-platform/versions/) diff --git a/docs/scripts/change_log.rb b/docs/scripts/change_log.rb index fb0dbf2303..966bf92d58 100644 --- a/docs/scripts/change_log.rb +++ b/docs/scripts/change_log.rb @@ -77,9 +77,9 @@ def print_issue(issue) issue.labels.each { |label| is_feature = true if label.name == 'Feature Request' } if is_feature - "- ![Improved:][improved] [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}" + "- Improved [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}" else - "- ![Fixed:][fixed] [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}" + "- Fixed [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}" end end diff --git a/package.json b/package.json index f2e552e7ab..febf71a1c7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "SEED", - "version": "2.2.0", + "version": "2.2.1", "description": "Standard Energy Efficiency Data (SEED) Platform™", "license": "SEE LICENSE IN LICENSE", "directories": { From 0433998d66e40a48ddf2c34af86de851156c0b59 Mon Sep 17 00:00:00 2001 From: Nicholas Long Date: Wed, 15 Nov 2017 17:18:32 -0700 Subject: [PATCH 2/2] faq --- docs/source/faq.rst | 70 +++++++++++++++++++++++++++++++++++++++++++ docs/source/index.rst | 1 + 2 files changed, 71 insertions(+) create mode 100644 docs/source/faq.rst diff --git a/docs/source/faq.rst b/docs/source/faq.rst new file mode 100644 index 0000000000..a80b82732e --- /dev/null +++ b/docs/source/faq.rst @@ -0,0 +1,70 @@ +Frequently Asked Questions +########################## + +Here are some frequently asked questions and/or issues. + +.. contents:: + :local: + :depth: 2 + + + +Questions +========= +.. _whatisseed: + +What is the SEED Platform? +-------------------------- + +The Standard Energy Efficiency Data (SEED) Platform™ is a web-based application +that helps organizations easily manage data on the energy performance of large +groups of buildings. Users can combine data from multiple sources, clean and +validate it, and share the information with others. The software application +provides an easy, flexible, and cost-effective method to improve the quality +and availability of data to help demonstrate the economic and environmental +benefits of energy efficiency, to implement programs, and to target investment +activity. + +The SEED application is written in Python/Django, with AngularJS, Bootstrap, +and other JavaScript libraries used for the front-end. The back-end database +is required to be PostgreSQL. + +The SEED web application provides both a browser-based interface for users to +upload and manage their building data, as well as a full set of APIs that app +developers can use to access these same data management functions. + +Work on SEED Platform is managed by the National Renewable Energy Laboratory, +with funding from the U.S. Department of Energy. + + +Issues +====== + +.. _domain: + +Why is the domain set to example.com? +------------------------------------- + +If you see example.com in the emails that are sent from your hosted version of SEED then you will +need to update your django sites object in the database. + +.. code-block:: + + $ ./manage.py shell + + from django.contrib.sites.models import Site + one = Site.objects.all()[0] + one.domain = 'newdomain.org' + one.name = 'SEED' + one.save() + + +.. _staticfiles: + +Why aren't the static assets being served correctly? +---------------------------------------------------- + +Make sure that your local_untracked.py file does not have STATICFILES_STORAGE set to anything. If so, +then comment out that section and redeploy/recollect/compress your static assets. + + diff --git a/docs/source/index.rst b/docs/source/index.rst index 866a6c7f1f..2ef898ff20 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -39,6 +39,7 @@ with funding from the U.S. Department of Energy. developer_resources license help + faq Updating this documentation ^^^^^^^^^^^^^^^^^^^^^^^^^^^