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

Fix and document default export script (manifestexporter after sitewalker) #11

Open
tobiasherp opened this issue Aug 26, 2015 · 0 comments

Comments

@tobiasherp
Copy link

The pipeline of the default export script (quintagroup/transmogrifier/export.cfg) contains a sitewalker section followed by a manifestexporter. This is at least misleading (if not worse): the items which are created by the sitewalker are not forwarded by the manifestexporter, and thus thrown away.

This makes the usage unnecessarily difficult. (We don't have documentation and/or useful docstrings in the code, either.)

We should have a working, documented pair of scripts here, which tells about the most important options. One could e.g. simply uncomment the start-path option of the sitewalker section (unless a complete export is intended), and then use the export step; the import script should work equally easy, apart from obviously necessary specifications (which need to be present at least as a comment).

Configuration files of Apache http server, MySQL and PostgreSQL databases etc. (and many more) come nicely documented, with a lot of comments which give valuable hints. We should follow their example.

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

No branches or pull requests

1 participant