-
Notifications
You must be signed in to change notification settings - Fork 320
Add Windows environment variable instructions for INFLUXDB3_AUTH_TOKEN #6325
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: master
Are you sure you want to change the base?
Conversation
…H_TOKEN Co-authored-by: jstirnaman <[email protected]>
jstirnaman
left a comment
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.
@copilot Use the new code-placeholders syntax, which appends attributes to the code block fence--for example:
```bash { placeholders="YOUR_AUTH_TOKEN|YOUR_DATABASE_NAME" }
Co-authored-by: jstirnaman <[email protected]>
... Updated to use the new Commit: 0ea9ca8 |
jstirnaman
left a comment
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.
👍
|
|
||
| {{% code-placeholders "YOUR_AUTH_TOKEN" %}} | ||
| ```bash | ||
| {{< tabs-wrapper >}} |
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.
The tabs are now (incorrectly) nested. Separate into env var usage and CLI option usage.
@copilot See #6325 (comment). The tabs are now nested, but that won't work. Separate into "To have your token provided automatically, set the environment variable: ..." and "To provide your token in the command, use the |
Windows users were getting confused by the documentation which only provided Unix-style commands for setting the
INFLUXDB3_AUTH_TOKENenvironment variable. This was causing issues for Windows users trying to follow the getting started guide.Before:
The documentation only showed:
export INFLUXDB3_AUTH_TOKEN=YOUR_AUTH_TOKENAfter:
The documentation now provides platform-specific instructions using a tabbed interface:
export INFLUXDB3_AUTH_TOKEN=YOUR_AUTH_TOKEN$env:INFLUXDB3_AUTH_TOKEN = "YOUR_AUTH_TOKEN"set INFLUXDB3_AUTH_TOKEN=YOUR_AUTH_TOKEN(with trailing space and explanatory note)The implementation follows the existing pattern used in the cloud-dedicated documentation, using Hugo shortcodes (
{{< tabs-wrapper >}},{{% tabs %}}, and{{% tab-content %}}) to create an interactive tabbed interface.Since this change is made to the shared content file (
/content/shared/influxdb3-get-started/setup.md), it automatically applies to both InfluxDB 3 Core and Enterprise documentation.Fixes #6290.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.