Identifier for Dita Generated files

NHSDigital / DataDictionaryPublication

Apache License 2.0

7 stars 1 forks source link

Identifier for Dita Generated files #373

Open AngelaFaulding opened 2 years ago

AngelaFaulding commented 2 years ago

Dita will be generated via the Orchestrator for a release, preview and CRs. We would like an identifier for each generated file, i.e. name of published file, branch name and date. e.g. CR1234date This will help with the DD Publishing Pipeline.

AngelaFaulding commented 2 years ago

@jamesrwelch, Cath and I have had a chat and suggest the following identifiers:

Release: month and year, e.g. june2022
Preview: previewCRnumberdatetime, e.g. preview1234070220220925
Basic CR: CRnumberdatetime, e.g. CR1234070220220925
Data Set CR: CRnumberdsdateandtime, e.g. CR1234ds070220220925

Will this work? Some look a bit long. We can discuss later?

AngelaFaulding commented 2 years ago

7/2/22 - This is OK with James. He will add hyphens to make the information easier to read. Moved to In Progress.

AngelaFaulding commented 2 years ago

15/2/22 - James is still working on this. We won't be able to test this until we have some Dita to generate.

AngelaFaulding commented 2 weeks ago

9/7/24 - from Peter I've briefly checked the answer to your question in this morning's standup. The CR number is not included in the DITA files at the moment, but it should be part of the filename. I'm not sure how that affects your tooling.

AngelaFaulding commented 2 weeks ago

The dita files will be used in the DDPM, see #406

AngelaFaulding commented 1 week ago

I'm not sure if this is for @jamesrwelch or Peter.

The dita files in the screen shot have been run in the Orchestrator.

The main is the preview of the branch. Is it possible to change the name of the preview so the CR number is included. We don't understand why it has been done for the CRs but not the preview. It will be easier for the DDPM, if not we will have to rename zip files which is not ideal.