diff --git a/.github/workflows/other-tools.yml b/.github/workflows/other-tools.yml index 09245bb3d9..8a3244ba9a 100644 --- a/.github/workflows/other-tools.yml +++ b/.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 diff --git a/.gitignore b/.gitignore index 04361feb52..4c69038883 100644 --- a/.gitignore +++ b/.gitignore @@ -36,7 +36,7 @@ web.config *~ # API documentation /apidoc/ -/doc/linkcheck/ +/docs/linkcheck/ # Demo server revision-info.php # PHP_CodeSniffer diff --git a/README b/README index 4b10264134..a999d2aa2d 100644 --- a/README +++ b/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 ------- diff --git a/README.rst b/README.rst index 404669f725..f163509b1d 100644 --- a/README.rst +++ b/README.rst @@ -63,7 +63,7 @@ Please see `the documentation `_ or `security issues, `_ you can visit https://www.phpmyadmin.net/ diff --git a/bin/internal/check-release-excludes.sh b/bin/internal/check-release-excludes.sh index 4f25161a09..29c3913baa 100755 --- a/bin/internal/check-release-excludes.sh +++ b/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 diff --git a/bin/internal/create-release.sh b/bin/internal/create-release.sh index 6e40d20b01..746718b296 100755 --- a/bin/internal/create-release.sh +++ b/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 diff --git a/bin/internal/set-version.sh b/bin/internal/set-version.sh index 446184ce51..effb496427 100755 --- a/bin/internal/set-version.sh +++ b/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 diff --git a/config.sample.inc.php b/config.sample.inc.php index 492372870c..9b7783b346 100644 --- a/config.sample.inc.php +++ b/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 . */ @@ -156,5 +156,5 @@ $cfg['SaveDir'] = ''; /** * You can find more configuration options in the documentation - * in the doc/ folder or at . + * in the docs/ folder or at . */ diff --git a/doc/.gitignore b/docs/.gitignore similarity index 100% rename from doc/.gitignore rename to docs/.gitignore diff --git a/doc/Makefile b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/_ext/configext.py b/docs/_ext/configext.py similarity index 100% rename from doc/_ext/configext.py rename to docs/_ext/configext.py diff --git a/doc/bookmarks.rst b/docs/bookmarks.rst similarity index 100% rename from doc/bookmarks.rst rename to docs/bookmarks.rst diff --git a/doc/charts.rst b/docs/charts.rst similarity index 100% rename from doc/charts.rst rename to docs/charts.rst diff --git a/doc/conf.py b/docs/conf.py similarity index 100% rename from doc/conf.py rename to docs/conf.py diff --git a/doc/config.rst b/docs/config.rst similarity index 100% rename from doc/config.rst rename to docs/config.rst diff --git a/doc/copyright.rst b/docs/copyright.rst similarity index 100% rename from doc/copyright.rst rename to docs/copyright.rst diff --git a/doc/credits.rst b/docs/credits.rst similarity index 100% rename from doc/credits.rst rename to docs/credits.rst diff --git a/doc/developers.rst b/docs/developers.rst similarity index 100% rename from doc/developers.rst rename to docs/developers.rst diff --git a/doc/faq.rst b/docs/faq.rst similarity index 99% rename from doc/faq.rst rename to docs/faq.rst index 45a6400bbd..42a9ea2d3d 100644 --- a/doc/faq.rst +++ b/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) diff --git a/doc/glossary.rst b/docs/glossary.rst similarity index 100% rename from doc/glossary.rst rename to docs/glossary.rst diff --git a/doc/images/bar_chart.png b/docs/images/bar_chart.png similarity index 100% rename from doc/images/bar_chart.png rename to docs/images/bar_chart.png diff --git a/doc/images/chart.png b/docs/images/chart.png similarity index 100% rename from doc/images/chart.png rename to docs/images/chart.png diff --git a/doc/images/column_chart.png b/docs/images/column_chart.png similarity index 100% rename from doc/images/column_chart.png rename to docs/images/column_chart.png diff --git a/doc/images/display_chart.png b/docs/images/display_chart.png similarity index 100% rename from doc/images/display_chart.png rename to docs/images/display_chart.png diff --git a/doc/images/line_chart.png b/docs/images/line_chart.png similarity index 100% rename from doc/images/line_chart.png rename to docs/images/line_chart.png diff --git a/doc/images/pie_chart.png b/docs/images/pie_chart.png similarity index 100% rename from doc/images/pie_chart.png rename to docs/images/pie_chart.png diff --git a/doc/images/pma-relations-category.png b/docs/images/pma-relations-category.png similarity index 100% rename from doc/images/pma-relations-category.png rename to docs/images/pma-relations-category.png diff --git a/doc/images/pma-relations-links.png b/docs/images/pma-relations-links.png similarity index 100% rename from doc/images/pma-relations-links.png rename to docs/images/pma-relations-links.png diff --git a/doc/images/pma-relations-relation-link.png b/docs/images/pma-relations-relation-link.png similarity index 100% rename from doc/images/pma-relations-relation-link.png rename to docs/images/pma-relations-relation-link.png diff --git a/doc/images/pma-relations-relation-name.png b/docs/images/pma-relations-relation-name.png similarity index 100% rename from doc/images/pma-relations-relation-name.png rename to docs/images/pma-relations-relation-name.png diff --git a/doc/images/pma-relations-relation-view-link.png b/docs/images/pma-relations-relation-view-link.png similarity index 100% rename from doc/images/pma-relations-relation-view-link.png rename to docs/images/pma-relations-relation-view-link.png diff --git a/doc/images/query_result_operations.png b/docs/images/query_result_operations.png similarity index 100% rename from doc/images/query_result_operations.png rename to docs/images/query_result_operations.png diff --git a/doc/images/scatter_chart.png b/docs/images/scatter_chart.png similarity index 100% rename from doc/images/scatter_chart.png rename to docs/images/scatter_chart.png diff --git a/doc/images/spline_chart.png b/docs/images/spline_chart.png similarity index 100% rename from doc/images/spline_chart.png rename to docs/images/spline_chart.png diff --git a/doc/images/timeline_chart.png b/docs/images/timeline_chart.png similarity index 100% rename from doc/images/timeline_chart.png rename to docs/images/timeline_chart.png diff --git a/doc/images/usergroups.png b/docs/images/usergroups.png similarity index 100% rename from doc/images/usergroups.png rename to docs/images/usergroups.png diff --git a/doc/import_export.rst b/docs/import_export.rst similarity index 100% rename from doc/import_export.rst rename to docs/import_export.rst diff --git a/doc/index.rst b/docs/index.rst similarity index 100% rename from doc/index.rst rename to docs/index.rst diff --git a/doc/intro.rst b/docs/intro.rst similarity index 100% rename from doc/intro.rst rename to docs/intro.rst diff --git a/doc/make.bat b/docs/make.bat similarity index 100% rename from doc/make.bat rename to docs/make.bat diff --git a/doc/other.rst b/docs/other.rst similarity index 100% rename from doc/other.rst rename to docs/other.rst diff --git a/doc/privileges.rst b/docs/privileges.rst similarity index 100% rename from doc/privileges.rst rename to docs/privileges.rst diff --git a/doc/relations.rst b/docs/relations.rst similarity index 100% rename from doc/relations.rst rename to docs/relations.rst diff --git a/doc/require.rst b/docs/require.rst similarity index 100% rename from doc/require.rst rename to docs/require.rst diff --git a/doc/security.rst b/docs/security.rst similarity index 100% rename from doc/security.rst rename to docs/security.rst diff --git a/doc/settings.rst b/docs/settings.rst similarity index 100% rename from doc/settings.rst rename to docs/settings.rst diff --git a/doc/setup.rst b/docs/setup.rst similarity index 100% rename from doc/setup.rst rename to docs/setup.rst diff --git a/doc/themes.rst b/docs/themes.rst similarity index 100% rename from doc/themes.rst rename to docs/themes.rst diff --git a/doc/transformations.rst b/docs/transformations.rst similarity index 100% rename from doc/transformations.rst rename to docs/transformations.rst diff --git a/doc/two_factor.rst b/docs/two_factor.rst similarity index 100% rename from doc/two_factor.rst rename to docs/two_factor.rst diff --git a/doc/user.rst b/docs/user.rst similarity index 100% rename from doc/user.rst rename to docs/user.rst diff --git a/doc/vendors.rst b/docs/vendors.rst similarity index 100% rename from doc/vendors.rst rename to docs/vendors.rst diff --git a/src/Html/MySQLDocumentation.php b/src/Html/MySQLDocumentation.php index b62620f33a..8551ce3bbe 100644 --- a/src/Html/MySQLDocumentation.php +++ b/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); diff --git a/src/Sanitize.php b/src/Sanitize.php index 96fc61806a..06c8f77710 100644 --- a/src/Sanitize.php +++ b/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) { diff --git a/tests/classes/SanitizeTest.php b/tests/classes/SanitizeTest.php index f6db347e73..7373fc4293 100644 --- a/tests/classes/SanitizeTest.php +++ b/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],