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.

Sign up for GitHub

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

Jump to bottom

docs: prefer relative paths if possible #192

Open
dominikburri opened this issue Nov 10, 2021 · 0 comments
Open

docs: prefer relative paths if possible #192

dominikburri opened this issue Nov 10, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers low priority Not important at the moment

Comments

@dominikburri
Copy link
Collaborator

Update the documentation for using relative paths, for example in sample tables or configuration files, when possible. This might be necessary once the workflows are run on a cluster. Also, running the test files are easier when no absolute paths need to be manually adjusted.
For cases when relative paths are not possible use the absolute paths and document on it in the respective readme.

Places where documentation might need be adjusted:

  • execution workflow readme
  • execution workflow template
  • PR review guide for exeuction workflows
@dominikburri dominikburri added the documentation Improvements or additions to documentation label Nov 10, 2021
@ninsch3000 ninsch3000 added good first issue Good for newcomers low priority Not important at the moment labels Aug 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers low priority Not important at the moment
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dominikburri @ninsch3000