[OASIS Issue Tracker] (OFFICE-4082) Editing processes of our ODF TC deliverables

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

     [ https://issues.oasis-open.org/browse/OFFICE-4082?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Michael Stahl updated OFFICE-4082:
----------------------------------
    Component/s: Part 4 (Formula) [1.2: 2]

> Editing processes of our ODF TC deliverables
> --------------------------------------------
>
>                 Key: OFFICE-4082
>                 URL: https://issues.oasis-open.org/browse/OFFICE-4082
>             Project: OASIS Open Document Format for Office Applications (OpenDocument) TC
>          Issue Type: Task
>          Components: Part (Formula), Part (Packages), Part (Schema), Part 1 (Introduction) [1.2: -], Part 4 (Formula) [1.2: 2]
>    Affects Versions: ODF 1.3
>         Environment: Deliverables atÂ[http://docs.oasis-open.org/office/OpenDocument/v1.3/]
> Intermediate entities at:Â[https://github.com/oasis-tcs/odf-tc]
> Â
>            Reporter: Svante Schubert
>            Priority: Major
>              Labels: editorial
>             Fix For: ODF 1.3 CS02
>
>
> As described last week on the TC mailing list:
> [https://lists.oasis-open.org/archives/office/202007/msg00021.html]
> Â
> Â
> I would suggest we are bringing all your working draft files into our GitHub repository.
> The final ODF 1.2 artefacts are already checked in:Â[odf-tc/src/main/resources/odf1.2|https://github.com/oasis-tcs/odf-tc/tree/master/src/main/resources/odf1.2]
> You might want to add your current state-of-work at: * odf-tc/src/main/resources/odf1.3
>  * odf-tc/src/main/resources/odf1.4
> I wouldÂsuggest to place the ODTs of all parts with the schemas flat in the directories and unzip the ODT in addition n a directory named identical aside with "_" instead of ".".
> The reason for the duplication is that the XSLT is not yet able to access the XML within the ODT and Git is just better with pretty printed XMLÂfiles as with binary blobs.
> On theÂother hand, for convenience, I would like to be able to open quickly open the file without zipping it myself.
> There should be a script to unzip them and a pre-commit hook test that both (ODT & unzipped XML) are identical, but one step after the other.
> You might as well edit the XML. Although the MIMETYPE should not be compressed, my bet is LibreOffice (LO) will fix it.
> After you added your documents, we might test if an update of LO will change the existing parts by loading and saving them (aside from the metadata string).
> Michael got such a regression tests AFAIR.
> Â
> In addition, we might want to commit the results of our transformations as well, e.g. for ODF 1.3:Â[odf-tc/src/test/resources/odf1.3/references|https://github.com/oasis-tcs/odf-tc/tree/master/src/test/resources/odf1.3]
> It is easier to spot regression if we have the former results of our transformations at hands in history.
> Of course, the file names will change in the future according to the input, but the work is quite preliminary at this point.
> Â
> As a rule ofÂthumb. All files being delivered are in the directory:Â
>  * odf-tc/src/*main*/
> all other files, being mostly test and test documentsÂwill reside beyond:
>  * odf-tc/src/*test*/ÂÂ
> I am reusing theÂ[Maven build system standard layout|http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html]. Perhaps later we might switch toÂ[Gradle|https://gradle.org/maven-vs-gradle/].
> Â
> [GitHub Pages|https://pages.github.com/]Âis activated, but I want to improve it, the test commits will be cleaned up later in my fork, I have moved tests to:
> [https://github.com/svanteschubert/testing-github-pages/]ÂÂ;
> Â
> For the ODF 1.3 CS02, I would suggest you work without change-tracking most of the format changes is too noisyÂin change-tracking anyway.
> We should be able to track your changes in the content.xml via GIT.
> Still, it would be helpful if we use GitHub commit on the deliverable artefacts as semantical steps using a certain commit pattern including the issue ID and title.
> Although we are using still JIRA we might want to overtake theÂ[GitHub keywords|https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword], e.g. I suggest we use: "Fixes #242 bug title".
> In case of the format task, you might add the subtask instead of the bug title.
> Â
> Last but not least, later we might want to fix one task after the other. Starting with no changes in the beginning, we would enable change tracking for this task.
>  # Fix the JIRA issue within the specification
>  # The editor would do a pull-request, triggering viaÂ[TravisÂ|https://travis-ci.org/]several tests.
>  # Another TC member as a reviewer will check the task against the JIRA issue - we might want to enable (later) branch protection for review
>  # The ODT will be committed as reviewed within GitHub still with change-tracking
>  # The ODT will be committed again with GitHub with all changes accepted
> Now this iteration would repeat.Â
> The advantage is that we have change-tracking only for this task and might generate DIFF PDF from the change-tracking ODT to show the changes related to one issue.
> The disadvantage we might end up with more than one DIFF PDF if we have to start such iteration for the same issue again and we won't have one DIFF document.
> Â
> As a developer, I would be happy to have a list of changes related to new featuresÂwith all changes related in oneÂPDF and/or ODT.
> In addition, I never liked the all-diff-included with all the format changes, it is far too much noise, as it included all format changes as well.



--
This message was sent by Atlassian Jira
(v8.3.3#803004)