Skip to content

Add OAuth environment variables to .env.example #8

Description

@amondnet

Description

The .env.example file is missing OAuth-related environment variables (ASANA_CLIENT_ID and ASANA_CLIENT_SECRET) that are referenced throughout the documentation.

Current State

.env.example currently only contains:

ASANA_ACCESS_TOKEN=your_access_token_here
ASANA_WORKSPACE=your_workspace_id_here
DOTENV_PUBLIC_KEY=your_dotenv_public_key_here

Issue

Multiple documentation files reference OAuth environment variables that don't exist in the example file:

Affected Files:

  • docs/content/en/1.guide/1.getting-started.md:129-133
  • docs/content/en/2.features/3.configuration.md:112-113, 148-150
  • docs/content/en/2.features/2.authentication.md (likely)

Example from documentation:

export ASANA_CLIENT_ID=your_client_id
export ASANA_CLIENT_SECRET=your_client_secret

Expected Behavior

Users following OAuth setup documentation should find corresponding variables in .env.example.

Proposed Fix

Add the following to .env.example:

# OAuth Configuration (if using OAuth 2.0)
ASANA_CLIENT_ID=
ASANA_CLIENT_SECRET=

# Personal Access Token (if using PAT instead of OAuth)
ASANA_ACCESS_TOKEN=

# Default Workspace (optional)
ASANA_WORKSPACE=

# dotenvx encryption key (generated by 'bun run env:encrypt')
DOTENV_PUBLIC_KEY=

Benefits

  • ✅ Documentation matches actual example file
  • ✅ Users understand all available configuration options
  • ✅ Clearer distinction between OAuth and PAT authentication
  • ✅ Better onboarding experience

Tasks

  • Add ASANA_CLIENT_ID to .env.example with comment
  • Add ASANA_CLIENT_SECRET to .env.example with comment
  • Add clarifying comments to distinguish OAuth vs PAT options
  • Verify all documentation references are accurate

References

Priority

Medium - Documentation inconsistency that may confuse users setting up OAuth

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions