Add doc for explaining Finder Content Item #155
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was piecemeal support for this before but no test coverage. In theory, requests for non-existent finders shouldn't be routed to this app, but they could be. Additionally, the nil-pointer error that happened instead was confusing in development.
…ms_gracefully Handle non existent content items gracefully
|
|
||
| A Finder Content Item is a specification of the [Content Item](https://github.com/alphagov/content-store/blob/master/doc/content_item_fields.md). This guide explains what goes in the details hash of the ContentItem and why. | ||
|
|
||
| The Finder Content Item is used by Finder Frontend to render the Finder page. Some of the details Most of what it uses goes in the `details` hash. |
There was a problem hiding this comment.
There are some spare words here. "Some of the details Most of what"
tommyp
force-pushed
the
content-item-docs
branch
from
ab5175f to
d8af6a7
Compare
|
|
||
| ## `beta` | ||
|
|
||
| A boolean. Required. |
There was a problem hiding this comment.
Why is this required? Can't we just default it to false?
There was a problem hiding this comment.
We could, but I thought I'd pass this on what currently is required and change it when I refactor the App.
tommyp
force-pushed
the
content-item-docs
branch
from
d8af6a7 to
1b3a2fa
Compare
|
|
||
| ## `beta_message` | ||
|
|
||
| A string. Required. |
There was a problem hiding this comment.
If beta is false is this still required? Even if beta is true, isn't there a default beta message that can be used if this isn't provided?
tommyp
force-pushed
the
content-item-docs
branch
from
1b3a2fa to
0f222b1
Compare
|
|
||
| A string. Required. | ||
|
|
||
| The lowercase singular version of whatever format the Finder is using. For example: [`/cma-cases`](https://www.gov.uk/cma-cases) has a `document_noun` of `case`, [`/aaib-report`](https://www.gov.uk/aaib-reports) has a `document_noun` of `report`. |
There was a problem hiding this comment.
It would be good to describe the ways this string is used. Is it only used for constructing the filter sentence?
tommyp
force-pushed
the
use-facets-for-metadata
branch
4 times, most recently
from
917d9ec to
4ca0b5e
Compare
tommyp
force-pushed
the
content-item-docs
branch
2 times, most recently
from
4fa1d50 to
f454945
Compare
First pass at a doc for what the Finder Content Item should contain. Leaving the facets for now until #148 is merged.
tommyp
force-pushed
the
content-item-docs
branch
from
f454945 to
7917eb1
Compare
tijmenb
added a commit
that referenced
this pull request
Feb 27, 2017
Full changelog: # 10.1.3 * Fix memory leak in components # 10.1.2 * Bugfix for request URI's encoded as ASCII # 10.1.1 * Bugfix for caching behaviour # 10.1.0 * Use `Rails.cache` as the cache for templates, locales and components. You can remove `config.slimmer.use_cache` for your application, as you can no longer opt-out of caching. * Add a `User-Agent` header to all outgoing API requests # 10.0.0 * Removes the need_id meta tag, which is no longer used. * Removes the functionality for breadcrumbs, related links and artefact-powered metatags. * Drop support for old Rails & Ruby versions. This gem now supports Rails 4.2 and 5.X on Ruby 2.1 and 2.2. * Renames `Slimmer::SharedTemplates` to `Slimmer::GovukComponents` # 9.6.0 * Adds an 'inside header inserter' processor which allows an application to inject a block of HTML after the logo by including a .inside-header element in their application’s output. (PR #167 alphagov/slimmer#167) * Remove `MetaViewportRemover` processor as it is no longer used. (PR #166 alphagov/slimmer#166) # 9.5.0 * Adds a Cucumber helper that makes it easy for host applications to configure Slimmer correctly under test. (PR #162 alphagov/slimmer#162) # 9.4.0 * Adds an RSpec helper that makes it easy for host applications to configure Slimmer correctly under test. Fixes `stub_shared_component_locales` helper to correctly stub HTTP requests to fetch locale information when rendering its templates. (PR #159 alphagov/slimmer#159) # 9.3.2 * Bugfix: Over time, the I18n backend would be chained in each request, causing the stack to grow too large and use too much memory (PR #157 alphagov/slimmer#157) # 9.3.1 * Allows frontend apps to stub component locales for example ```ruby class ActiveSupport::TestCase include Slimmer::TestHelpers::SharedTemplates def setup stub_shared_component_locales end end ``` (PR #155 alphagov/slimmer#155) # 9.3.0 * Integrates translations from GOVUK Components to be used in applications When including `Slimmer::SharedComponents`, the I18nBackend will be chained to `Slimmer::I18nBackend` allowing translations in `static` to work in the frontend applications (PR #152 alphagov/slimmer#152) # 9.2.1 * Replaces deprecated `before_filter` calls in shared templates. # 9.2.0 * Raise a custom `CouldNotRetrieveTemplate` exception when a connection to the assets server can't be made because of an SSL problem (PR #143). # 9.1.0 * Allow applications to request components using full or partial component paths, eg "name", "name.raw" and "name.raw.html.erb". This allows components to be nested within other components.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
First pass at a doc for what the Finder Content Item should contain. Leaving the facets for now until #148 is merged.