Skip to content

chore: Update docs manifest home page and icons #2133

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
Jun 9, 2022
Merged

chore: Update docs manifest home page and icons #2133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1c0f53c
chore: Update docs manifest home page and icons
BrunoQuaresma Jun 7, 2022
ffd800f
RRemove contributors
BrunoQuaresma Jun 7, 2022
2082bb0
Update template icon
BrunoQuaresma Jun 7, 2022
f4a061f
fixup: manifest.json changes
jsjoeio Jun 9, 2022
06f0568
fix: add missing readme to root
jsjoeio Jun 9, 2022
ec93275
fix: add readme to /docs with toc
jsjoeio Jun 9, 2022
3bb3527
fix: add quickstart to manifest
jsjoeio Jun 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Coder Documentation

## Table of Contents

- [About Coder](./about.md#about-coder)
- [Why remote development](./about.md#why-remote-development)
- [Why Coder](./about.md#why-coder)
- [What Coder is not](./about.md#what-coder-is-not)
- [Comparison: Coder vs. [product]](./about.md#comparison)
- [Quickstart](./quickstart.md)
- [Creating your first template and workspace](./quickstart.md#creating-your-first-template-and-workspace)
- [Modifying templates](./quickstart.md#modifying-templates)
- [Templates](./templates.md)
- [Manage templates](./templates.md#manage-templates)
- [Persistent and ephemeral
resources](./templates.md#persistent-and-ephemeral-resources)
- [Parameters](./templates.md#parameters)
- [Workspaces](./workspaces.md)
- [Create workspaces](./workspaces.md#create-workspaces)
- [Connect with SSH](./workspaces.md#connect-with-ssh)
- [Editors and IDEs](./workspaces.md#editors-and-ides)
- [Workspace lifecycle](./workspaces.md#workspace-lifecycle)
- [Updating workspaces](./workspaces.md#updating-workspaces)
33 changes: 22 additions & 11 deletions docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,46 @@
{
"versions": ["0.6.2"],
"routes": [
{
"title": "Home",
"description": "How to install and run Coder",
"path": "./README.md",
"icon": "<svg xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16px\" xml:space=\"preserve\"><path d=\"M15.45,7L14,5.551V2c0-0.55-0.45-1-1-1h-1c-0.55,0-1,0.45-1,1v0.553L9,0.555C8.727,0.297,8.477,0,8,0S7.273,0.297,7,0.555 L0.55,7C0.238,7.325,0,7.562,0,8c0,0.563,0.432,1,1,1h1v6c0,0.55,0.45,1,1,1h3v-5c0-0.55,0.45-1,1-1h2c0.55,0,1,0.45,1,1v5h3 c0.55,0,1-0.45,1-1V9h1c0.568,0,1-0.437,1-1C16,7.562,15.762,7.325,15.45,7z\"></path></svg>"
},
{
"title": "About",
"description": "About Coder",
"path": "./about.md"
"path": "./about.md",
"icon": "<svg width=\"20\" height=\"20\" viewBox=\"0 0 20 20\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M6 2V11H2V15C2 16.7 3.3 18 5 18H15C16.7 18 18 16.7 18 15V2H6ZM16 15C16 15.6 15.6 16 15 16H8V4H16V15Z\" /><path d=\"M14 7H10V9H14V7Z\" /><path d=\"M14 11H10V13H14V11Z\" /></svg>"
},
{
"title": "Installation",
"description": "Learn how to install and deploy Coder.",
"description": "How to install and deploy Coder",
"icon": "<svg class=\"MuiSvgIcon-root jss172\" focusable=\"false\" viewBox=\"0 0 24 24\" aria-hidden=\"true\"><path d=\"M22.7 19l-9.1-9.1c.9-2.3.4-5-1.5-6.9-2-2-5-2.4-7.4-1.3L9 6 6 9 1.6 4.7C.4 7.1.9 10.1 2.9 12.1c1.9 1.9 4.6 2.4 6.9 1.5l9.1 9.1c.4.4 1 .4 1.4 0l2.3-2.3c.5-.4.5-1.1.1-1.4z\"></path></svg>",
"path": "./install.md"
},
{
"title": "Quickstart",
"description": "Create your first template and workspace",
"icon": "<svg class=\"MuiSvgIcon-root jss172\" focusable=\"false\" viewBox=\"0 0 24 24\" aria-hidden=\"true\"><path d=\"M22.7 19l-9.1-9.1c.9-2.3.4-5-1.5-6.9-2-2-5-2.4-7.4-1.3L9 6 6 9 1.6 4.7C.4 7.1.9 10.1 2.9 12.1c1.9 1.9 4.6 2.4 6.9 1.5l9.1 9.1c.4.4 1 .4 1.4 0l2.3-2.3c.5-.4.5-1.1.1-1.4z\"></path></svg>",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BrunoQuaresma I didn't know what icon to use so I just copied another one. We can update before we make the site live

"path": "./quickstart.md"
},
{
"title": "Templates",
"description": "Learn about templates, which define the infrastructure underlying workspaces.",
"path": "./templates.md",
"icon": ""
"icon": "<svg viewBox=\"0 0 16 16\" xmlns=\"http://www.w3.org/2000/svg\"> <path d=\"M15.0017 4.0017H1.0017C0.868289 3.99368 0.734692 4.01405 0.609732 4.06147C0.484772 4.10889 0.371292 4.18228 0.276784 4.27678C0.182276 4.37129 0.108891 4.48477 0.0614728 4.60973C0.0140548 4.73469 -0.00631686 4.86829 0.00170278 5.0017V15.0017C-0.00631686 15.1351 0.0140548 15.2687 0.0614728 15.3937C0.108891 15.5186 0.182276 15.6321 0.276784 15.7266C0.371292 15.8211 0.484772 15.8945 0.609732 15.9419C0.734692 15.9894 0.868289 16.0097 1.0017 16.0017H15.0017C15.1351 16.0097 15.2687 15.9894 15.3937 15.9419C15.5186 15.8945 15.6321 15.8211 15.7266 15.7266C15.8211 15.6321 15.8945 15.5186 15.9419 15.3937C15.9894 15.2687 16.0097 15.1351 16.0017 15.0017V5.0017C16.0097 4.86829 15.9894 4.73469 15.9419 4.60973C15.8945 4.48477 15.8211 4.37129 15.7266 4.27678C15.6321 4.18228 15.5186 4.10889 15.3937 4.06147C15.2687 4.01405 15.1351 3.99368 15.0017 4.0017ZM14.0017 14.0017H2.0017V6.0017H14.0017V14.0017Z\" /> <path d=\"M14 0H2V2H14V0Z\" fill=\"#333333\"/> <path d=\"M5 13L10 8L13 13H5Z\" /> <path d=\"M5 10C5.55228 10 6 9.55228 6 9C6 8.44772 5.55228 8 5 8C4.44772 8 4 8.44772 4 9C4 9.55228 4.44772 10 5 10Z\" /> </svg>"
},
{
"title": "Workspaces",
"description": "Learn about Coder workspaces.",
"icon": "<svg viewBox=\"0 0 16 16\" xmlns=\"http://www.w3.org/2000/svg\">\n<path d=\"M7.6 0.0984375L0.4 3.49844C0.2 3.59844 0.2 3.89844 0.4 3.99844L7.7 7.29844C7.9 7.39844 8.2 7.39844 8.4 7.29844L15.6 3.99844C15.8 3.89844 15.8 3.59844 15.6 3.49844L8.4 0.0984375C8.1 -0.0015625 7.9 -0.0015625 7.6 0.0984375Z\" />\n<path d=\"M15.6 7.79844L14.1 7.09844C13.9 6.99844 13.6 6.99844 13.4 7.09844L8.3 9.39844C8.1 9.49844 7.8 9.49844 7.6 9.39844L2.6 7.09844C2.3 6.99844 2.1 6.99844 1.9 7.09844L0.4 7.79844C0.2 7.89844 0.2 8.19844 0.4 8.29844L7.7 11.5984C7.9 11.6984 8.2 11.6984 8.4 11.5984L15.7 8.29844C15.8 8.19844 15.8 7.89844 15.6 7.79844Z\" />\n<path d=\"M15.5984 12.0984L14.0984 11.3984C13.8984 11.2984 13.5984 11.2984 13.3984 11.3984L8.29844 13.6984C8.09844 13.7984 7.79844 13.7984 7.59844 13.6984L2.49844 11.3984C2.29844 11.2984 1.99844 11.2984 1.79844 11.3984L0.298438 12.0984C0.0984375 12.1984 0.0984375 12.4984 0.298438 12.5984L7.59844 15.8984C7.79844 15.9984 8.09844 15.9984 8.29844 15.8984L15.5984 12.5984C15.7984 12.4984 15.7984 12.1984 15.5984 12.0984Z\"/></svg>",
"path": "./workspaces.md"
},
{
"title": "Contributing",
"description": "Learn how to contribute to Coder.",
"icon": "<svg width=\"20\" height=\"20\" fill=\"none\" viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M5 2.5V12.5\" stroke=\"currentColor\" fill=\"none\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\"/><path d=\"M15 7.5C16.3807 7.5 17.5 6.38071 17.5 5C17.5 3.61929 16.3807 2.5 15 2.5C13.6193 2.5 12.5 3.61929 12.5 5C12.5 6.38071 13.6193 7.5 15 7.5Z\" stroke=\"currentColor\" fill=\"none\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\"/><path d=\"M5 17.5C6.38071 17.5 7.5 16.3807 7.5 15C7.5 13.6193 6.38071 12.5 5 12.5C3.61929 12.5 2.5 13.6193 2.5 15C2.5 16.3807 3.61929 17.5 5 17.5Z\" stroke=\"currentColor\" fill=\"none\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\"/><path d=\"M15 7.5C15 9.48912 14.2098 11.3968 12.8033 12.8033C11.3968 14.2098 9.48912 15 7.5 15\" stroke=\"currentColor\" fill=\"none\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\"/></svg>",
"path": "./CONTRIBUTING.md",
"children": [
{
Expand All @@ -33,16 +49,11 @@
"path": "./CODE_OF_CONDUCT.md"
},
{
"title": "Contributors",
"description": "See a contributors to Coder.",
"path": "./CONTRIBUTORS.md"
"title": "Security policy",
"description": "How to report vulnerabilities in Coder",
"path": "./SECURITY.md"
}
]
},
{
"title": "Security policy",
"description": "Learn how to report vulnerabilities in Coder.",
"path": "./SECURITY.md"
}
]
}