Table of contents

Update content for the business readiness finder

The business readiness finder relies on metadata tags in search-api to filter content.

Updating content

Content is curated and added to a spreadsheet by the content team. Developer help is needed to upload the content. We do this by converting the spreadsheet into a CSV, including it in govuk-app-deployment-secrets and then releasing search-api.

The process of converting the spreadsheet into a CSV involves removing a header row and converting windows encoded line breaks if present. There is a script to do this.

  1. Make sure the “List of documents with facets” tab is selected and download the spreadsheet as csv:

    download

  2. cd govuk-app-deployment-secrets

  3. bin/prep_csv ~/Downloads/your-downloaded-file.csv

  4. Create a pull request and get it reviewed & merged.

  5. Re-deploy search-api and email-alert-api via Jenkins and the Release app.

  6. Run the tag_metadata rake task in search-api to index the contents of the new CSV, it should take 2 to 3 minutes:

    rake_task

  7. Check the results on e.g. https://www-origin.integration.publishing.service.gov.uk/find-eu-exit-guidance-business

These requests often come in through Zendesk and for pages that have only been created that same day, so you may only be able to check this in production.

Removing content from the business readiness finder

If your commit includes some items being removed from the content spreadsheet then you should take a note of the base_paths for these items and once you have run the tag_metadata rake task in the above instructions, you should also run destroy_metadata_for_base_paths (e.g. on staging), passing in the base_paths that need removing.

There are also other useful rake tasks. Remember to redeploy apps and re-run the tag_metadata task as above.

Pinning content to sections in the business readiness finder

Requests from Zendesk can specify that content is pinned within the finder. Pinning an item means that it appears at the top of whatever business finder facet(s) it is tagged to. The process for adding a pinned item:

  1. Using the base path of the content item to be pinned, get the content_id. You can use the govuk-toolkit browser extension, or via the publishing-api:

    Edition.includes(:document).where(base_path: paths).pluck(:content_id).uniq
    
  2. Add the content id to the list of ordered related items for the business finder, within govuk-app-deployment-secrets. Despite the name, the order of the ordered_related_items does not matter.

  3. Create a pull request and get it reviewed & merged.

  4. Re-deploy search-api via Jenkins and the Release app.

  5. Update the finder content by running the tag_metadata rake task in search-api to index the contents of the new CSV, it should take 2 to 3 minutes.

  6. Republish the finder so that the finder content item is updated.

  7. Check the results on e.g. https://www-origin.integration.publishing.service.gov.uk/find-eu-exit-guidance-business

Pinned items rely on the finder-frontend content item which has a cache time of 5 mins and is independent of cachebusting.

Removing pinned content to sections in the business readiness finder

The same process as above applies for removing a pinned item: get the content item and remove it from the list within the ordered-related items.

This page was last reviewed on 10 April 2019. It needs to be reviewed again on 10 July 2019 by the page owner #govuk-platform-health .
This page was set to be reviewed before 10 July 2019 by the page owner #govuk-platform-health. This might mean the content is out of date.