Skip to content

Improve example documentation #28

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

Open
bstanciulescu opened this issue Mar 28, 2025 · 1 comment
Open

Improve example documentation #28

bstanciulescu opened this issue Mar 28, 2025 · 1 comment

Comments

@bstanciulescu
Copy link

This issue is related to the JOSS review: openjournals/joss-reviews#7854
Two main issues arose when trying to test the Syclops installation:

  1. The generated example file, is not easy to locate in the folder's tree;
  2. Could you detail the way to create its own job files ? The yaml file fields should be explicitly documented.
@aelmiger
Copy link
Collaborator

aelmiger commented Apr 2, 2025

Thank you for the feedback.

  1. The example yaml is placed here: example.yaml. Do you suggest moving it higher in the folder tree, or is it enough to point to it in the README.md? In the documentation, its location is mentioned, but that might be overlooked.

  2. The process for creating job files is documented here: Syclop Documentation. It includes an explanation of the YAML fields used for the job descriptions. If this documentation does not provide enough clarity, could you provide more specific feedback on which fields require further explanation.

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

2 participants