Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

As a developer I want to include the PDS4 Data Dictionary DocBook files in the PDS GitHub Repository #516

Open
jshughes opened this issue Nov 23, 2022 · 2 comments

Comments

@jshughes
Copy link
Collaborator

The PDS4 Data Dictionary DocBook files are used to produce the html, pdf, and WebHelp versions of the data dictionary document, using Oxygen. The DocBook XML files are generated by the IMTool/LDDTool application and are written to the ./export/DD directory. These files should be included in the GitHub repository in case the data dictionary document needs to be regenerated.

The new repository branch is GitHub/pds4-information-model/model-ontology/src/ontology/Export. In order to handle both the Common ("pds") and Common plus Discipline runs, the directory tree will branch into /CommonOnly/nnnn/export/DD and /CommonPlusDiscpline/nnnn/export/DD where "nnnn" indicates the IM release version. The "export/DD" potion is being used in order to accommodate other exported files in the future.

@jordanpadams
Copy link
Member

@jshughes is this something that the DDWG requested? or just something you wanted to add into the repo?

@jshughes
Copy link
Collaborator Author

@jordanpadams @c-suh Just wanted to add the PDS4 DD common and common+discipline DocBook files to repo. Catherine and I are continuing the dialog as to the best approach. For example, the common DocBook file is already generated and written to GitHub\pds4-information-model\model-ontology\target\classes\ontology. Still looking for a better place for the common+discipline Docbook file I currently generate. Also instead of me generating it, it might make more sense to generate the file during the final step of the Discipline LDD validation process and write it to ??

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: ToDo
Development

No branches or pull requests

2 participants