Generate guidance contents

[nahteb]

Instead of manually updating the contents page, we can generate the content from the files that are in the directory, and get the title and status from the frontmatter.

This is similar to what we did for the standards home page in #73.

It will look like this:

closes https://github.com/alphagov/data-standards-authority/issues/95

[nahteb]

@charlesbaird-dsa @astreater just wondering, does 'Endorsed' make sense for guidance? It's what we used on the standards page but I'm not sure if it should be 'Live' instead on this one?

[jamietanna]

~I see we're now using Endorsed, whereas Live is currently present on the website - is that OK?~

Sorry, missed your comment above!

[astreater]

@charlesbaird-dsa @astreater just wondering, does 'Endorsed' make sense for guidance? It's what we used on the standards page but I'm not sure if it should be 'Live' instead on this one?

It doesn't really make sense for guidance in the sense that guidance isn't 'endorsed' like standards are. If it's published to GOV.UK it will have gone through some level of review/approval (at the very least tech writer review, but sometimes things like Steering Board). Something like 'Live' or 'Published' might be better, if possible, but it's not a huge deal if it's going to make it more complicated. The main thing is that we want to communicate that this guidance is live and ready for use on GOV.UK (which currently is only obvious if you click into it and see the link to the GOV.UK version)

[charlesbaird-dsa]

Coming late to this but I agree with @astreater - a status field with guidance specific values seems like a good idea - we could probably have those as published/draft for now and see how we get on. We could then use the 'specification URL' field to point to the published version - but equally we might choose to have a different and slimmed down metadata model for the guidance section.

[astreater]

published/draft works for me

On Wed, 3 Nov 2021 at 17:11, charlesbaird-dsa @.***> wrote:

Coming late to this but I agree with @astreater https://github.com/astreater - a status field with guidance specific values seems like a good idea - we could probably have those as published/draft for now and see how we get on. We could then use the 'specification URL' field to point to the published version - but equally we might choose to have a different and slimmed down metadata model for the guidance section.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/alphagov/data-standards-authority/pull/96#issuecomment-959743395, or unsubscribe https://github.com/notifications/unsubscribe-auth/ARPTIEIV6VL4EUWCOVLUJMTUKFUNFANCNFSM5HJJ5ZSA . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

-- Thanks,

Annie Streater (she/her/hers) Technical Writer, Data Standards Authority Central Digital and Data Office

[nahteb]

Locally, I'm seeing all of these as Drafts - mind double checking if you see the same?

That's odd, I'm seeing what's in the screenshot above. Have you re-copied the guidance files from content to standards-catalogue/source?

[jamietanna]

Haha nope :grin: That did it, thanks!