Move doc directory to docs

- Fixes #18512

Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>

.github/workflows/other-tools.yml

@@ -27,7 +27,7 @@ jobs:
         run: pip install 'Sphinx'
 
       - name: Build the documentation
-        run: make -C doc html SPHINXOPTS='-n -W -a'
+        run: make -C docs html SPHINXOPTS='-n -W -a'
 
   build-release:
     runs-on: ubuntu-latest

.gitignore

@@ -36,7 +36,7 @@ web.config
 *~
 # API documentation
 /apidoc/
-/doc/linkcheck/
+/docs/linkcheck/
 # Demo server
 revision-info.php
 # PHP_CodeSniffer

README

@@ -12,7 +12,7 @@ Summary
 
 phpMyAdmin is intended to handle the administration of MySQL over the web.
 For a summary of features, list of requirements, and installation instructions,
-please see the documentation in the ./doc/ folder or at https://docs.phpmyadmin.net/
+please see the documentation in the ./docs/ folder or at https://docs.phpmyadmin.net/
 
 Copyright
 ---------
@@ -22,7 +22,7 @@ Copyright © 1998 onwards -- the phpMyAdmin team
 Certain libraries are copyrighted by their respective authors;
 see the full copyright list for details.
 
-For full copyright information, please see ./doc/copyright.rst
+For full copyright information, please see ./docs/copyright.rst
 
 License
 -------

README.rst

@@ -63,7 +63,7 @@ Please see `the documentation <https://docs.phpmyadmin.net/en/latest/setup.html#
 More Information
 ----------------
 
-Please see https://docs.phpmyadmin.net/, or browse the documentation in the doc folder.
+Please see https://docs.phpmyadmin.net/, or browse the documentation in the docs folder.
 
 For `support <https://www.phpmyadmin.net/support/>`_ or `security issues, <https://www.phpmyadmin.net/security/>`_ you can visit https://www.phpmyadmin.net/
 

bin/internal/check-release-excludes.sh

