Documentation improvements - remove outdated information and improve some areas #19881
Conversation
| with the ``/public/setup`` suffix. The changes are not saved to the server, you need to | ||
| use the :guilabel:`Download` button to save them to your computer and then upload | ||
| to the server. | ||
|
|
||
| Now the file is ready to be used. You can choose to review or edit the | ||
| file with your favorite editor, if you prefer to set some advanced | ||
| options that the setup script does not provide. | ||
|
|
||
| #. If you are using the ``auth_type`` "config", it is suggested that you | ||
| protect the phpMyAdmin installation directory because using config | ||
| does not require a user to enter a password to access the phpMyAdmin | ||
| installation. Use of an alternate authentication method is | ||
| recommended, for example with HTTP–AUTH in a :term:`.htaccess` file or switch to using | ||
| ``auth_type`` cookie or http. See the :ref:`faqmultiuser` | ||
| for additional information, especially :ref:`faq4_4`. | ||
| #. Open the main phpMyAdmin directory in your browser. | ||
| phpMyAdmin should now display a welcome screen and your databases, or | ||
| a login dialog if using :term:`HTTP` or | ||
| cookie authentication mode. | ||
|
|
||
| .. _debian-setup: | ||
|
|
||
| Setup script on Debian, Ubuntu and derivatives | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Debian and Ubuntu have changed the way in which the setup script is enabled and disabled, in a way | ||
| that single command has to be executed for either of these. | ||
|
|
||
| To allow editing configuration invoke: | ||
|
|
||
| .. code-block:: sh | ||
| /usr/sbin/pma-configure | ||
| To block editing configuration invoke: | ||
|
|
||
| .. code-block:: sh | ||
| /usr/sbin/pma-secure | ||
| Setup script on openSUSE | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Some openSUSE releases do not include setup script in the package. In case you | ||
| want to generate configuration on these you can either download original | ||
| package from <https://www.phpmyadmin.net/> or use setup script on our demo | ||
| server: <https://demo.phpmyadmin.net/master/setup/>. | ||
| server: <https://demo.phpmyadmin.net/master/public/setup/>. |
There was a problem hiding this comment.
This is on my long todo list, for 6.0 we should avise users to use public as the root.
As should the demo server
| with the ``/setup`` suffix. The changes are not saved to the server, you need to | |
| use the :guilabel:`Download` button to save them to your computer and then upload | |
| to the server. | |
| @@ -787,7 +787,7 @@ Setup script on openSUSE | |
| Some openSUSE releases do not include setup script in the package. In case you | |
| want to generate configuration on these you can either download original | |
| package from <https://www.phpmyadmin.net/> or use setup script on our demo | |
| server: <https://demo.phpmyadmin.net/master/setup/>. |
This comment was marked as off-topic.
This comment was marked as off-topic.
|
|
||
| Next, open your browser and visit the location where you installed phpMyAdmin, | ||
| with the ``/setup`` suffix. The changes are not saved to the server, you need to | ||
| with the ``/public/setup`` suffix. The changes are not saved to the server, you need to |
There was a problem hiding this comment.
They should not have public in the path, else it means the public prefix root was not well deployed
There was a problem hiding this comment.
I think that this is the current behavior of both my system and the demo server, is that incorrect?
There was a problem hiding this comment.
yes, but it is a webserver configuration issue
We should make sure our users understand the public folder should be the root
| is probably the best choice for shared hosting. | ||
| * Deny access to auxiliary files in :file:`./libraries/` or | ||
| :file:`./templates/` subfolders in your webserver configuration. | ||
| * Deny access to auxiliary files in :file:`libraries/` or |
There was a problem hiding this comment.
They did not configure the server to have public as the root
red flag
There was a problem hiding this comment.
Should we change this section, then?
There was a problem hiding this comment.
We can keep this section to list all folders to deny access for, if users are not able to some reason to set the root folder to public/
Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
|
Thanks for the great feedback. I've incorporated most of your comments in e844625 which I just pushed along with some other work that's in progress. |
* Remove old references * Remove "added in" or "new in" if it's quite an old feature * Some language improvements Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
… improve unnecessary automatic smart quotes. Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
ibennetch
changed the title
|
I think this is ready to go except I think we should decide how to handle the phpmyadmin/setup vs phpmyadmin/public/setup section from #19881 (review). I believe what I've written here matches the current behavior, so if that's true my suggestion is to improve/fix the suggestion to remove the /public/ part in another commit. |
Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
…les exist Fixes phpmyadmin#15777 Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
4 participants
Description
There are a lot of places where we reference when a feature was introduced, especially in the 2.x versions. I think it's unnecessary, adds extra length to the documentation, and sometimes makes us look outdated (because of references to something from 2010 as "new").
I'm working on removing those in preparation of the 6.0 release, but before I put a lot of work in to it wanted to show a sample of what's in progress to make sure everyone is in agreement about this change.
For example, here or here.
This is just a draft right now.
Before submitting pull request, please review the following checklist:
Signed-off-byline as described in our DCO. This ensures that the work you're submitting is your own creation.