Add notes to each shortcode migrating to server (#3825)

Signed-off-by: Ian Maddaus <[email protected]>

layouts/shortcodes/EOL_backend.md

@@ -4,4 +4,6 @@ Chef Backend is [deprecated](/versions/#deprecated-products-and-versions) and no
 
 This document is no longer maintained.
 
-</div></div>
+</div></div>
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/adopted_platforms_server.md

@@ -46,3 +46,6 @@ The following table lists the commercially-supported platforms and versions for
 </tr>
 </tbody>
 </table>
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/all_directory_chef.md

@@ -1,2 +1,4 @@
 The .chef directory is a hidden directory that is used to store
-validation key files and optionally a [config.rb](/config_rb.html) file.
+validation key files and optionally a [config.rb](/config_rb.html) file.
+
+{{/* shortcode delete. Text moved to chef-server repo */}}

layouts/shortcodes/chef_auth.md

@@ -1 +1,3 @@
 The Chef Infra Server API handles all communication between Chef Infra Client or Chef Workstation. The Chef Infra Server API is an authenticated REST API, which means all requests require authentication and authorization. The Chef Infra tools such as `knife` and `chef-server` commands use the Chef Infra Server API for you.
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/chef_auth_authentication.md

@@ -6,3 +6,6 @@ The authentication process ensures that Chef Infra Server only responds to reque
 * Chef Infra Client saves the private key in `/etc/chef`
 
 Both Chef Infra Client and Chef Workstation communicate with the Chef Infra Server using the Chef Infra Server API. Each time that Chef Infra Client or Chef Workstation makes a request to Chef Infra Server, they use a special group of HTTP headers and sign the rest with their private key. The Chef Infra Server then uses the public key to verify the headers and the contents.
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/chef_server.md

@@ -7,3 +7,5 @@ distributions. Chef Infra Client then does as much of the configuration
 work as possible on the nodes themselves (and not on the Chef Infra
 Server). This scalable approach distributes the configuration effort
 throughout the organization.
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/chef_server_component_bookshelf.md

@@ -4,4 +4,6 @@ cookbook version. Cookbook content is stored by content checksum. If two
 different cookbooks or different versions of the same cookbook include
 the same file or template, Bookshelf will store that file only once. The
 cookbook content managed by Bookshelf is stored in flat files and is
-separated from the Chef Infra Server and search index repositories.
+separated from the Chef Infra Server and search index repositories.
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/chef_server_component_elasticsearch.md

@@ -1 +1,4 @@
 chef-elasticsearch wraps Elastisearch and exposes its REST API for indexing and search.
+
+
+{{/* shortcode delete. Text moved to chef-server repo */}}

layouts/shortcodes/chef_server_component_erchef.md

@@ -18,3 +18,6 @@ Erlang is NOT a requirement for using Chef Infra.
 </div>
 
 </div>
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/chef_server_component_nginx.md

@@ -1,3 +1,5 @@
 Nginx is an open-source HTTP and reverse proxy server that is used as
 the front-end load balancer for the Chef Infra Server. All requests to
-the Chef Infra Server API are routed through Nginx.
+the Chef Infra Server API are routed through Nginx.
+
+{{/* shortcode delete. Text moved to chef-server repo */}}

layouts/shortcodes/chef_server_component_postgresql.md

@@ -1 +1,3 @@
-PostgreSQL is the data storage repository for the Chef Infra Server.
+PostgreSQL is the data storage repository for the Chef Infra Server.
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/config_add_condition.md

@@ -11,3 +11,6 @@ when 'frontend'
   # frontend-specific configuration here
 end
 ```
+
+
+{{/* shortcode delete. Text moved to chef-server repo */}}

layouts/shortcodes/config_ocid_application_hash_supermarket.md

@@ -7,3 +7,6 @@ oc_id['applications']['supermarket'] = {
   'redirect_uri' => 'https://supermarket.mycompany.com/auth/chef_oauth2/callback',
 }
 ```
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/config_rb_backend_summary.md

@@ -20,3 +20,6 @@ The following settings are the only settings you should modify without guidance:
 
 `publish_address`
 : Externally resolvable IP address of this back-end node.
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/config_rb_server_settings_ldap.md

@@ -191,3 +191,6 @@ This configuration file has the following settings for `ldap`:
 
     </div>
     </div>
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/config_rb_server_summary.md

@@ -5,4 +5,6 @@ only be added to the `chef-server.rb` file to apply non-default values.
 These configuration settings are processed when the
 `chef-server-ctl reconfigure` command is run. The `chef-server.rb` file
 is a Ruby file, which means that conditional statements can be used
-within it.
+within it.
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_backend_cleanse_options.md

@@ -3,4 +3,6 @@ This subcommand has the following options:
 `--with-external`
 
 :   Use to specify that data on an external PostgreSQL database should
-    be removed.
+    be removed.
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_backup.md

@@ -10,3 +10,6 @@ This subcommand:
     backup](https://github.com/chef/knife-ec-backup) instead
 - Puts the initial backup in the `/var/opt/chef-backup` directory as a
     tar.gz file; move this backup to a new location for safe keeping
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_backup_options.md

@@ -20,3 +20,6 @@ This subcommand has the following options:
 `-h`, `--help`
 
 :   Show help message.
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_backup_syntax.md

@@ -3,3 +3,6 @@ This subcommand has the following syntax:
 ```bash
 chef-server-ctl backup
 ```
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_hup.md

@@ -10,3 +10,6 @@ chef-server-ctl hup SERVICE_NAME
 
 where `SERVICE_NAME` represents the name of any service that is listed
 after running the `service-list` subcommand.
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_install_features_download.md

@@ -28,3 +28,5 @@ Finally, accept the [Chef License](https://docs.chef.io/chef_license/):
 ```bash
 sudo chef-manage-ctl reconfigure --accept-license
 ```
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_install_features_manual.md

@@ -12,3 +12,6 @@ sudo chef-server-ctl install chef-manage --path /root/packages
 
 The `chef-server-ctl` command will install the first `chef-manage`
 package found in the `/root/packages` directory.
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_int.md

@@ -10,3 +10,6 @@ chef-server-ctl int SERVICE_NAME
 
 where `SERVICE_NAME` represents the name of any service that is listed
 after running the `service-list` subcommand.
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_kill.md

@@ -10,3 +10,6 @@ chef-server-ctl kill SERVICE_NAME
 
 where `SERVICE_NAME` represents the name of any service that is listed
 after running the `service-list` subcommand.
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_once.md

@@ -18,3 +18,6 @@ chef-server-ctl once SERVICE_NAME
 
 where `SERVICE_NAME` represents the name of any service that is listed
 after running the `service-list` subcommand.
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org.md

@@ -1,2 +1,4 @@
 Use the `org-create`, `org-delete`, `org-list`, `org-show`,
-`org-user-add` and `org-user-remove` commands to manage organizations.
+`org-user-add` and `org-user-remove` commands to manage organizations.
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org_create.md

@@ -1,3 +1,5 @@
 The `org-create` subcommand is used to create an organization. (The
 validation key for the organization is returned to `STDOUT` when
-creating an organization with this command.)
+creating an organization with this command.)
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org_create_options.md

@@ -8,4 +8,6 @@ This subcommand has the following options:
 `-f FILE_NAME`, `--filename FILE_NAME`
 
 :   Write the ORGANIZATION-validator.pem to `FILE_NAME` instead of
-    printing it to `STDOUT`.
+    printing it to `STDOUT`.
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org_create_summary.md

@@ -24,3 +24,6 @@ An RSA private key is generated automatically. This is the
 chef-validator key and should be saved to a safe location. The
 `--filename` option will save the RSA private key to the specified
 absolute path.
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org_create_syntax.md

@@ -12,3 +12,6 @@ where:
 - The full name must begin with a non-white space character and must
     be between 1 and 1023 characters. For example:
     `"Chef Software, Inc."`.
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org_delete.md

@@ -1 +1,3 @@
-The `org-delete` subcommand is used to delete an organization.
+The `org-delete` subcommand is used to delete an organization.
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org_delete_syntax.md

@@ -3,3 +3,6 @@ This subcommand has the following syntax:
 ```bash
 chef-server-ctl org-delete ORG_NAME
 ```
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org_list.md

@@ -1,2 +1,4 @@
 The `org-list` subcommand is used to list all of the organizations
-currently present on the Chef Infra Server.
+currently present on the Chef Infra Server.
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org_list_options.md

@@ -6,4 +6,6 @@ This subcommand has the following options:
 
 `-w`, `--with-uri`
 
-:   Show the corresponding URIs.
+:   Show the corresponding URIs.
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org_list_syntax.md

@@ -3,3 +3,6 @@ This subcommand has the following syntax:
 ```bash
 chef-server-ctl org-list (options)
 ```
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org_show.md

@@ -1,2 +1,4 @@
 The `org-show` subcommand is used to show the details for an
-organization.
+organization.
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org_show_syntax.md

@@ -3,3 +3,6 @@ This subcommand has the following syntax:
 ```bash
 chef-server-ctl org-show ORG_NAME
 ```
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org_user_add.md

@@ -1 +1,3 @@
-The `org-user-add` subcommand is used to add a user to an organization.
+The `org-user-add` subcommand is used to add a user to an organization.
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org_user_add_options.md

@@ -2,4 +2,6 @@ This subcommand has the following options:
 
 `--admin`
 
-:   Add the user to the `admins` group.
+:   Add the user to the `admins` group.
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org_user_add_syntax.md

@@ -3,3 +3,6 @@ This subcommand has the following syntax:
 ```bash
 chef-server-ctl org-user-add ORG_NAME USER_NAME (options)
 ```
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org_user_remove.md

@@ -1,2 +1,4 @@
 The `org-user-remove` subcommand is used to remove a user from an
-organization.
+organization.
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_org_user_remove_syntax.md

@@ -3,3 +3,6 @@ This subcommand has the following syntax:
 ```bash
 chef-server-ctl org-user-remove ORG_NAME USER_NAME (options)
 ```
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_restart.md

@@ -28,3 +28,6 @@ successfully restarted the output should be similar to:
 ```bash
 ok: run: service_name: (pid 12345) 1s
 ```
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_restore.md

@@ -15,3 +15,6 @@ Ideally, the restore server will have the same FQDN as the server that you backe
 5. Update the `/etc/chef/client.rb` file on each client to point to the new server FQDN.
 6. Run `chef-server-ctl reconfigure`.
 7. Run ``chef-server-ctl restore`.
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_restore_options.md

@@ -23,3 +23,6 @@ This subcommand has the following options:
 `-h`, `--help`
 
 :   Show help message.
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_restore_syntax.md

@@ -3,3 +3,6 @@ This subcommand has the following syntax:
 ```bash
 chef-server-ctl restore PATH_TO_BACKUP (options)
 ```
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_server_admin.md

@@ -3,4 +3,6 @@ Membership of the `server-admins` group is managed with a set of
 
 - `chef-server-ctl grant-server-admin-permissions`
 - `chef-server-ctl list-server-admins`
-- `chef-server-ctl remove-server-admin-permissions`
+- `chef-server-ctl remove-server-admin-permissions`
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_server_admin_grant_user.md

@@ -23,3 +23,6 @@ User bob was added to server-admins. This user can now list,
 read, and create users (even for orgs they are not members of)
 for this Chef Infra Server.
 ```
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_server_admin_list.md

@@ -16,3 +16,6 @@ bob
 carol
 dan
 ```
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_server_admin_remove_user.md

@@ -24,3 +24,6 @@ User bob was removed from server-admins. This user can no longer
 list, read, and create users for this Chef Infra Server except for where
 they have default permissions (such as within an org).
 ```
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_service_list.md

@@ -6,3 +6,6 @@ This subcommand has the following syntax:
 ```bash
 chef-server-ctl service-list
 ```
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_start.md

@@ -25,3 +25,6 @@ unless they are failing to respond to the signals at all. If a process
 is not responding, use a command like the `kill` subcommand to stop the
 process, investigate the cause (if required), and then use the `start`
 subcommand to re-enable it.
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_status.md

@@ -50,3 +50,6 @@ run: oc-id
 run: opscode-chef: (pid 4327) 13671s; run: log: (pid 4326) 13671s
 run: opscode-erchef: (pid 5383) 5s; run: log: (pid 4382) 13669s
 ```
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_status_logs.md

@@ -31,3 +31,6 @@ where
 - `3s, normally up;` indicates that the service is normally in a run
     state and that the supervisor would attempt to restart this service
     after a reboot
+
+
+{{/* moved to chef-server repo */}}

layouts/shortcodes/ctl_chef_server_stop.md

@@ -32,3 +32,6 @@ ok: down: opscode-solr4: 389s, normally up
 ok: down: postgresql: 388s, normally up
 ok: down: redis_lb: 387s, normally up
 ```
+
+
+{{/* moved to chef-server repo */}}