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

Clarify status of project/handlers/preprocessors in README files #816

Closed
jeffbl opened this issue Apr 22, 2024 · 2 comments · Fixed by #818
Closed

Clarify status of project/handlers/preprocessors in README files #816

jeffbl opened this issue Apr 22, 2024 · 2 comments · Fixed by #818
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jeffbl
Copy link
Member

jeffbl commented Apr 22, 2024

To avoid confusion, add text to server repository READMES concerning what is "beta" and what is "alpha" and what that means. I propose adding the following to the server repository overall README:

IMAGE as a whole is in beta. McGill operates a public server that the IMAGE browser extension uses by default, which runs various preprocessors and handlers that the IMAGE team deems ready for testing by end users. There are many additional components in the IMAGE code repositories, some of which are not considered ready for use. These are made available for researchers and others as alpha code that requires further refinement before it is likely usable in practice. Caveats are generally noted in the README for each component. If you are a researcher evaluating or building on IMAGE, we ask that you distinguish between beta and alpha code when referencing specific IMAGE components and functionality. As a general reference for the IMAGE server architecture, please use:

Juliette Regimbal, Jeffrey R. Blum, and Jeremy R. Cooperstock. 2022. IMAGE: a deployment framework for creating multimodal experiences of web graphics. In Proceedings of the 19th International Web for All Conference (W4A '22). Association for Computing Machinery, New York, NY, USA, Article 12, 1–5. https://doi.org/10.1145/3493612.3520460

Then, in each preprocessor/handler README, mark either:

Beta quality: Useful enough for testing by end-users.

Alpha quality: Insufficiently refined to be tested by end-users.

@Cybernide I'd then also propose that we have a blurb pointing from the IMAGE website / extension description telling researchers to please note information at server wiki homepage, e.g.:

If you are a researcher using or evaluating IMAGE, please make sure to read the [IMAGE Server repository README].

Taking feedback on approach and implementation before putting this up, but would like to do so after sprint meeting on Wednesday. Ping to @JRegimbal @Cybernide @jaydeepsingh25 in particular for comments.

@jeffbl jeffbl added the documentation Improvements or additions to documentation label Apr 22, 2024
@jeffbl jeffbl self-assigned this Apr 22, 2024
@JRegimbal
Copy link
Collaborator

This seems reasonable to me! I can't think of any situations where we would need another level of component "maturity". Although I think that drawing the line between alpha and beta in practice might be somewhat difficult...

@jeffbl
Copy link
Member Author

jeffbl commented Apr 22, 2024

For now at least, I think the difference is:
beta = in production docker-compose
alpha = not in production docker-compose

@jeffbl jeffbl linked a pull request Apr 29, 2024 that will close this issue
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
2 participants