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

Problem: AMAUAT docs can potentially be simplified and should include black-box tests #900

Open
ross-spencer opened this issue Sep 11, 2019 · 0 comments
Labels
AMAUAT Issues relating to the improvement of the AM Automated Acceptance tests Wellcome Wellcome Trust

Comments

@ross-spencer
Copy link
Contributor

ross-spencer commented Sep 11, 2019

Version of the documentation

Current documentation as of 1.10.

Page (and section, if applicable) where the issue occurs

There are three main components to the acceptance test documentation:

Description of the issue

There is a lot of information in the docs, but not all is relevant to get up and running quickly. It is hard to get an indicator about the importance of the tests to Archivematica development, especially with the new black-box functionality.

Suggested fix

I feel there are three areas to focus on as we continue the AMAUAT improvement work:

  1. Include the black-box tests and how to run them (there is some proposed text in the 1.10 release notes that can potentially be migrated into the README).
  2. Make it as simple as possible for community contributors to see how to run the tests against their changes.
  3. Continue to review the docs for accuracy. With only tweaks to the tests for 1.10 there do not seem to be any substantial problems with the docs at present.
  4. Further simplification of the docs, e.g. to make them easier to maintain; to deliver the most important information as simply as possible.

See also: artefactual-labs/archivematica-acceptance-tests#146 (comment)

Related to #571
Related to artefactual-labs/archivematica-acceptance-tests#46

@ross-spencer ross-spencer added Wellcome Wellcome Trust AMAUAT Issues relating to the improvement of the AM Automated Acceptance tests labels Sep 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
AMAUAT Issues relating to the improvement of the AM Automated Acceptance tests Wellcome Wellcome Trust
Projects
None yet
Development

No branches or pull requests

1 participant