Determining at which state the document is in

openETCS / governance

part of WP1: information needed to run project management in openetcs

7 stars 13 forks source link

Determining at which state the document is in #46

Closed MarcBehrens closed 11 years ago

MarcBehrens commented 11 years ago

could be solved by using the git tag command.

BerndHekele commented 11 years ago

Hi, this issue is unclear to me. Can you please explain?

BerndHekele commented 11 years ago

@MarcBehrens I would like to understand your proposal. Can you please explain?

MarcBehrens commented 11 years ago

The idea behind this ist that automatic ways to determine at which state the document is at (review/ release/ ...) can be generated e.g. by using the 'git tag' command and a script which parses these tags.

BerndHekele commented 11 years ago

Dear @JonasHelming : I need your support for this issue. I'm not sure how to implement such a tag on document level. Do you have any experiences for such an issue?

Thanks Bernd

JonasHelming commented 11 years ago

Sorry, but I don't really understand, what you wanna do. Could you describe your goal?

janWelte commented 11 years ago

The basic problem (as Marc presented) is that we want to assign a 'tag' to every document on github that indicates the status of the document. This status shall be read by specific functions or other tools automaticaly.

Can this be done by the 'git tag' ?
If the answer is yes, what do we have to do? Thanks

JonasHelming commented 11 years ago

Tag is a marker for a sepcific version within the repository. It can be used to mark a certain state of the repsoitory, e.g. to be the state where a document was released from. I don't this is a good match with your requirements. Why don't you add the state to the document itself?

janWelte commented 11 years ago

Actually, this shall be done for all kinds of artifacts and it should be read automatically. Where could we add it in the file itself to reach this?

JonasHelming commented 11 years ago

How or where do you wanna use this information

janWelte commented 11 years ago

This shall be used for the high level document contol and therefore indirectly to allow upstream traceability. This is needed for the safety case documentation and the document management.

JonasHelming commented 11 years ago

Does that mean, a kind of tool will process this data? There are several possibilities to capture this. One could be a certain wiki page, every project has to maintain, listing all documents. This could provide addtional benefits for the users. Another possibility could be to add a special comment into the file. However, I think I like the wiki page more. It could also reference PDFs and different versions.

idelatorre commented 11 years ago

during our last telco on Quality on August 20th, we agreed to create a wiki page on each repository determining at which state the document is in.

an email to WP leaders has been sent informing about this and with a link to an example.