Skip to content

Host docs on coder.com/docs #2033

Closed
Closed
@ammario

Description

@ammario

As we all know, documentation is critical to a user's first steps into a product. I propose we move our documentation to coder.com/docs before the June 10th release if at all possible.

In terms of naming and URL scheming to avoid confusion with our v1 product, I suggest we rename the v1 section to "Coder (Classic)", keeping all the URLs the same to avoid breakage.

The v2 section could become "Coder (OSS)" and the URL can be coder-oss for now.

To avoid confusion, we may want to place a static banner on the Coder Classic docs site educating users to check out the OSS docs if they're using coder/coder.

image

Thoughts @BrunoQuaresma?

Activity

changed the title [-]Host docs on docs.coder.com[/-] [+]Host docs on coder.com/docs[/+] on Jun 3, 2022
BrunoQuaresma

BrunoQuaresma commented on Jun 6, 2022

@BrunoQuaresma
Collaborator

@ammario yes, we can make it. We need to have a manifest.json on the coder/coder repo. @khorne3 can you help me with that?

@kylecarbs I see you changed the title, but right now, the docs are on coder.com/docs 🤔

self-assigned this
on Jun 6, 2022
khorne3

khorne3 commented on Jun 6, 2022

@khorne3
Contributor

@BrunoQuaresma yes, can do!

added this to the Community MVP milestone on Jun 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

docsArea: coder.com/docs

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions

    Host docs on coder.com/docs · Issue #2033 · coder/coder