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

Consider adding a worked example of an object that sword works with #32

Open
richard-jones opened this issue Mar 12, 2020 · 1 comment
Assignees
Labels

Comments

@richard-jones
Copy link
Contributor

We have provided an abstract diagram of an object in the specification, but perhaps this would be easier for users to consume if there was a worked example which contained things like:

  • The originally deposited Zip files
  • Files extracted from the Zip
  • Administrative files created by the repo that sword can't touch
  • Metadata available in multiple formats

This may be an adjunct to the spec, rather than in the spec itself.

@richard-jones
Copy link
Contributor Author

We have started a "playbook" which gives us a place to put such worked examples in the future. At the moment it only has a simple example in it, but going forward we should be looking to fill this with real-world type examples of usage.

@richard-jones richard-jones self-assigned this Jul 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant