chore: review, update docs that haven't been modified in 60+ days (#435)

Katie Horne · web-flow · commit c3346fced98f · 2021-06-25T14:42:04.000-05:00
diff --git a/admin/registries/index.md b/admin/registries/index.md
@@ -14,29 +14,29 @@ image metadata.
 You can add registries during the process of
 [adding images](../../images/index.md).
 
-To import an image, go to **Images** > **Import Image** in the upper-right. In
-the dialog that opens, you'll be prompted to pick a registry by default.
-However, to _add_ a registry, click **Add a new registry**, which is the option
-located immediately below the registry selector.
-
-You'll be asked to provide:
-
-- A **registry name**
-- The **registry**
-- A **username** and **password** combination (if needed for access to the
-  registry)
-
-Then, continue with the process of [adding your image](../../images/index.md).
-When done, click **Import**.
+To import an image:
+
+1. Go to **Images** > **Import Image** in the upper-right.
+1. In the dialog that opens, you'll be prompted to pick a registry by default.
+   However, to _add_ a registry, click **Add a new registry**, which is the
+   option located immediately below the registry selector.
+1. You'll be asked to provide a **registry name**, the **registry**, and a
+   **username** and **password** combination (if needed for access to the
+   registry).
+1. Then, continue with the process of [adding your
+   image](../../images/index.md).
+1. When done, click **Import**.
 
 ## Deleting a registry
 
 > You cannot delete a registry if there are workspaces using images from that
 > registry.
 
-To delete a registry, go to the **Images** > **Registries** page. Find the
-registry that you'd like to remove, click its **horizontal ellipses** icon, and
-select **Delete**.
+To delete a registry:
+
+1. Go to the **Images** > **Registries** page.
+1. Find the registry that you'd like to remove, click its **horizontal
+   ellipsis** icon, and select **Delete**.
 
 ## Unsupported registries
 
diff --git a/admin/workspace-management/index.md b/admin/workspace-management/index.md
@@ -8,16 +8,20 @@ Administrative users can modify a variety of workspace-related behaviors.
 - From the Coder UI's **Manage** > **Admin** > **Infrastructure** tab, you can
   enable and configure the following features:
 
-  - [GPU acceleration](gpu-acceleration.md)
+  - [Access URL](../access-url.md)
+  - [GPU vendor](gpu-acceleration.md)
   - [Workspace container runtime](cvms.md)
   - [Default registries](../registries/default-registry.md)
   - [Extensions](extensions.md)
