UKHomeOffice / engineering-guidance-and-standards

Engineering Guidance and Standards for the Home Office
https://engineering.homeoffice.gov.uk
MIT License
14 stars 2 forks source link

Low code workflow naming standard #339

Closed ARobinson26 closed 7 months ago

ARobinson26 commented 7 months ago

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

or

or

Content change

I can confirm:

ARobinson26 commented 7 months ago

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!

edhamiltonHO commented 7 months ago

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.

jeff-horton-ho-sas commented 7 months ago

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

edhamiltonHO commented 7 months ago

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 id field in frontmatter, so people could search for content by that, e.g. SEGAS-00001 or 00001

ARobinson26 commented 7 months ago

Addressed comments above from @edhamiltonHO. I've also removed the tech stacks from the tags for now. 👍🏼

edhamiltonHO commented 7 months ago

Rebased in order to verify commits and nudge checks to complete