Conversation
✅ Deploy Preview for positron-posit-co ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -0,0 +1,50 @@ | |||
| --- | |||
| title: "Folder Templates" | |||
There was a problem hiding this comment.
Not sure if we like this title but I wanted to keep it generic for when we eventually add more templates (built-in or even user supported). Not in love with this title so I'm open to ideas.
The doc feels a little incomplete to me but I can't figure out what's missing...
folder-templates.qmd
Outdated
|
|
||
| The "New Folder from Template" feature helps you quickly setup a a folder with an environment using a predefined template for a language or framework. | ||
|
|
||
| To create a new folder from one of the available templates in Positron, select the "New" dropdown menu in the top-left or the workspace switcher in the top-right. Select the "New Folder from Template" option to bring up the dialog. |
There was a problem hiding this comment.
I mention the workspace switcher here and we'll want to link out to the workspace switcher section in the ui interface doc.
There was a problem hiding this comment.
Could we also include the command Workspaces: New Folder from Template... here as well?
folder-templates.qmd
Outdated
|
|
||
| ## New folder from template | ||
|
|
||
| The "New Folder from Template" feature helps you quickly setup a a folder with an environment using a predefined template for a language or framework. |
There was a problem hiding this comment.
This overview of why you would want to use the template feature feels a little light to me. Is there anything else worth mentioning here?
sharon-wang
left a comment
sharon-wang
left a comment
There was a problem hiding this comment.
What are your thoughts on focusing these docs on "why you may want to use this" and "what results the modal will yield", putting less emphasis/content around the modal steps/fields themselves?
My thinking around this: the contents of the modal may change, and in the further future, there may be extension-contributed templates that we may not explicitly document. The modal steps are hopefully self-explanatory enough when using the modal, and we have an opportunity in these docs to cover the unspoken "why" and "what to expect" parts that aren't currently included when using the modal.
folder-templates.qmd
Outdated
| **How would you like to set up your Python environment?:** | ||
| - **Create a new virtual environment:** Recommended for most users. This option creates an isolated environment for your project, which helps avoid conflicts with other Python projects on your system. | ||
| - **Use an existing environment:** Choose this if you already have a Python environment you want to use. |
There was a problem hiding this comment.
I think we'll need an empty line before the bullets to avoid this rendering issue here and a few more spots below where bulleted lists are used:
| **How would you like to set up your Python environment?:** | |
| - **Create a new virtual environment:** Recommended for most users. This option creates an isolated environment for your project, which helps avoid conflicts with other Python projects on your system. | |
| - **Use an existing environment:** Choose this if you already have a Python environment you want to use. | |
| **How would you like to set up your Python environment?:** | |
| - **Create a new virtual environment:** Recommended for most users. This option creates an isolated environment for your project, which helps avoid conflicts with other Python projects on your system. | |
| - **Use an existing environment:** Choose this if you already have a Python environment you want to use. |
There was a problem hiding this comment.
thanks for catching that! I think I might revisit the format of this section generally
folder-templates.qmd
Outdated
|
|
||
| The "New Folder from Template" feature helps you quickly setup a a folder with an environment using a predefined template for a language or framework. | ||
|
|
||
| To create a new folder from one of the available templates in Positron, select the "New" dropdown menu in the top-left or the workspace switcher in the top-right. Select the "New Folder from Template" option to bring up the dialog. |
There was a problem hiding this comment.
Could we also include the command Workspaces: New Folder from Template... here as well?
folder-templates.qmd
Outdated
|
|
||
| ### Finish | ||
|
|
||
| Once you are satisfied with your configuration options, select **Create** to create your new folder with the applied settings. Positron creates the folder and applies your selected template and settings. Once setup is complete, you will be prompted open the folder in the current window or a new window to begin working. |
There was a problem hiding this comment.
Could we also note that Positron will start up the chosen interpreter automatically?
Co-authored-by: Julia Silge <julia.silge@gmail.com>
sharon-wang
left a comment
sharon-wang
left a comment
There was a problem hiding this comment.
Thank you for writing this up! :D
3 participants
Addresses posit-dev/positron#7563.
This doc covers how to use the "New Folder from template" dialog. We quickly cover why a user would want to use this feature, how to get to the dialog, and what the different configuration options are. The section tries to generically talk about Python and R templates (notebooks are covered by the python template section).
I have decided to forego screenshots in this document. I think we can link to the ui interface doc if folks need to see a screenshot of the menus that lead to the dialog (new menu and workspace switcher). I think we can avoid screenshots for the dialog entirely since its pretty self explanatory.
I have also tried to explicitly avoid the words
workspaceandprojectin this doc except for one or two exceptions - but we may want to remove those as well.In regards to the workspace switcher - I think we can cover this topic in the ui interface doc being worked on here: #95