Skip to content

bug: README.md in the README.md folder references Projects not Templates and other missing things  #1114

Closed

Description

@sharkymark

OS Information

  • OS: MacOS
  • Browser (if applicable):
  • Architecture:
  • coder --version: 0.4.3

Steps to Reproduce

  1. docs references the old terminology, Projects, and not Templates

'Working with Projects' title needs to be changed

  1. There is also a missing step to cd into the new template folder before running additional commands. The CLI help correctly points this out, but this README.md is out-of-date.

  2. Also the coder templates create command needs to be like:
    ../coder workspaces create --template="docker-local" mark-docker-ws

  3. The README.md should also include steps like coder config-ssh and ssh coder. and explain what is going on in these steps. CLI help has some of this, but it should be captured in the README.md for new users who are curious about Coder v2 and what is provides.

  4. Underlight Highlights, it mentions 'in your cloud' but there is a Docker example which can be local

Notes

Activity

  1. bpmct commented on Apr 25, 2022

    @bpmct
    Member

    Working on this in #1107

  2. self-assigned this
    on Apr 25, 2022
  3. added this to the V2 Beta milestone on May 4, 2022
  4. misskniss commented on May 5, 2022

    @misskniss

    @bpmct can this be closed then since that PR is merged?

  5. misskniss commented on May 5, 2022

    @misskniss

    Hey team! Please add your planning poker estimate with ZenHub @bpmct @jsjoeio

  6. bpmct commented on May 5, 2022

    @bpmct
    Member

    Yes, we can close this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

apiArea: HTTP APIdocsArea: coder.com/docs

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions