Add comments showing example deploy fields. #18
Conversation
| // If deploying your project to Observable Cloud, you'll need a deploy property. E.g., | ||
| // deploy: { | ||
| // workspace: "my-observablehq-workspace", | ||
| // project: "my-project-slug" |
There was a problem hiding this comment.
I don't think we use the word "slug" anywhere user facing yet, at least commonly. I don't think it is widely known word, but maybe it's clear from context? I don't have a better word, so unless someone can come up with a better thing to put here I'm fine merging it, but I wanted to call it out.
There was a problem hiding this comment.
I am also wrestling with expressing this in the config.md text. My WIP wording there:
Specifies the target Observable workspace (without @ symbol) and the project short URL name (or "slug", similar to setting the URL for an Observable notebook).
| @@ -1,6 +1,11 @@ | |||
| export default { | |||
| // Config options documentation: https://cli.observablehq.com/config | |||
| title: "{{ projectTitle }}", | |||
| // If deploying your project to Observable Cloud, you'll need a deploy property. E.g., | |||
There was a problem hiding this comment.
the documentation mentions Observable platform
There was a problem hiding this comment.
I think this is still TBD but the latest homepage drafts I have seen use “Observable Cloud”.
|
Will merge this with language as-is; happy to re-edit if we change from "Observable Cloud" to something else. |
Part of observablehq/framework#496.
This time in the right file, and referring to "Observable Cloud".