@@ -36,7 +36,7 @@ validateExtension() {
     extension="${filename##*.}"
 
     case $pathWithoutFirst in
-        doc/*)
+        docs/*)
             if [ "${extension}" != "png" ] && [ "${extension}" != "txt" ] &&
                 [ "${extension}" != "html" ] && [ "${extension}" != "js" ] &&
                 [ "${extension}" != "css" ] && [ "${extension}" != "gif" ]; then

bin/internal/create-release.sh

@@ -381,7 +381,7 @@ Please ensure you have incremented rc count or version in the repository :
      - run ./bin/console set-version $version
      - in $VERSION_FILE Version class:
         - check that VERSION, MAJOR, MINOR and PATCH are correct.
-     - in doc/conf.py the line
+     - in docs/conf.py the line
           " version = '$version' "
      - in README the "Version" line
      - in package.json the line
@@ -437,8 +437,8 @@ if [ $do_ci -eq 0 ] && [ -$do_daily -eq 0 ] ; then
         echo "There seems to be wrong version in $VERSION_FILE!"
         exit 2
     fi
-    if ! grep -q "version = '$version'" doc/conf.py ; then
-        echo "There seems to be wrong version in doc/conf.py"
+    if ! grep -q "version = '$version'" docs/conf.py ; then
+        echo "There seems to be wrong version in docs/conf.py"
         exit 2
     fi
     if ! grep -q "Version $version\$" README ; then
@@ -461,8 +461,8 @@ fi
 # Building documentation
 echo "* Running sphinx-build (version: $(sphinx-build --version))"
 echo "* Generating documentation"
-LC_ALL=C make -C doc html
-find doc -name '*.pyc' -print0 | xargs -0 -r rm -f
+LC_ALL=C make -C docs html
+find docs -name '*.pyc' -print0 | xargs -0 -r rm -f
 
 # Check for gettext support
 if [ -d resources/po ] ; then
@@ -614,11 +614,11 @@ for kit in $KITS ; do
         # Gettext po files (if they were not removed by ./bin/internal/lang-cleanup.sh)
         rm -rf resources/po
         # Documentation source code
-        mv doc/html htmldoc
-        rm -r doc
-        mkdir doc
-        mv htmldoc doc/html
-        rm doc/html/.buildinfo doc/html/objects.inv
+        mv docs/html htmldoc
+        rm -r docs
+        mkdir docs
+        mv htmldoc docs/html
+        rm docs/html/.buildinfo docs/html/objects.inv
         rm -r node_modules
         # Remove bin files for non source version
         # https://github.com/phpmyadmin/phpmyadmin/issues/16033
@@ -755,7 +755,7 @@ Todo now:
               " Version 2.7.1-dev "
         - in package.json the line
             " "version": " 2.7.1-dev", "
-        - in doc/conf.py (if it exists) the line
+        - in docs/conf.py (if it exists) the line
               " version = '2.7.1-dev' "
 
  8. on https://github.com/phpmyadmin/phpmyadmin/milestones close the milestone corresponding to the released version (if this is a stable release) and open a new one for the next minor release

bin/internal/set-version.sh

@@ -49,7 +49,7 @@ fi
 # for instance), and while that's more precise this should work with less to fix if a line changes.
 # This method wasn't selected for any particular strength.
 
-oldVersion="$(grep 'version =' "${dir}"doc/conf.py | cut -d "'" -f2)"
+oldVersion="$(grep 'version =' "${dir}"docs/conf.py | cut -d "'" -f2)"
 
 echo "Changing from ${oldVersion} to ${newVersion}..."
 
@@ -57,7 +57,7 @@ echo "Changing from ${oldVersion} to ${newVersion}..."
 oldVersion=${oldVersion//./\.}
 newVersion=${newVersion//./\.}
 
-for f in README doc/conf.py package.json
+for f in README docs/conf.py package.json
 do
     if ! grep --quiet "${oldVersion}" "${dir}${f}"
     then

config.sample.inc.php

@@ -3,7 +3,7 @@
  * phpMyAdmin sample configuration, you can use it as base for
  * manual configuration. For easier setup you can use setup/
  *
- * All directives are explained in documentation in the doc/ folder
+ * All directives are explained in documentation in the docs/ folder
  * or at <https://docs.phpmyadmin.net/>.
  */
 
@@ -156,5 +156,5 @@ $cfg['SaveDir'] = '';
 
 /**
  * You can find more configuration options in the documentation
- * in the doc/ folder or at <https://docs.phpmyadmin.net/>.
+ * in the docs/ folder or at <https://docs.phpmyadmin.net/>.
  */

docs/faq.rst

@@ -690,7 +690,7 @@ A list of files and corresponding functionality which degrade gracefully when re
 * :file:`./resources/locale/` folder, or unused subfolders (interface translations)
 * Any unused themes in :file:`./public/themes/` except the default theme `pmahomme`.
 * :file:`./app/language_stats.inc.php` (translation statistics)
-* :file:`./doc/` (documentation)
+* :file:`./docs/` (documentation)
 * :file:`./setup/` (setup script)
 * :file:`./examples/` (configuration examples)
 * :file:`./resources/sql/` (SQL scripts to configure advanced functionalities)

src/Html/MySQLDocumentation.php

@@ -101,8 +101,8 @@ class MySQLDocumentation
          * Check if we have built local documentation, however
          * provide consistent URL for testsuite
          */
-        if (! defined('TESTSUITE') && @file_exists(ROOT_PATH . 'doc/html/index.html')) {
-            return $pathPrefix . 'doc/html/' . $url;
+        if (! defined('TESTSUITE') && @file_exists(ROOT_PATH . 'docs/html/index.html')) {
+            return $pathPrefix . 'docs/html/' . $url;
         }
 
         return Core::linkURL('https://docs.phpmyadmin.net/en/latest/' . $url);

src/Sanitize.php

@@ -40,7 +40,7 @@ class Sanitize
     public static function checkLink(string $url, bool $http = false, bool $other = false): bool
     {
         $url = strtolower($url);
-        $validStarts = ['https://', 'index.php?route=/url&url=https%3a%2f%2f', './doc/html/', './index.php?'];
+        $validStarts = ['https://', 'index.php?route=/url&url=https%3a%2f%2f', './docs/html/', './index.php?'];
         $isSetup = self::isSetup();
         // Adjust path to setup script location
         if ($isSetup) {

tests/classes/SanitizeTest.php

@@ -212,7 +212,7 @@ class SanitizeTest extends AbstractTestCase
         // Allow other links
         return [
             [false, 'foo', false, false],
-            [true, './doc/html/', false, false],
+            [true, './docs/html/', false, false],
             [false, 'index.php', false, false],
             [false, './index.php', false, false],
             [true, './index.php?', false, false],