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

typo in customizing cli section #4283

Closed
gilzow opened this issue Dec 2, 2024 · 0 comments · Fixed by #4284
Closed

typo in customizing cli section #4283

gilzow opened this issue Dec 2, 2024 · 0 comments · Fixed by #4284
Assignees

Comments

@gilzow
Copy link
Collaborator

gilzow commented Dec 2, 2024

Where on docs.platform.sh should be changed?

https://docs.platform.sh/administration/cli.html#customize-the-cli
https://docs.upsun.com/administration/cli.html#customize-the-cli

What exactly should be updated?

You can customize how the CLI operates and what it returns with a configuration file (~/.platform/config.yaml) or environment variables. For details, see the customization instructions on GitHub.

Should be:

You can customize how the CLI operates and what it returns with a configuration file (~/.platformsh/config.yaml) or environment variables. For details, see the customization instructions on GitHub.

note the sh in the directory name for the configuration file.

For docs.upsun.com:

You can customize how the CLI operates and what it returns with a configuration file (~/.upsun/config.yaml) or environment variables.

should be

You can customize how the CLI operates and what it returns with a configuration file (~/.upsun-cli/config.yaml) or environment variables.

Additional context

In the markdown file we've used the {{% vendor/configdir %}} token which is the project configuration directory, but on this page, we're referring to the CLI configuration directory which is different. We probably should create a new param for vendor (e.g. cli_configfir).

@gilzow gilzow self-assigned this Dec 2, 2024
@Kemi-Elizabeth Kemi-Elizabeth linked a pull request Dec 3, 2024 that will close this issue
2 tasks
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

Successfully merging a pull request may close this issue.

1 participant