Create Vale rules for all required OCP assembly metadata

[aireilly]

Vale should check that each of the following are in place for assemblies.

• If an attribute is found in the title, the rule should flag if the _attributes/common-attributes.adoc include is placed after the assembly title.
• :context: value should not include _{context}

include::_attributes/common-attributes.adoc[]
:context: <unique-context-for-assembly>
= title
toc::[]

[rohennes]

If an attribute is found in the title, the rule should flag if the _attributes/common-attributes.adoc include is placed after the assembly title.

We can discard this one as it's not valid anymore.
Is the second bullet point an issue you are seeing?

[aireilly]

{_context} is used in modules to resolve unique ids. If we see :context: something_{context}, we run the risk of the previous value of :context: getting set and messing up links and URLs.

[aireilly]

Could have sworn I saw this somewhere recently.

[aireilly]

toc::[] should be placed after the heading.

[aireilly]

_attributes/common-attributes.adoc should be in every assembly

[aireilly]

🤷

[rohennes]

{_context} is used in modules to resolve unique ids. If we see :context: something_{context}, we run the risk of the previous value of :context: getting set and messing up links and URLs.

Sure. I searched the repo for :context:*_ but didn't get any hits. I guess no harm in having a rule to disallow it. But I haven't notice it being an issue myself.

Reverse shrug: 🤷!

[rohennes]

Definitely agree with the other two points. I think an assembly metadata rule could be:

• check for the include attributes
• check toc is under heading

And the context one if you thought it's worthwhile

[aireilly]

Gabriel fixed a bunch of the context errors last week which is why they are no longer there.

[rohennes]

OK I see so we should inlude it then, a rule to check the following:

• check for the include attributes
• check toc is under heading
• check the context does not include _{context}

[rohennes]

https://studio.vale.sh/s/691cb2f40e893adea3abf3d95071892e - something like this but perhaps should allow include to appear above/below the title