Add note for contributors on using hidden:true in yaml files #1922
Conversation
m-green
added
the
documentation
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-1922
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-1922
docs/contributing/testing.md
Outdated
| @@ -37,7 +37,7 @@ You should add an example to the review app if the existing examples do not refl | |||
|
|
|||
| If you've created a new component, create a new `src/govuk/<COMPONENT>/<COMPONENT>.yaml` file instead, where `<COMPONENT>` is the name of the component you've created. | |||
|
|
|||
| Use `hidden: true` in an example if you want to include the example in our [test fixtures](http://frontend.design-system.service.gov.uk/testing-your-html/) but not the review app. | |||
| Use `hidden: true` in your example if you do not want to include the example in the review app. The example will still appear in our [test fixtures](http://frontend.design-system.service.gov.uk/testing-your-html/). | |||
There was a problem hiding this comment.
Would it be helpful to say that they would probably want the example to appear in the review app if there's a visual element to it?
There was a problem hiding this comment.
Is that already covered in the first line of this section maybe? "You should add an example to the review app if the existing examples do not reflect the changes you've made."
There was a problem hiding this comment.
We should actually update that line too as not all examples appear in the review app with this new change. Maybe something along the lines of:
You should add a new example if the existing examples do not reflect the changes you've made.
And then
If the example doesn't involve a visual change you can use
hidden: truein your example to hide the example in the review app.
There was a problem hiding this comment.
Ah I see what you mean. I'm thinking this through... is it likely that an external contributor would add an example to the yaml file that would need hidden: true? Or is it mainly us who would be doing that?
I'm just wondering in retrospect whether to get into hidden: true here. Because including it might mean turning this section upside-down (because it's currently primarily focused on the review app).
There was a problem hiding this comment.
I think the rest of this section is still good in terms of the references to the review app.
I think a contributor could add a new example that needs to be hidden in the review app. If they aren't sure what we mean by 'visual change' they could ask us.
There was a problem hiding this comment.
Thanks Hanna - I've rejigged in 99267dc following your feedback and a chat with @36degrees. Hope it all makes sense now.
docs/contributing/testing.md
Outdated
| @@ -37,6 +37,8 @@ You should add an example to the review app if the existing examples do not refl | |||
|
|
|||
| If you've created a new component, create a new `src/govuk/<COMPONENT>/<COMPONENT>.yaml` file instead, where `<COMPONENT>` is the name of the component you've created. | |||
|
|
|||
| Use `hidden: true` in your example if you do not want to include the example in the review app. The example will still appear in our [test fixtures](http://frontend.design-system.service.gov.uk/testing-your-html/). | |||
There was a problem hiding this comment.
I wonder if this new paragraph would make more sense being positioned after
- Add or update examples in the examples list.
as it's also about adding examples.
The 'If you've created a new component' paragraph feels like it starts a new topic as it's about adding a new file.
There was a problem hiding this comment.
That makes senses, thanks - will tweak.
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-1922
|
Rejigged this in 99267dc following a chat with @36degrees - let me know if it's all ok! |
There was a problem hiding this comment.
Looks good to me 👍 Ready to merge once @hannalaakso has approved too
m-green
force-pushed
the
adding-hidden-yaml-examples
branch
from
99267dc
to
b58ca36
Compare
Part of #1830
As part of adding docs on testing with HTML fixtures, this adds a note in our contributing docs about using
hidden: truein yaml files if you want your example to appear in the fixtures files but not the review app.