Skip to content

Bug: Documentation in users menu goes to v1 #1037

Closed
@greyscaled

Description

@greyscaled

Steps to Reproduce

  1. Click the Documentation menu option
  2. Notice you're over at https://coder.com/docs

docs

Expected

  1. We have somewhere that we can link to (what TBD) ✔️
  2. This link is updated to point to that placeholder for v2 docs (or the real docs themselves)

Spec

  1. We will just link to /docs directory of this very repository
  2. We will add an environment variable in webpack, something like CODER_VERSION or similar. If the environment variable is set, use that. Otherwise use main as the default. See Environment Plugin:
    /**
    * environmentPlugin sets process.env.* variables so that they're available in
    * the application.
    */
    const environmentPlugin = new EnvironmentPlugin({
    INSPECT_XSTATE: "",
    })
    console.info(`--- Setting INSPECT_XSTATE to '${process.env.INSPECT_XSTATE || ""}'`)
    console.info(`--- Setting NODE_ENV to '${process.env.NODE_ENV || ""}'`)
  3. The link can then be https://github.com/coder/coder/tree/<CODER_VERSION>/docs

Metadata

Metadata

Assignees

Labels

siteArea: frontend dashboard

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions