diff --git a/docs/testing.md b/docs/testing.md deleted file mode 100644 index 4467caaae4e9db600d0b1aa266915ab59ca44b21..0000000000000000000000000000000000000000 --- a/docs/testing.md +++ /dev/null @@ -1,88 +0,0 @@ -# A testing guide and test reporting form for testers of the OpenAppStack project - -Great that you want to take OpenAppStack for a test drive. -This tutorial contains instructions to get you going, -some pointers on what we think would be useful to test, and guesses at what results of those tests would be -useful to write down. -At any point please feel invited to test whatever functionality you come across, and reporting whatever you -think is interesting. Our contact details are listed [here](https://openappstack.net/contact.html), and we'll -descibe how to give feedback via our issue tracker at the [end of these instructions](#providing-feedback). - -During these instructions, please replace *example.org* with your own domain -name. - -## Testing OAS installation - -First we'd like you to setup an OpenAppStack cluster by yourself, following the -[installation instructions](https://docs.openappstack.net/en/latest/installation.html). - -## Command line tests - -Please run the [command line tests](troubleshooting.md) which checks the overall -functionality of your cluster and include the output in your feedback. - -## Usability - -Please go through the [Usage documentation](./usage.md) and make sure you -complete all steps. - -## Testing Instructions for all apps - -Please login using single sign-on as `admin` and see if you have admin rights -granted (usually there's an app specific admin panel available or admin -functionality like configuring users). -Afterwards logout and login again as the non-admin single-sign-on user -you created earlier in the OAS admin panel. You should *not* have any admin -privileges now. - -## Testing Instructions for specific apps - -### Nextcloud - -#### Logging into Nextcloud - -Please browse to Nextcloud using the link from your user dashboard app list and -try to log in using single sign-on. Use the button labeled `Login with OpenAppStack`. -Please try logging in with your admin account and configure the email settings -as shown in the Usage doc. -After that please login with the user you created in the user panel. - -#### Nextcloud client application - -* If you like, please try the [Nextcloud desktop client](https://nextcloud.com/clients/), connect it to your OpenAppStack instance, and use it to manage some files. -* If you like, please try the [Nextcloud mobile client](https://nextcloud.com/clients/) for your smartphone, connect it to your OpenAppStack instance, and use it to download and/or open some files, upload a new file, etc. - - -### Onlyoffice - -#### Creating a new office document - -From the main Nextcloud webpage, please try to create a new office document, by clicking the round `plus` button near the top of the screen, then picking the `Document` type with the blue icon (third one from below on my screen), and enter a name for it. After that, please try some basic editing of the document, and save it. Maybe check you can open it again afterwards, and that it has the contents that you saved earlier. - -#### Collaborating on an office document - -This part of the test requires the cooperation of another person; feel free to skip it now if that's not convenient at this point. - -* First, try to share your document with a different user. -* Then, try to open the shared document from a few different user accounts simultaneously, and let all participants edit the document mercilessly. - There are also some collaboration features that you may want to try: on the left of the Onlyoffice screen there are buttons for chat and for text comments. - - -### Wordpress - -Please try to login as the new user you created earlier by pressing "Log in" and -using the `Login with OpenID Connect` button. - -At the moment Administrator privileges will not be available for single sign-on -users of WordPress. You can sign in with the automatically created administrator -account. The username is `admin` and the password can be found in the -`wordpress_admin_password` file in the `secrets` folder of your provisioning -machine's config directory. - - -## Providing feedback - -If you have not done so already, please create an account on [https://open.greenhost.net](https://open.greenhost.net) -(or login with your existing github account) and [create a new issue](https://open.greenhost.net/openappstack/openappstack/issues/new) using the `Feedback` template. - -Thanks a lot for your testing work! We'll use your input to try to improve OpenAppStack. diff --git a/docs/testing.rst b/docs/testing.rst new file mode 100644 index 0000000000000000000000000000000000000000..f230dfdbb43f1e9dd4ed972770b27cc7e5cfc640 --- /dev/null +++ b/docs/testing.rst @@ -0,0 +1,121 @@ +A testing guide and test reporting form for testers of the OpenAppStack project +=============================================================================== + +Great that you want to take OpenAppStack for a test drive. This tutorial +contains instructions to get you going, some pointers on what we think +would be useful to test, and guesses at what results of those tests +would be useful to write down. At any point please feel invited to test +whatever functionality you come across, and reporting whatever you think +is interesting. Our contact details are listed +`here <https://openappstack.net/contact.html>`__, and we’ll descibe how +to give feedback via our issue tracker at the `end of these +instructions <#providing-feedback>`__. + +During these instructions, please replace *example.org* with your own +domain name. + +Testing OAS installation +------------------------ + +First we’d like you to setup an OpenAppStack cluster by yourself, +following the `installation +instructions <https://docs.openappstack.net/en/latest/installation.html>`__. + +Command line tests +------------------ + +Please run the `command line tests <troubleshooting.md>`__ which checks +the overall functionality of your cluster and include the output in your +feedback. + +Usability +--------- + +Please go through the `Usage documentation <./usage.md>`__ and make sure +you complete all steps. + +Testing Instructions for all apps +--------------------------------- + +Please login using single sign-on as ``admin`` and see if you have admin +rights granted (usually there’s an app specific admin panel available or +admin functionality like configuring users). Afterwards logout and login +again as the non-admin single-sign-on user you created earlier in the +OAS admin panel. You should *not* have any admin privileges now. + +Testing Instructions for specific apps +-------------------------------------- + +Nextcloud +~~~~~~~~~ + +Logging into Nextcloud +^^^^^^^^^^^^^^^^^^^^^^ + +Please browse to Nextcloud using the link from your user dashboard app +list and try to log in using single sign-on. Use the button labeled +``Login with OpenAppStack``. Please try logging in with your admin +account and configure the email settings as shown in the Usage doc. +After that please login with the user you created in the user panel. + +Nextcloud client application +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +- If you like, please try the `Nextcloud desktop + client <https://nextcloud.com/clients/>`__, connect it to your + OpenAppStack instance, and use it to manage some files. +- If you like, please try the `Nextcloud mobile + client <https://nextcloud.com/clients/>`__ for your smartphone, + connect it to your OpenAppStack instance, and use it to download + and/or open some files, upload a new file, etc. + +Onlyoffice +~~~~~~~~~~ + +Creating a new office document +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +From the main Nextcloud webpage, please try to create a new office +document, by clicking the round ``plus`` button near the top of the +screen, then picking the ``Document`` type with the blue icon (third one +from below on my screen), and enter a name for it. After that, please +try some basic editing of the document, and save it. Maybe check you can +open it again afterwards, and that it has the contents that you saved +earlier. + +Collaborating on an office document +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This part of the test requires the cooperation of another person; feel +free to skip it now if that’s not convenient at this point. + +- First, try to share your document with a different user. +- Then, try to open the shared document from a few different user + accounts simultaneously, and let all participants edit the document + mercilessly. There are also some collaboration features that you may + want to try: on the left of the Onlyoffice screen there are buttons + for chat and for text comments. + +Wordpress +~~~~~~~~~ + +Please try to login as the new user you created earlier by pressing “Log +in†and using the ``Login with OpenID Connect`` button. + +At the moment Administrator privileges will not be available for single +sign-on users of WordPress. You can sign in with the automatically +created administrator account. The username is ``admin`` and the +password can be found in the ``wordpress_admin_password`` file in the +``secrets`` folder of your provisioning machine’s config directory. + +Providing feedback +------------------ + +If you have not done so already, please create an account on +https://open.greenhost.net (or login with your existing github account) +and `create a new +issue <https://open.greenhost.net/openappstack/openappstack/issues/new>`__ +using the ``Feedback`` template. + +Thanks a lot for your testing work! We’ll use your input to try to +improve OpenAppStack.