Skip to content

Commit

Permalink
Clean up readme and changelog, add a bunch of things. Encourage peopl…
Browse files Browse the repository at this point in the history
…e to say hi.
  • Loading branch information
benlk committed Nov 10, 2018
1 parent 68e8b84 commit 2951cf8
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 28 deletions.
30 changes: 23 additions & 7 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,44 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
though this project doesn't succeed in adhering to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased](https://github.com/INN/largo/compare/0.5...0.5-dev)
## [Largo 0.6](https://github.com/INN/largo/compare/v0.5.5.4...v0.6)

Special thanks to our community contributors:
- Mike Schinkel for his work on [pull request #1469](https://github.com/INN/largo/pull/1469) at WordCamp for Publishers 2017's Contributor Day
- GitHub user [fenriz07](https://github.com/fenriz07) for their work in [PR #1541](https://github.com/INN/largo/pull/1541) on updating links in our documentation

Thanks to Mike Schinkel for his work on [pull request 1469](https://github.com/INN/largo/pull/1469) at WordCamp for Publishers 2017's Contributor Day.

### New Features
- Adds Gutenberg support, with
- editor styles
- support for the `.alignwide` and `.alignfull` CSS classes and their use in blocks
- pullquote styles

## Changes
- Fixes numerous undefined variable errors, as part of [issue 1492](https://github.com/INN/largo/issues/1492).
### Changes
- Fixes numerous undefined variable errors, as part of [issue #1492](https://github.com/INN/largo/issues/1492).
- Users who have the capability to edit a given post will see the edit link on the frontend, where before users with the capability to edit published posts in general saw the link to edit the post in the frontend. [PR #1559](https://github.com/INN/largo/pull/1559) for [issue #1543](https://github.com/INN/largo/issues/1543).
- Largo now uses WordPress' `title-tag` support for `<title>` tag output, which means that site title tags shoud now be modifiable by plugins. [PR #1566](https://github.com/INN/largo/pull/1566) for [issue 1470](https://github.com/INN/largo/issues/1470).
- Largo now uses WordPress' `title-tag` support for `<title>` tag output, which means that site title tags shoud now be modifiable by plugins. [PR #1566](https://github.com/INN/largo/pull/1566) for [issue #1470](https://github.com/INN/largo/issues/1470).
- If the [Yoast SEO plugin](https://wordpress.org/plugins/wordpress-seo/) is active, Largo's default [Open Graph Protocol](http://ogp.me/) and [Twitter Cards](https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/abouts-cards) tags will not be output. [PR #1567](https://github.com/INN/largo/pull/1567) for issues [#1437](https://github.com/INN/largo/issues/1437) and [#1470](https://github.com/INN/largo/issues/1470)
- Adds support for WordPress' `.screen-reader-text` CSS class. [PR #1530](https://github.com/INN/largo/pull/1530) for [issue #1528](https://github.com/INN/largo/issues/1528) as part of [issue #844](https://github.com/INN/largo/issues/844).
- Updates `.visuallyhidden` CSS styles in accordance with [the latest recommended technique](https://make.wordpress.org/accessibility/2015/02/09/hiding-text-for-screen-readers-with-wordpress-core/). [PR #1530](https://github.com/INN/largo/pull/1530) for [issue #1528](https://github.com/INN/largo/issues/1528) as part of [issue #844](https://github.com/INN/largo/issues/844).
- Thins the homepage stylesheets with LESS `(reference)` imports. [PR #1530](https://github.com/INN/largo/pull/1530) for [issue #1528](https://github.com/INN/largo/issues/1528) as part of [issue #844](https://github.com/INN/largo/issues/844).
- Adds a text domain to `style.css`. [PR #1527](https://github.com/INN/largo/pull/1527) as part of [issue #844](https://github.com/INN/largo/issues/844).
- Fixes a "WP_Admin_Bar::add_node was called incorrectly" warning message. [PR #1504](https://github.com/INN/largo/pull/1504) for [issue #1349](https://github.com/INN/largo/issues/1349).
- Modernizes Travis CI configuration to cover PHP 5.6, 7.0 and 7.1, and WordPress 4.6 through 5.0. Drops support for PHP 5.5 and earlier and WordPress 4.5 and earlier. [PR #1503](https://github.com/INN/largo/pull/1503) and [#1554](https://github.com/INN/largo/pull/1554).
- Where `largo_remove_hero()` removed duplicate hero images from the top of `the_content()`, the funciton no longer outputs empty paragraph tags, and now works on `img` tags without `src=""` attributes. [PR #1503](https://github.com/INN/largo/pull/1503/files#diff-751911f6a0ebcc05da47094668329397) for [issue #1404](https://github.com/INN/largo/issues/1404).
- Alphabetizes the contributor list in `readme.md`.

### Removed
- Deprecates `largo_fb_user_is_followable()`, [because Facebook changed their API](https://github.com/INN/largo/pull/1503#issuecomment-407869218).
- Removes the default inclusion of Google Analytics with INN's Largo Project IDs. [PR #1502](https://github.com/INN/largo/pull/1502) as part of [issue #1495](https://github.com/INN/largo/issues/1495), and by request.
- Removes the INN Member RSS widget, because the RSS feed it draws from is no longer supported or maintained by INN. Because the RSS feed was occasionally empty, the widget would result in 500 errors. [RP #1535](https://github.com/INN/largo/pulls/1535) for [issue #1511](https://github.com/INN/largo/issues/1511) and [#893](https://github.com/INN/largo/issues/893).
- Removes lingering traces of the Largo Featured Widget. [PR #1563](https://github.com/INN/largo/pull/1563) and [#1469](https://github.com/INN/largo/pull/1469) for [issue 1467](https://github.com/INN/largo/issues/1467), from Github user [mikeschinkel](https://github.com/mikeschinkel).
- Removes lingering traces of the Largo Featured Widget. [PR #1563](https://github.com/INN/largo/pull/1563) and [#1469](https://github.com/INN/largo/pull/1469) for [issue #1467](https://github.com/INN/largo/issues/1467), from Github user [mikeschinkel](https://github.com/mikeschinkel).
- Removes many uses of `extract()` in widgets and theme functions, and improves code quality in widgets.
- Removes the `<title>` element from `header.php`, since Largo declares `title-tag` theme support. [PR #1566](https://github.com/INN/largo/pull/1566) for [issue 1470](https://github.com/INN/largo/issues/1470).
- Removes uses of `screen_icon()` and `get_screen_icon()`, deprecated in WordPress 4.8. [PR #1523](https://github.com/INN/largo/pull/1531) for [issue #1523](https://github.com/INN/largo/issues/1523) as part of [issue #844](https://github.com/INN/largo/issues/844).
- Removes the `<title>` element from `header.php`, since Largo declares `title-tag` theme support. [PR #1566](https://github.com/INN/largo/pull/1566) for [issue #1470](https://github.com/INN/largo/issues/1470).
- Removes two remaining PHP short tags. [PR #1525](https://github.com/INN/largo/pull/1525) for [issue #844](https://github.com/INN/largo/issues/844).
- Removes some deprecated `style.css` metadata tags. [PR #1524](https://github.com/INN/largo/pull/1524) for [issue #844](https://github.com/INN/largo/issues/844).
- Removes Hipchat support from `.travis.yml`. [PR #1503](https://github.com/INN/largo/pull/1503).

### Upgrade notices
- If your child theme has significant custom styling, or has custom post templates, your theme may need to provide additional styles to ensure Gutenberg compatibility.
Expand Down
64 changes: 43 additions & 21 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,6 @@

A responsive WordPress framework designed for news publishers and developed by the Institute for Nonprofit News.

<img src="https://travis-ci.org/INN/Largo.svg?branch=develop" /> <img src="https://readthedocs.org/projects/largo/badge/?version=master" />

---

**IMPORTANT!** THIS PROJECT IS UNDER ACTIVE DEVELOPMENT

We are making regular updates that may or may not always play nice with previous versions.

For released versions of Largo, please see the [list of tagged releases](https://github.com/INN/Largo/releases).

The `0.5` branch is what INN is using for our sites in production. Please do not submit pull requests to this branch unless they are minor hotfixes that can be directly merged.

The `0.5-dev` branch is contains work in progress slated for our next point release. Feel free to try it out, report issues, etc. but we DO NOT recommend using it in production. This is also typically the branch to submit pull requests to if you want to contribute to the project.

The `master`, `develop`, and `1.0` branches contain work in progress slated for an eventual rewrite of Largo.

Feedback, comments and questions to: [[email protected]](mailto:[email protected])

---

## About Largo

<img align="right" src="/img/largo-login-logo.png" />
Expand All @@ -42,6 +22,8 @@ The project extends work done by [NPR's Project Argo](http://argoproject.org/).

**Minimum supported WordPress version:** We recommend using [the current version of WordPress](https://wordpress.org/download/releases/). To see what versions of WordPress automated tests are run against, check out [the Travis CI configuration file](./.travis.yml).

If you're using Largo on your site, say hi! Send us an email at [[email protected]](mailto:[email protected]) or [through the contact form](https://labs.inn.org/contact/), sign up for a slot in [our weekly open office hours](https://docs.google.com/spreadsheets/d/1p-twn2D8oow7vXBfkcdYcZnVA4z8Q42OMs77KlHwf-g/edit#gid=0), or just say hi to [our staff](https://labs.inn.org/nerds/) at a conference. We'd love to include you on our [list of sites using Largo](https://github.com/INN/largo/wiki/Sites-Using-Largo).

## Setup

Follow the [setup instructions in the documentation](http://largo.readthedocs.io/users/download.html).
Expand All @@ -54,6 +36,18 @@ If you're not sure where to start, [review the open issues on github](https://gi

If you're still not sure where to start, that's totally fine! [Just shoot us an email](mailto:[email protected]) and we'll do our best to help.

We are making regular updates that may or may not always play nice with previous versions.

For released versions of Largo, please see the [list of tagged releases](https://github.com/INN/Largo/releases).

The `0.5` branch is what INN is using for our sites in production. Please do not submit pull requests to this branch unless they are minor hotfixes that can be directly merged.

The `0.5-dev` branch is contains work in progress slated for our next point release. Feel free to try it out, report issues, etc. but we DO NOT recommend using it in production. This is also typically the branch to submit pull requests to if you want to contribute to the project.

The `master`, `develop`, and `1.0` branches contain work in progress slated for an eventual rewrite of Largo.

Feedback, comments and questions to: [[email protected]](mailto:[email protected])

## Credits

Built and maintained by the [Institute for Nonprofit News](http://inn.org) product and technology team ([@INNNerds](http://twitter.com/INNNerds)):
Expand All @@ -63,7 +57,35 @@ Built and maintained by the [Institute for Nonprofit News](http://inn.org) produ
- **[Tyler Machado](https://github.com/tylermachado)** ([@tylermachado](https://twitter.com/tylermachado)), Front-End Developer
- **Paola Baradello**, Account Director

Special thanks to everyone who has contributed to the project, including: [rnagle](https://github.com/rnagle), [kaeti](https://github.com/kaeti), [jackbrighton](http://github.com/jackbrighton), [danielbachhuber](http://github.com/danielbachhuber), [willhaynes](http://github.com/willhaynes), [drywall](http://github.com/drywall), [nacin](http://github.com/nacin), [meredithinn](http://github.com/meredithinn), [tothebeat](http://github.com/tothebeat), [lindamood](http://github.com/lindamood), [mospaw](http://github.com/mospaw), [DrewAPicture](http://github.com/drewapicture), [nipoez](http://github.com/nipoez), [palewire](http://github.com/palewire), [GaryJones](http://github.com/garyjones), [seamusleahy](http://github.com/seamusleahy), [joshuarrrr](http://github.com/joshuarrrr), [yayannabelle](https://github.com/yayannabelle), [jmusal](https://github.com/jmusal), [ntwb](https://github.com/ntwb), [MsPseudolus](https://github.com/MsPseudolus), [@gabehong](https://github.com/gabehong), [@julia67](https://github.com/julia67), [@rclations](https://github.com/rclations), [@aschweigert](https://github.com/aschweigert) and the whole news nerd and WordPress communities.
Special thanks to everyone who has contributed to the project, including the following alphabetical list of people:
- [@aschweigert](https://github.com/aschweigert)
- [@gabehong](https://github.com/gabehong)
- [@julia67](https://github.com/julia67)
- [@rclations](https://github.com/rclations)
- [DrewAPicture](http://github.com/drewapicture)
- [GaryJones](http://github.com/garyjones)
- [MsPseudolus](https://github.com/MsPseudolus)
- [danielbachhuber](http://github.com/danielbachhuber)
- [drywall](http://github.com/drywall)
- [fenriz07](http://github.com/fenriz07)
- [jackbrighton](http://github.com/jackbrighton)
- [jmusal](https://github.com/jmusal)
- [joshuarrrr](http://github.com/joshuarrrr)
- [kaeti](https://github.com/kaeti)
- [lindamood](http://github.com/lindamood)
- [meredithinn](http://github.com/meredithinn)
- [mikeschinkel](https://github.com/mikeschinkel)
- [mospaw](http://github.com/mospaw)
- [nacin](http://github.com/nacin)
- [nipoez](http://github.com/nipoez)
- [ntwb](https://github.com/ntwb)
- [palewire](http://github.com/palewire)
- [rnagle](https://github.com/rnagle)
- [seamusleahy](http://github.com/seamusleahy)
- [tothebeat](http://github.com/tothebeat)
- [willhaynes](http://github.com/willhaynes)
- [yayannabelle](https://github.com/yayannabelle)
- and the whole news nerd and WordPress communities.

This project builds on a number of great open source projects, including:

Expand Down

0 comments on commit 2951cf8

Please sign in to comment.