-
Notifications
You must be signed in to change notification settings - Fork 5
docs: sync some changes from hpcflow-shared-docs #856
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
base: develop
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This has got a bit confusing, and I wouldn't merge it as-is.
There shouldn't be duplication of the examples, or at the least, the code should exist in one place only, in a code file.
I can't find where this file is used or referenced: docs/source/user/tutorials/tutorial_resources/generate_input_file.py
but the code is reproduced in docs/source/user/getting_started/custom_task_schemas_and_workflows.rst
. There are a few examples of this. In fact, I can't see any reference to anything under tutorial_resources
-- though the content of a good number of those files are used in the user/getting_started
section.
I have moved all the runnable examples into separate code files in hpcflow/hpcflow-shared-docs#12. Perhaps we can merge that, then look at what's going on with the unused/duplicated files?
I guess it's only possible to build the documentation from the shared repo by first syncing it into hpcflow/matflow first?
|
||
{{ app_module }} go <workflow_name.yaml> | ||
|
||
This small workflow should complete in less than 30s. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure which demo workflow we're supposed to be running?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the matflow docs, I suggested using modify_volume_element_grid_size
Could I assign resolving this to you @gcapes? This should really be a trivial PR. Obviously, we have a problem with the content in the shared repo.
Yep. |
Sure - how about I add it to my PR in the shared docs repo? |
No description provided.