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

Reorganize generated documentation #11

Open
mlipper opened this issue Jan 19, 2016 · 0 comments
Open

Reorganize generated documentation #11

mlipper opened this issue Jan 19, 2016 · 0 comments

Comments

@mlipper
Copy link
Member

mlipper commented Jan 19, 2016

The geoclient-service module uses the geoclient-doc.xml configuration file in the geoclient-core subproject to provide dynamically rendered HTML-based documentation at runtime. This is both unnecessary and error-prone.

Originally, the Geoclient XML metadata was created by parsing Geosupport's Universal Programming Guide PDF document to produce a "base" set of field definitions for the data elements returned by the various Geoclient endpoints (address, bbl, etc.) by mapping the endpoints to their proxy targets (Geosupport functions) using the UPG's data dictionary.

Due to variance in the PDF's (which were not intended for this kind of reverse-engineering) and the use of "tech bulletins" by DCP to announce new release changes, this "automated" integration quickly became a manual process resulting neglect and inclomplete/out-of-date generated HTML.

DCP has recently communicated its intention to place this documentation content online as part of their GOAT application. As such, Geoclient should simply link returned data fields on a per-endpoint basis to the appropriate section of GOAT and get rid of the convoluted code for assembling this info using XStream.

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

No branches or pull requests

1 participant