+  - [Dev URL access permissions](../devurls.md#setting-dev-url-access-permissions)
+  - [Browser security](../security.md)
   - [Memory overprovisioning](memory-overprovisioning.md)
 
-- You can also modify the [Workspace shutdown behavior](shutdown.md) on a
+- You can modify the [workspace shutdown behavior](shutdown.md) on a
   per-organization basis to optimize resource usage.
 
+- You can [install multiple IDEs](installing-jetbrains.md) onto your image so
+  that users have alternatives to the default option (VS Code).
+
 - You can [disable SSH access](ssh-access.md) for users by editing the Helm
   values file (Coder enables SSH access to workspaces by default).
-
-<children></children>
diff --git a/guides/customization/gitconfig.md b/guides/customization/gitconfig.md
@@ -1,44 +1,43 @@
 ---
-title: Managing Git configuration
+title: Git configuration
 description: Learn how to configure Git in Coder.
 ---
 
 This guide will show you how to manage your Git configuration in Coder.
 
 ## Personal git configurations
 
-Coder will create a global git configuration file located at `~/.gitconfig` in
-all newly created workspaces and set the user name and email address using the
-information associated with the user's Coder account.
+Coder will create a global Git configuration file located at `~/.gitconfig` in
+all newly created workspaces. Coder will also set the user name and email
+address based on the user's Coder account information.
 
 This step occurs before [coder/configure](images/../../../images/configure.md)
-and [personalization](../../workspaces/personalization.md), which can be used to
-override the default `.gitconfig` created by Coder. If there's already a
-`.gitconfig` file, Coder will not recreate a default version when you rebuild an
-workspace.
+and [personalization](../../workspaces/personalization.md). This means that you
+can use both files to override the default `.gitconfig` created by Coder.
 
-We recommend that each Coder user set and modify their personal .gitconfig file
-using the [~/personalize script](../../workspaces/personalization.md).
+> If there's already a `.gitconfig` file, Coder will not recreate a default
+version when you rebuild a workspace.
 
+We recommend that each Coder user set and modify their personal `.gitconfig`
+file using the [~/personalize script](../../workspaces/personalization.md).
 **Preferences defined using individual `.gitconfig` files take precedence over
 system-level settings.**
 
-## System and global git configurations
+## System and global Git configurations
 
-If you have a set of git configuration instructions that apply to your
-organization as a whole, you can define and use a system-level git
-configuration. We suggest adding the system-level `.gitconfig` directly to the
-image's Dockerfile:
+If you have a set of instructions that apply to your organization as a whole,
+you can define and use a system-level Git configuration file. We suggest adding
+the system-level `.gitconfig` directly to the image's Dockerfile:
 
 ```Dockerfile
 # Add system-level gitconfig
 COPY ["gitconfig", "/etc/gitconfig"]
 ```
 
-As you can see from the example, system-level git configurations live under
-`/etc/gitconfig`. If present, `git` applies the settings to each repository.
-However, any Coder user can override system-level settings using global or
-worktree git configurations.
+System-level git configurations live under `/etc/gitconfig`. If this file is
+present, `git` applies the settings defined to each repository. However, any
+Coder user can override system-level settings using global or worktree git
+configurations.
 
-For more information on git configuration, refer to the
-[official documentation](https://git-scm.com/docs/git-config)
+For more information on Git configuration, refer to the [official
+documentation](https://git-scm.com/docs/git-config).
diff --git a/images/ssl-certificates.md b/images/ssl-certificates.md
@@ -3,22 +3,25 @@ title: "SSL certificates"
 description: Learn how to add SSL certificates to Coder images
 ---
 
+This article will show you how to correct issues regarding SSL certificates in
+Coder.
+
+## Background
+
 Coder may sometimes fail to download extensions for your IDE if the remote
 extension marketplace URL is untrusted. This might happen for one of the
 following reasons:
 
 - The image doesn't come with any ca-certificates
 - You're using an internal certificate authority
 
-The following sections will show you how to correct these issues.
-
 ## Adding certificates for Coder
 
 To add certificates to your image and have them recognized by Coder:
 
 1. Add the certificate(s) to the image
-1. Set the NODE_EXTRA_CA_CERTS workspace variable to the file in the image that
-   contains the certificates
+1. Set the `NODE_EXTRA_CA_CERTS` environment variable to the file in the image
+   that contains the certificates
 1. Add the following to your Dockerfile to ensure that Coder finds and uses your
    newly added certificates when making requests:
 
diff --git a/images/writing.md b/images/writing.md
@@ -7,8 +7,8 @@ Custom images allow you to define workspaces that include the dependencies,
 scripts, and user preferences helpful for your project.
 
 > If you're unfamiliar with how to create, build, and push Docker Images, please
-> see
-> [this tutorial by Docker](http://blog.shippable.com/build-a-docker-image-and-push-it-to-docker-hub)
+> review [this tutorial by
+> Docker](http://blog.shippable.com/build-a-docker-image-and-push-it-to-docker-hub)
 > before proceeding.
 
 ## Creating a custom image
@@ -81,7 +81,7 @@ RUN ln -s /opt/clion/bin/clion.sh /usr/bin/clion
 
 To get an idea of what you can include in your images, see:
 
-- [Ben's Coder Images](https://github.com/bpmct/cdr-images) (frequently referred
+- [Ben's Coder images](https://github.com/bpmct/cdr-images) (frequently referred
   to in [Coffee and Coder](https://community.coder.com/coffee-and-coder) and the
   [Coder blog](https://coder.com/blog))
-- [Sample Coder Images](https://github.com/cdr/enterprise-images)
+- [Sample Coder images](https://github.com/cdr/enterprise-images)
diff --git a/manifest.json b/manifest.json
@@ -82,6 +82,9 @@
         {
           "path": "./images/tags.md"
         },
+        {
+          "path": "./images/writing.md"
+        },
         {
           "path": "./images/configure.md"
         },
diff --git a/setup/configuration.md b/setup/configuration.md
@@ -30,29 +30,29 @@ Coder provides you with your licensing information, which looks like:
 {"owner":"yourName","issued_at":"2020-01-01T00:00:00Z","expires_at":"2020-01-02T00:00:00Z","max_usage":{"user_count":10},"paid":false,"nonce":"MjA...MDA=","version":1,"checksum":"VtG...uQ=="}
 ```
 
-Copy this information into the text editor of your choice, and save it as a .txt
-or a JSON file. You'll need to upload this file at two points during the setup
-and configuration processes.
+Copy this information into the text editor of your choice, and save it as a
+`.txt` or a `.json` file. You'll need to upload this file at **two** points
+during the setup and configuration processes.
 
 ## Providing your license
 
 Immediately after logging into Coder for the first time, you'll be prompted to
-upload your license (you must provide a JSON file).
+upload your license (you must provide a `.txt` or `.json` file).
 
 Once done, you can proceed with the Coder configuration process.
 
 ## Configure your Coder deployment
 
-Once you log in to Coder's Web UI, you'll be walked through a configuration
-dashboard. You can specify the authentication method used for logins, provide
-your license information, and more.
+Immediately after logging in to Coder's Web UI, you'll be walked through a
+configuration dashboard. You can specify the authentication method used for
+logins, provide your license information, and more.
 
-After you complete this process, you'll be redirected to the main Coder
+When you complete this process, you'll be redirected to the main Coder
 dashboard, where you can create new users, images, and workspaces.
 
-> After completing the configuration process, we recommend creating a **site
-> manager** user that can be used to create additional users and resources. **We
-> recommend using the site admin user only for initial configuration purposes.**
+> As part of the configuration process, we recommend creating a **site manager**
+> user that can be used to create additional users and resources. **We suggest
+> using the site admin user only for initial configuration purposes.**
 
 ### Best practices
 
diff --git a/setup/kubernetes/index.md b/setup/kubernetes/index.md
@@ -7,7 +7,7 @@ You can install and deploy Coder onto any Kubernetes cluster (version 1.13.7+)
 that meets the [requirements](../requirements.md).
 
 To help you get up and running, Coder offers the following deployment guides (if
-you're all set up with a Kubernetes cluster, please proceed to
+you're already set up with a Kubernetes cluster, please proceed to
 [installation](../installation.md)):
 
 <children></children>
diff --git a/workspaces/preferences.md b/workspaces/preferences.md
@@ -3,20 +3,21 @@ title: "User preferences"
 description: Learn how to manage your Coder account preferences.
 ---
 
-The User Preferences area of the Coder UI allows you to manage your account. To
-access this area, click on your avatar in the top-right, and click on either
-**Account** or your avatar in the drop-down menu.
+The **User Preferences** area of the Coder UI allows you to manage your account.
+
+To access **User Preferences**, click on your avatar in the top-right, then
+click on either **Account** or your avatar in the drop-down menu.
 
 ## Account
 
 The **Account** tab allows you to provide or change:
 
+- Your avatar
 - Your display name
 - Email address
 - Username (this is the value that Coder uses throughout the platform, including
-  in dev URLs and the CLI's SSH configuration)
+  dev URLs and the CLI's SSH configuration)
 - Your dotfiles URI to personalize your workspaces
-- Your avatar
 
 ## Security
 
@@ -29,9 +30,9 @@ combination).
 > organization's account management system. See your system administrator for
 > more information.
 
-## SSH key
+## SSH keys
 
-The **SSH Key** page is where you'll find the public key corresponding to the
+The **SSH Keys** page is where you'll find the public key corresponding to the
 private key that Coder inserts automatically into your workspaces. The public
 key is useful for services, such as Git, Bitbucket, GitHub, and GitLab, that you
 need to access from your workspace.
@@ -64,5 +65,9 @@ Please note that:
 - You must enable native notifications for each browser on which you run Coder
   Enterprise
 
-You can check whether notifications are enabled and working by click **Test
-Notifications**.
+You can check whether notifications are enabled and working by click **Test**.
+
+## Autostart
+
+Autostart allows you to set the time when Coder automatically starts and builds
+your workspaces. See [Autostart](autostart.md) for more information.
diff --git a/workspaces/pwa.md b/workspaces/pwa.md
@@ -1,13 +1,11 @@
 ---
 title: "Progressive web apps"
-description:
-  Learn how to install the editor PWAs for a native IDE-like browser editing
-  experience.
+description: Learn how to install the editor PWAs for a native IDE-like browser editing experience.
 ---
 
 In addition to running Coder in a web browser, you can also run each application
 as a progressive web application (PWA). Using Coder as a PWA offers you an
-experience that is akin to a native application and offers improved performance.
+experience akin to a native application and improved performance.
 
 ## Requirements
 
@@ -21,36 +19,3 @@ To use Coder as a PWA, you must be using Google Chrome or Microsoft Edge.
 1. Follow your browser's instructions for installing the application as a PWA.
 
 Please note that applications are currently installed on a per-workspace basis.
-
-## Coder PWA for v. 1.14.x or Earlier
-
-> The following instructions are applicable only if you're using Coder v 1.14.x
-> or earlier.
-
-## Chrome installation
-
-You can install Coder as a PWA when using Chrome in one of three ways:
-
-1. Click **Install App**, which is located at the top of the Coder Dashboard.
-1. Go to your **Settings** menu, and select **Install Coder**.
-1. Click the **plus** icon located in the browser's URL bar.
-
-### Uninstalling the Chrome progressive web app
-
-To remove the Coder progressive web app at any time, go to **Settings** >
-**Uninstall Coder**. You'll be prompted to remove Coder; confirm by clicking
-**Remove**. You can also check the box to clear Coder data if desired.
-
-## Edge installation
-
-You can install Coder as a PWA when using Edge in one of three ways:
-
-1. Click **Install App**, which is located at the top of the Coder Dashboard.
-1. Click the **plus** icon located in the browser's URL bar.
-1. Go to Settings > Apps and select **Install Coder**.
-
-### Uninstalling the Edge progressive web app
-
-To remove the Coder progressive web app, go to **Settings** > **Uninstall
-Coder**. You'll be prompted to remove Coder; confirm by clicking **Remove**. You
-can also check the box to clear Coder data (if desired).

Original file line number	Diff line number	Diff line change
`@@ -82,6 +82,9 @@`
`82`	`82`	`{`
`83`	`83`	`"path": "./images/tags.md"`
`84`	`84`	`},`
	`85`	`+ {`
	`86`	`+ "path": "./images/writing.md"`
	`87`	`+ },`
`85`	`88`	`{`
`86`	`89`	`"path": "./images/configure.md"`
`87`	`90`	`},`