search

alphagov / specialist-publisher

Publishes specialist documents on GOV.UK
https://docs.publishing.service.gov.uk/apps/specialist-publisher.html
MIT License
10 stars 7 forks source link

[CLOSED] Add logo to finder metadata #474

Closed benilovj closed 8 years ago

benilovj commented 8 years ago

Issue by jackscotti Thursday 23 April 2015 at 09:56 GMT Originally opened as https://github.com/alphagov/specialist-publisher/pull/474

European Structural and Investment funds finder must comply with EU legislations and they therefore needs to display the EU logo.

This pull request adds the possibility to specify a logo_path in the finders' metadata.

Quote from the legislation: "the Union emblem and the reference to the Union shall be visible, when landing on the website, inside the viewing area of a digital device, without requiring a user to scroll down the page".

ticket: https://www.pivotaltracker.com/story/show/92225774 linked to: https://github.com/alphagov/finder-frontend/pull/189 https://github.com/alphagov/govuk-content-schemas/pull/49

jackscotti included the following code: https://github.com/alphagov/specialist-publisher/pull/474/commits

benilovj commented 8 years ago

Comment by tommyp Thursday 23 April 2015 at 09:58 GMT

The tests are failing because you need to update the schema in https://github.com/alphagov/govuk-content-schemas. Give me a shout if you want a hand with it.

benilovj commented 8 years ago

Comment by jackscotti Thursday 23 April 2015 at 10:13 GMT

Yep, sorry I forgot to add the 'discuss' tag.

I wanted to get a confirmation on whether this approach to the problem is correct. Can/should I add the image name using another property instead adding a new one (logo)?

benilovj commented 8 years ago

Comment by tommyp Thursday 23 April 2015 at 10:20 GMT

Adding a new one seems like the most sensible option since none of the other existing bits in the content item have the same semantic meaning or fulfil even a vaguely similar function.

benilovj commented 8 years ago

Comment by edds Thursday 23 April 2015 at 12:04 GMT

I worry that we are referencing an asset in another repository. I would prefer the publisher to just state if it should if this document is part of the EU structural investment fund, then the frontend application can toggle a logo or other description on or off based on that setting. This would allow us to iterate the fontend application without having to update the publisher. It would also give us confidence in removing the asset in future without having to check all the entries in the content store.

Hope that makes sense.

benilovj commented 8 years ago

Comment by tommyp Thursday 23 April 2015 at 12:13 GMT

Had a chat with @edds IRL and I agree with him that the best (and simplest) thing to do is to just add this image into the Finder Frontend repo and display the image if the base_path matches. Also, will this need to be displayed in Specialist Frontend for the associated documents?

benilovj commented 8 years ago

Comment by jackscotti Thursday 23 April 2015 at 13:01 GMT

Okay, thank you for the good feedback!

Anyway, just had a chat with @evilstreak and after going through the EU guidance we decided that the logo is going to be a component and not anymore an image made of the logo and some text.
The logo will be made of:

Therefore, logo in this PR won't be referring anymore to an asset in Finder Frontend but it will instead be the string that will be rendered in the text part of the component.

benilovj commented 8 years ago

Comment by jackscotti Thursday 23 April 2015 at 14:52 GMT

@tommyp @edds, had another chat with @evilstreak, PMs, DM and Mark (Designer) and we decided to not proceed with making it a component because images won't follow a pattern.

The image will be uploaded through our asset manager and logo will indeed specify the path to the asset.