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

Document the user-facing CLI environment variables #714

Merged
merged 1 commit into from
Apr 5, 2024

Conversation

marckhouzam
Copy link
Contributor

What this PR does / why we need it

Document the user-facing environment variables.

Environment variables used only in testing will be documented in a different PR.

You can read the new doc in markdown at https://github.com/marckhouzam/tanzu-cli/tree/feat/docEnvVars/docs/full#environment-variables-affecting-the-cli

Which issue(s) this PR fixes

Fixes # N/A

Describe testing done for PR

Visual check at https://github.com/marckhouzam/tanzu-cli/tree/feat/docEnvVars/docs/full#environment-variables-affecting-the-cli

Let CI run

Release note

Document the user-facing CLI environment variables.

Additional information

Special notes for your reviewer

@marckhouzam marckhouzam requested a review from a team as a code owner March 26, 2024 16:14
@marckhouzam marckhouzam added kind/documentation Categorizes issue or PR as related to documentation docs-impact issues with documentation impact labels Apr 4, 2024
@marckhouzam marckhouzam added this to the v1.3.0 milestone Apr 4, 2024
Copy link
Contributor

@anujc25 anujc25 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@marckhouzam marckhouzam merged commit 1e12a18 into vmware-tanzu:main Apr 5, 2024
7 checks passed
@marckhouzam marckhouzam deleted the feat/docEnvVars branch April 5, 2024 11:06
Copy link
Contributor

@vuil vuil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, thanks for putting the care in collecting and documenting them.

vuil pushed a commit to vuil/tanzu-cli that referenced this pull request Apr 19, 2024
vuil pushed a commit that referenced this pull request Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-not-required docs-impact issues with documentation impact kind/documentation Categorizes issue or PR as related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants