-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Low code workflow naming standard #339
Conversation
I'm unsure on whether we want to tag individual tools on standards. I feel like it would be a good idea to help find standards specific to the stack you're working with but appreciate it'd be difficult to keep maintained. Open to thoughts! |
Good question this, would be good to solidify a position on it. Some thoughts: They are only tags, don't think we want to be too prescriptive on how they are used as long as they work and are useful. We should try to avoid hanging much site functionality off them Tags should provide links between different content articles that relate to the same topic, 1 to many. Therefore I wouldn't expect us to create tags for things that would likely only relate to one content article (not that that is necessarily the case here, but might be). The site search will pick up on all text in in a page, you don't need to create tags for that to work. You could instead refer to the tools in a list in the content body itself, this could lead to duplication though - e.g. you wouldn't want to be listing tools/stack in every low code standard. |
If we found content was being added just to optimise search, we could add support for a searchTerms list in the page front matter and append it to the page content when generating the search index https://github.com/UKHomeOffice/engineering-guidance-and-standards/blob/main/_includes/layouts/search-index.njk#L9 |
Yes, we did this with the standard |
Addressed comments above from @edhamiltonHO. I've also removed the tech stacks from the tags for now. 👍🏼 |
b2efafd
to
3504f68
Compare
Rebased in order to verify commits and nudge checks to complete |
Is this pull request a content or a code change? (Please fill in the relevant section and delete the other)
Code change
I can confirm:
Accessibility considerations
Please review the accessibility checks for layout changes.
This change will not change layouts, page structures or anything else that might impact accessibility
or
or
(If the change might impact accessibility then please add some further information here)
Content change
I can confirm:
e.g. Writing a principle and Writing a standard