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

Wrong documentation for base_path in "Learn Atmos" section #706

Open
mss opened this issue Oct 1, 2024 · 0 comments · May be fixed by #769
Open

Wrong documentation for base_path in "Learn Atmos" section #706

mss opened this issue Oct 1, 2024 · 0 comments · May be fixed by #769
Labels
bug 🐛 An issue with the system

Comments

@mss
Copy link
Contributor

mss commented Oct 1, 2024

Describe the Bug

While trying to understand why I have to set both ATMOS_BASE_PATH and ATMOS_CLI_CONFIG_PATH and if one of them used the other as a default I stumbled over this discrepancy in the "Learn Atmos" section:

The explanation of base_path at https://atmos.tools/core-concepts/projects/configuration/#path-configuration says

We set it to an empty string because we've decided to use the ENV var ATMOS_BASE_PATH to point to the absolute path of the root of the repo

But the example further up at https://atmos.tools/core-concepts/projects/configuration/#atmos-cli-configuration-schema actually sets it to the value ./ (which is clearly not an empty string).

And if I interpret https://atmos.tools/cli/configuration/#base-path correctly an empty string would indeed have a different behaviour than that . value.

Expected Behavior

I read the documentation and shouldn't have been confused.

Steps to Reproduce

Read the documentation :-)

Screenshots

No response

Environment

No response

Additional Context

No response

@mss mss added the bug 🐛 An issue with the system label Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 An issue with the system
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant