Plugin Directory

Changeset 2567559


Ignore:
Timestamp:
07/19/2021 07:09:15 PM (5 years ago)
Author:
Designed4Pixels
Message:

updated and added quick guides

Location:
wp-cloud-server/trunk/includes/admin/dashboard/config/templates/guides
Files:
1 added
3 edited

Legend:

Unmodified
Added
Removed
  • wp-cloud-server/trunk/includes/admin/dashboard/config/templates/guides/guide-cloud-servers.php

    r2433251 r2567559  
    44?>
    55
    6 <p><?php _e('The \'Cloud Servers\' section allows you to manage your cloud servers using a straightforward and easy to use control panel. This section allows you to manually create \'vanilla\' servers which can be customised using your own startup scripts. The \'Servers\' tab provides a list of all servers created, each server listed has a link which opens a server management page where servers can be restarted, powered on and off, and even deleted.', 'wp-cloud-server'); ?></p> 
     6<p><?php _e('The \'Cloud Servers\' section allows you to manage your cloud servers using a straightforward and easy to use control panel. The admin menu will give you access to a self-contained control panel for each cloud provider that you have active.', 'wp-cloud-server'); ?></p> 
    77   
    8 <h2><?php _e('Selling Hosting Plans with WooCommerce or Easy Digital Downloads', 'wp-cloud-server'); ?></h2>
    9 <p><?php _e('Support for \'WooCommerce\' and \'Easy Digital Downloads\' is built-in to the \'WP Cloud Server\' plugin. If you have either of these powerful eCommerce plugins installed then you will see some additional tabs automatically added, including \'Templates\', \'+ Add Template\', and \'Client Details\', as well as new menu items that allow hostnames to be configured and shortcodes configured.', 'wp-cloud-server'); ?></p>
     8<h2><?php _e('Dynamic Admin Menus', 'wp-cloud-server'); ?></h2>
     9<p><?php _e('For example, if you just have the \'DigitalOcean\' module activated then the \'Cloud Servers\' menu will take you straight to the DigitalOcean control panel. But if you have activated \'DigitalOcean\' and \'Vultr\' then you will see these listed in a sub-menu.', 'wp-cloud-server'); ?></p>
     10<p><?php _e('The built-in cloud provider modules include DigitalOcean, Vultr, Linode, UpCloud, and AWS Lightsail. Having them all activated will display them all in the \'Cloud Servers\' menu.', 'wp-cloud-server'); ?></p>
     11<p><?php _e('If you are using other modules and don\'t need any cloud providers for your use case, and have deactivated them all, then the \'Cloud Servers\' menu will be hidden!', 'wp-cloud-server'); ?></p>
    1012
    11 <h3><?php _e('Hostname Settings', 'wp-cloud-server'); ?></h3>
    12 <p>
    13 <?php _e('When selling cloud servers you need to provide a hostname for each server. You have two options. The first is to have no hostname rules configured which results in the customer being asked to enter a hostname during the checkout process, or configure a generic hostname which has an integer number added as a suffix. When a server is sold and automatically provisioned this suffix is incremented.', 'wp-cloud-server'); ?></p>
     13<h2><?php _e('Cloud Provider Control Panel', 'wp-cloud-server'); ?></h2>
     14<p><?php _e('You are likely viewing this page having clicked the \'Support Guide\' menu in a Cloud Provider control panel. We will assume that this is one of the first menu links that you have clicked, so we will give you an overview of all functionality.', 'wp-cloud-server'); ?></p>
    1415
    15 <h3><?php _e('Client Details Shortcode', 'wp-cloud-server'); ?></p></h3>
    16 <p><?php _e('This section allows you to configure the customer data that is displayed to your clients. Like all shortcodes you can then add it to any page on your website and give access to clients.', 'wp-cloud-server'); ?></p>
     16<h2><?php _e('Main Menu', 'wp-cloud-server'); ?></h2>
     17<p><?php _e('Each Cloud Provider offers different services that are acessible from the main menu in the control panel. Even though the menu items vary we have attempted to keep the same grouping. You should see menu blocks labelled as \'Manage\', \'Settings\', and \'Support\'. If you have either \'WooCommerce\' or \'Easy Digital Downloads\' plugins installed and activated then you will also see a \'Hosting\' menu.', 'wp-cloud-server'); ?></p>
     18<p><?php _e('Let\'s start by looking at each menu in turn.', 'wp-cloud-server'); ?></p>
    1719
    18 <h3><?php _e('Website Hosting Plan Templates', 'wp-cloud-server'); ?></h3>
     20<h3><?php _e('Manage Menu', 'wp-cloud-server'); ?></h3>
     21<p><?php _e('This menu gives access to the server management pages for the Cloud Provider. This menu will vary depending on the provider being used. The menu links will as close as possible mimic the options in the Cloud Providers own dashboard, and as such will include options like \'Servers\'. \'Networking\', \'Volumes\', \'Backups\', etc.', 'wp-cloud-server'); ?></p>
     22<p><?php _e('Each page opened from this menu will default to a summary page displaying a list of exisitng services, such as servers, volumes, etc. If we have implemented the ability to \'Add\' a service, then you will see a tab indicating this. So for manually creating a server you will see a tab labelled \'+ Add Server\'.', 'wp-cloud-server'); ?></p>
     23<p><?php _e('In the summary view you will see details of the service e.g. server name, id, status. At the end of each row is a manage link which if clicked will open a pop-up modal providing full management capabilities for that service. Taking servers as an example this will include deleting a server, rebooting, powering down or up, and much more. Each release of the plugin will see more features added.', 'wp-cloud-server'); ?></p>
     24
     25<h3><?php _e('Settings Menu', 'wp-cloud-server'); ?></h3>
     26<p><?php _e('This menu is for managing useful resources. The items saved here are available across all of the Cloud Providers. The menu options are \'SSH Keys\' and \'Startup Scripts\'. These are probably pretty self explanatory.', 'wp-cloud-server'); ?></p>
     27<p><?php _e('The \'SSH Keys\' page allows you to view and save public SSH Keys. When creating templates or deploying a cloud server manually you can select an SSH Key to install on the server.', 'wp-cloud-server'); ?></p>
     28<p><?php _e('The \'Startup Script\' page allows you to view, save and edit startup scripts. These can be bash scripts or cloud-init scripts that are uploaded to the server during creation and are executed during first boot.', 'wp-cloud-server'); ?></p>
     29<p><?php _e('Once again if you have \'WooCommerce\' or \'EDD\' activated you will see another menu item called \'Hostnames\'. This setting is currently only used when creating templates for selling web hosting plans. It allows you to create a dynamic hostname that can have an integer incremented as each server is deployed. You can even set a domain name, the protocol, and a port e.g. 8443 for users to login to their server with!', 'wp-cloud-server'); ?></p>
     30
     31<h3><?php _e('Support Menu', 'wp-cloud-server'); ?></h3>
     32<p><?php _e('We\'ll mention this menu item for completeness! But it takes you here, to this page, so you already know this one. I will say though that if you\'ve read this page, and understand it\'s content, you can hide it through the \'General Settings\' menu.', 'wp-cloud-server'); ?></p>
     33
     34<h3><?php _e('Hosting Menu', 'wp-cloud-server'); ?></h3>
     35<p><?php _e('This menu is displayed if you have \'WooCommerce\' or \'Easy Digital Downloads\' activated. It has two menu options, \'Templates\' and \'Clients\'.', 'wp-cloud-server'); ?></p>
     36
     37<h4><?php _e('Templates', 'wp-cloud-server'); ?></h4>
    1938<p><?php _e('\'Templates\' are a very powerful feature built-in to the plugin. A \'Template\' is a way of grouping together a set of server features that can be selected inside a \'WooCommerce\' or \'Easy Digital Downloads\' product page, and can then be sold to clients or customers. When a server hosting plan is sold and payment has been confirmed the \'Template\' is used to automatically create the server. Features like SSH Keys, startup scripts, server backups can all be selected.', 'wp-cloud-server'); ?></p>
    20 <p><?php _e('You can create any number of \'Templates\' and view them in the \'Templates\' tab, where you can manage and delete templates. Each \'Templates\' row includes a \'Sites\' field that shows how many web sites have been created using the template.', 'wp-cloud-server'); ?></p>
     39<p><?php _e('You can create any number of \'Templates\' and view them in the \'Templates\' page via the \'Hosting\' menu, where you can manage and delete templates. Each \'Templates\' row includes a \'Sites\' field that shows how many web sites have been created using the template.', 'wp-cloud-server'); ?></p>
    2140
    22 <h3><?php _e('Client Details', 'wp-cloud-server'); ?></h3>
    23 <p><?php _e('The final tab called \'Clients\' links customers details to hosting plans, so that you can see at a glance which clients have what hosting plans.', 'wp-cloud-server'); ?></p>
    24 
     41<h4><?php _e('Clients', 'wp-cloud-server'); ?></h4>
     42<p><?php _e('The final menu item is called \'Clients\' and links customers details to hosting plans, so that you can see at a glance which clients have what hosting plans. This is basic at the moment but we have massive plans for this in the future!', 'wp-cloud-server'); ?></p>
  • wp-cloud-server/trunk/includes/admin/dashboard/config/templates/guides/guide-managed-servers.php

    r2433251 r2567559  
    44?>
    55
    6 <p><?php _e('The \'Managed Servers\' section allows you to manage your cloud servers using a server management service. The FREE version of the plugin allows connection to ServerPilot, allowing new servers to be connected and WordPress websites to be installed and configured.', 'wp-cloud-server'); ?></p>
    7 <p><?php _e('If you have another favourite service such as RunCloud or Ploi, or even Laravel Forge, then these can be added as add-on modules! These can be purchased from our the project webnsite and installed just like any other WordPress plugin.', 'wp-cloud-server'); ?></p>
     6<p><?php _e('The \'Managed Servers\' section allows you to manage your cloud servers using a server management service. The FREE version of the plugin allows connection to ServerPilot, RunCloud, or Ploi, allowing new servers to be connected and applications to be installed and configured.', 'wp-cloud-server'); ?></p>
    87
    9 <h2><?php _e('Server Management', 'wp-cloud-server'); ?></h2>
    10 <p><?php _e('The \'Server Management\' menu will list all of the available services. Having just installed the \'WP Cloud Server\' plugin, and with both default modules activated, it will list \'ServerPilot\' as the default option. Clicking this menu option will display a page with tabbed options. This is where you can view all of the services provided by the \'ServerPilot\' module. The \'Websites\' and \'Servers\' tabs list all of the websites or servers already installed. Whereas the options starting with \'+ Add ...\' are where you can manually connect new servers and install new websites.', 'wp-cloud-server'); ?></p>
    11 <p><?php _e('Where possible the plugin will automate all aspects of connecting a new server to your favourite service. With ServerPilot a new server needs to be created first and then connected to ServerPilot to install the server software and install WordPress.', 'wp-cloud-server'); ?></p>
    12 <p><?php _e('The following steps happen in the background without you having to worry!', 'wp-cloud-server'); ?></p>
    13 <ol>
    14     <li><?php _e('Notify ServerPilot that a new server is being connected and provide it\'s name.', 'wp-cloud-server'); ?></li>
    15     <li><?php _e('Create a new server with DigitalOcean, or another cloud provider.', 'wp-cloud-server'); ?></li>
    16     <li><?php _e('Automatically installs the ServerPilot install agent to let ServerPilot work it\'s magic', 'wp-cloud-server'); ?></li>
    17 </ol>
     8<h2><?php _e('Dynamic Admin Menus', 'wp-cloud-server'); ?></h2>
    189
    19 <h2><?php _e('Selling Hosting Plans with WooCommerce or Easy Digital Downloads', 'wp-cloud-server'); ?></h2>
    20 <p><?php _e("Support for 'WooCommerce' and 'Easy Digital Downloads' is built-in to the \'WP Cloud Server\' plugin. If you have either of these powerful eCommerce plugins installed then you will see some additional tabs automatically added, including 'Templates', '+ Add Template', and 'Client Details'.
    21 ", 'wp-cloud-server'); ?></p>
     10<p><?php _e('For example, if you just have the \'ServerPilot\' module activated then the \'Managed Servers\' menu will take you straight to the ServerPilot control panel. But if you have activated \'ServerPilot\' and \'RunCloud\' then you will see these listed in a sub-menu.', 'wp-cloud-server'); ?></p>
    2211
    23 <h3><?php _e('Website Hosting Plan Templates', 'wp-cloud-server'); ?></h3>
    24 <p><?php _e('\'Templates\' are a very powerful feature built-in to the plugin. A \'Template\' is a way of grouping together a set of server or website features that can be selected inside a \'WooCommerce\' or \'Easy Digital Downloads\' product page, and can then be sold to clients or customers. When a web hosting plan is sold and payment has been confirmed the \'Template\' is used to automatically create the server and webiste.
    25 ', 'wp-cloud-server'); ?></p>
    26 <p><?php _e('You can create any number of \'Templates\' and view them in the \'Templates\' tab, where you can manage and delete templates. Each \'Templates\' row includes a \'Sites\' field that shows how many web sites have been created using the template.', 'wp-cloud-server'); ?></p>
    27 <h3><?php _e('Client Details', 'wp-cloud-server'); ?></h3>
    28 <p><?php _e('The final tab called \'Clients\' links customers details to hosting plans, so that you can see at a glance which clients have what hosting plans.', 'wp-cloud-server'); ?></p>
     12<p><?php _e('If you are using other modules and don\'t need any cloud providers for your use case, and have deactivated them all, then the \'Managed Servers\' menu will be hidden!', 'wp-cloud-server'); ?></p>
    2913
     14<h2><?php _e('Server Management Control Panel', 'wp-cloud-server'); ?></h2>
     15
     16<p><?php _e('You are likely viewing this page having clicked the support menu \'Quick Guide\' menu in a Server Management control panel. We will assume that this is one of the first menu links that you have clicked, so we will give you an overview of all functionality.', 'wp-cloud-server'); ?></p>
     17
     18<h2><?php _e('Main Menu', 'wp-cloud-server'); ?></h2>
     19
     20<p><?php _e('Each Server Management service offers different services that are acessible from the main menu in the control panel. Even though the menu items vary we have attempted to keep the same grouping. You should see menu blocks labelled as \'Manage\', \'Settings\', and \'Support\'. If you have either \'WooCommerce\' or \'Easy Digital Downloads\' plugins installed and activated then you will also see a \'Hosting\' menu.', 'wp-cloud-server'); ?></p>
     21
     22<p><?php _e('Let\'s start by looking at each menu in turn.', 'wp-cloud-server'); ?></p>
     23
     24<h3><?php _e('Manage Menu', 'wp-cloud-server'); ?></h3>
     25
     26<p><?php _e('This menu gives access to the server admin pages for the server management provider. This menu will vary depending on the service being used. The menu links will as close as possible mimic the options in the Cloud Providers own dashboard, and as such will include options like \'Apps\'. \'Databases\', \'mojitoring\', etc.', 'wp-cloud-server'); ?></p>
     27
     28<p><?php _e('Each page opened from this menu will default to a summary page displaying a list of exisitng services, such as servers, etc. If we have implemented the ability to \'Add\' a service, then you will see a tab indicating this. So for manually connecting a server you will see a tab labelled \'+ Add Server\'.', 'wp-cloud-server'); ?></p>
     29
     30<p><?php _e('The power of the \'Managed Server\' function is the automation. You can select a cloud provider and the configuration for the server management service, and when you click \'Create Server\' everything is deployed automatically.', 'wp-cloud-server'); ?></p>
     31
     32<p><?php _e('If you selected \'DigitalOcean\' as the cloud provider and \'ServerPilot\' for server management then the plugin will notify ServerPIlot that a new server is being connected. It will then automatically deploy the DigitalOcean server and launch the ServerPilot install script which connects to ServerPilot to install the server software and WordPress. No stress and no hassle!', 'wp-cloud-server'); ?></p>
     33
     34<p><?php _e('In the summary view you will see details of the service e.g. server name, id, status. At the end of each row is a manage link which if clicked will open a pop-up modal providing full management capabilities for that service. Taking servers as an example this will include deleting a server, and much more. Each release of the plugin will see more features added.', 'wp-cloud-server'); ?></p>
     35
     36<h3><?php _e('Settings Menu', 'wp-cloud-server'); ?></h3>
     37
     38<p><?php _e('This menu is for managing useful resources. The items saved here are available across all of the Server Management Providers. The menu options are \'SSH Keys\' and \'Startup Scripts\'. These are probably pretty self explanatory.', 'wp-cloud-server'); ?></p>
     39
     40<p><?php _e('The \'SSH Keys\' page allows you to view and save public SSH Keys. When creating templates or deploying a cloud server manually you can select an SSH Key to install on the server.', 'wp-cloud-server'); ?></p>
     41
     42<p><?php _e('The \'Startup Script\' page allows you to view, save and edit startup scripts. These can be bash scripts or cloud-init scripts that are uploaded to the server during creation and are executed during first boot.', 'wp-cloud-server'); ?></p>
     43
     44<p><?php _e('Once again if you have \'WooCommerce\' or \'EDD\' activated you will see another menu item called \'Hostnames\'. This setting is currently only used when creating templates for selling web hosting plans. It allows you to create a dynamic hostname that can have an integer incremented as each server is deployed. You can even set a domain name, the protocol, and a port e.g. 8443 for users to login to their server with!', 'wp-cloud-server'); ?></p>
     45
     46<h3><?php _e('Support Menu', 'wp-cloud-server'); ?></h3>
     47
     48<p><?php _e('We\'ll mention this menu item for completeness! But it takes you here, to this page, so you already know this one. I will say though that if you\'ve read this page, and understand it\'s content, you can hide it through the \'General Settings\' menu.', 'wp-cloud-server'); ?></p>
     49
     50<h3><?php _e('Hosting Menu', 'wp-cloud-server'); ?></h3>
     51
     52<p><?php _e('This menu is displayed if you have \'WooCommerce\' or \'Easy Digital Downloads\' activated. It has two menu options, \'Templates\' and \'Clients\'.', 'wp-cloud-server'); ?></p>
     53
     54<h4><?php _e('Website Hosting Plan Templates', 'wp-cloud-server'); ?></h4>
     55
     56<p><?php _e('\'Templates\' are a very powerful feature built-in to the plugin. A \'Template\' is a way of grouping together a set of server features that can be selected inside a \'WooCommerce\' or \'Easy Digital Downloads\' product page, and can then be sold to clients or customers. When a server hosting plan is sold and payment has been confirmed the \'Template\' is used to automatically create the server. Features like SSH Keys, startup scripts, server backups can all be selected.', 'wp-cloud-server'); ?></p>
     57
     58<p><?php _e('You can create any number of \'Templates\' and view them in the \'Templates\' page via the \'Hosting\' menu, where you can manage and delete templates. Each \'Templates\' row includes a \'Sites\' field that shows how many web sites have been created using the template.', 'wp-cloud-server'); ?></p>
     59
     60<h4><?php _e('Client Details', 'wp-cloud-server'); ?></h4>
     61
     62<p><?php _e('The final menu item is called \'Clients\' and links customers details to hosting plans, so that you can see at a glance which clients have what hosting plans. This is basic at the moment but we have massive plans for this in the future!', 'wp-cloud-server'); ?></p>
  • wp-cloud-server/trunk/includes/admin/dashboard/config/templates/guides/guide-module-overview.php

    r2433251 r2567559  
    44?>
    55
    6 <p><?php _e('The \'Module Overview\' section provides a view of the modules that are available for use with the plugin. The standard FREE plugin, if used standalone, has two modules built-in, ServerPilot and DigitalOcean. Additional modules can be installed including cloud providers and web services that will also be visible in this section.', 'wp-cloud-server' ); ?></p>
     6<p><?php _e('The \'Module Overview\' section provides a view of the modules that are available for use with the plugin. The standard FREE plugin, if used standalone, has 8 modules built-in including, DigitalOcean, Vultr, Linode, UpCloud, AWS Lightsail, ServerPilot, RunCloud, and Cloudways. Additional add-on modules can be installed including cloud providers and web services that will also be visible in this section.', 'wp-cloud-server' ); ?></p>
    77
    88<h2><?php _e('Installed Modules', 'wp-cloud-server' ); ?></h2>
    9 <p><?php _e( 'The \'Installed Modules\' menu option, the default view, lists all of the modules installed and gives an easy to understand overview of what services are avaialble, what modules are active, and whether the API connection is valid.', 'wp-cloud-server' ); ?></p>
     9<p><?php _e( 'The \'Installed Modules\' menu option, the default view, lists all of the modules installed and gives an easy to understand overview of what services are avaialble, what modules are active, and whether the API connections are valid.', 'wp-cloud-server' ); ?></p>
    1010<p><?php _e( 'If a service is active and you don\'t need it then the \'deactivate\' option will remove the module from all menus and drop-down lists, etc. Note though that deactivating some modules may result in error messages if, for example, no cloud provider module is active but is required. Also some services will disappear from menus, etc.', 'wp-cloud-server' ); ?></p>
    1111
    1212<h2><?php _e('Modules', 'wp-cloud-server' ); ?></h2>
    13 <p><?php _e( 'The \'Modules\' menu option, lists all active modules. Clicking on a modules name will take you to the \'Settings\' page for that module which allows API credentials to be managed, event logs to be viewed, and, if enabled, the debug tab to be available which shows API messages and the status of the various queues.', 'wp-cloud-server'); ?></p>
     13<p><?php _e( 'The \'Modules\' menu, lists all active modules. Clicking on a modules name will take you to the \'Settings\' page for that module which allows API credentials to be managed, there are tabs for event logs, and, if enabled, the debug tab, which provides visibility of API responses for the module and queues.', 'wp-cloud-server'); ?></p>
Note: See TracChangeset for help on using the changeset viewer.