[TikiWiki-commits] [Git][tikiwiki/tiki][master] [REF] Remove dynamic value from readme Add a synchronization note to...

Benoit Grégoire pushed to branch master at Tiki Wiki CMS Groupware / Tiki


Commits:
6193abce by ushindi bienvenu at 2026-03-04T18:53:58+00:00
[REF] Remove dynamic value from readme Add a synchronization note to _htacccess for developer awareness
---
* [REF] Remove dynamic value from readme to make it reusable

* [REF] Add a synchronization note to _htacccess for developer to be aware that any update here should be reflected in web_config

See merge request tikiwiki/tiki!9686

- - - - -


4 changed files:

- README
- _htaccess
- doc/devtools/release.php
- web_config


Changes:

=====================================
README
=====================================
@@ -1,48 +1,78 @@
 Tiki Wiki CMS Groupware
-Version 25.1
+=======================
 
 Started in 2002, Tiki Wiki CMS Groupware is a web application combining
 the features of a wiki, a content management system (CMS) and groupware.
-It is the Free/Libre and Open Source (FLOSS) web application with the most built-in features, https://tiki.org/Features.
+It is the Free/Libre and Open Source (FLOSS) web application with the most built-in [features](https://tiki.org/Features).
+
+Project Website
+---------------
+
+https://tiki.org
+
+Features
+--------
+
+Tiki provides a wide range of built-in features, including:
+
+- Wiki / Web Pages
+- Trackers (Database component of Tiki)
+- File Galleries
+- Forums
+- Blogs
+- Articles
+- Calendar and Event Listings
+- And many more...
+
+Full feature list:
+https://tiki.org/Features
 
 CONTRIBUTING
+------------
+Tiki is driven by the contributions of an active community of developers and
+translators who participate in its development.
+You can be the next contributor to the Tiki source code or documentation by
 
-* Tiki is driven by the contributions of an active community of developers and
-  translators who participate in its development.
-  You can be the next contributor to the Tiki source code or documentation.
-  Please check the Wishlist, https://dev.tiki.org/Wishlist,
-  for bugs or feature requests you can start developing or create new ones if you don't find them listed.
+- Reporting bugs
+- Improving documentation
+- Translating
+- Submitting patches
+- Proposing new features
 
 
-DOCUMENTATION
+Please check the Wishlist, https://dev.tiki.org/Wishlist, to check current and planned features.
 
-* You have access to a diverse source of support through documentation, forum, events, etc.
+DOCUMENTATION
+-------------
+You have access to a diverse source of support through documentation, forum, events, etc.
 
-* The documentation for 25.1 version is ever evolving at http://doc.tiki.org.
-  You're encouraged to contribute.
+- Official documentation is available at:
+https://doc.tiki.org
 
-* It is highly recommended that you refer to the online documentation:
-* http://doc.tiki.org/Installation for a setup guide
+- Installation guide:
+There is a file INSTALL in this directory with notes on how to setup and configure Tiki
+https://doc.tiki.org/Installation
 
-* Notes about this release are accessible from http://doc.tiki.org/Tiki25
-* Tiki has an active Gitter community, join us at https://gitter.im/tiki-org/community.
+- Upgrade guide:
+Read the online instructions if you want to upgrade your Tiki from a previous release
+You can visit https://doc.tiki.org/Upgrade for the latest install help
 
-INSTALLATION
 
-* There is a file INSTALL in this directory with notes on how to setup and
-  configure Tiki. Again, see http://doc.tiki.org/Installation for the latest install help.
+Community
+---------
 
-UPGRADES
+Join the community discussions:
 
-* Read the online instructions if you want to upgrade your Tiki from a previous release http://doc.tiki.org/Upgrade
+- Forums: https://tiki.org/forums
+- Chat: https://gitter.im/tiki-org/community
+- Events and meetings: https://tiki.org/Events
 
 COPYRIGHT
+---------
 
-Copyright (c) 2002-2023, Luis Argerich, Garland Foster, Eduardo Polidor, et. al.
+Copyright (c) 2002-2026, Luis Argerich, Garland Foster, Eduardo Polidor, et. al.
 Tiki was started under the name tikiwiki by Luis Argerich, Garland Foster, Eduardo Polidor, et. al.
 All Rights Reserved. See copyright.txt for details and a complete list of authors.
 Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details.
 
-... Have fun!
-
-Note to Tiki developers: update this text through release.php.
\ No newline at end of file
+... Have fun!
\ No newline at end of file


=====================================
_htaccess
=====================================
@@ -14,7 +14,8 @@
 #
 # DEVELOPERS: 
 # This is the sample configuration file for Apache. Must be linked to .htaccess to be active.
-# This configuration must be kept synchronized with the configuration for other Web servers.
+# This configuration must be kept synchronized with the configuration for other Web servers .
+# If you change any rule in this file, also review and update ./web_config for IIS (Windows server).
 # See http://dev.tiki.org/Operating+System+independence#Keep_web.config_and_.htaccess_synchronized
 
 # -- Prevent Browsing of Certain File Extensions -- #


=====================================
doc/devtools/release.php
=====================================
@@ -28,8 +28,6 @@ define('COPYRIGHTS_FILENAME', 'copyright.txt');
 define('COPYRIGHTS', ROOT . '/' . COPYRIGHTS_FILENAME);
 define('SF_TW_MEMBERS_URL', 'http://sourceforge.net/p/tikiwiki/_members');
 define('DEV_TW_MEMBERS_URL', 'http://dev.tiki.org/getTikiUser.php');
-define('README_FILENAME', 'README');
-define('README', ROOT . '/' . README_FILENAME);
 define('LICENSE_FILENAME', 'license.txt');
 
 define('PIPELINE_STATUS_PASSED', 'passed');
@@ -143,12 +141,6 @@ if (empty($subrelease)) {
     $secdbVersion = "$version$subrelease";
 }
 
-if (! $options['no-readme-update'] && important_step("Update '" . README_FILENAME . "' file")) {
-    update_readme_file($secdbVersion, $version);
-    info('>> ' . README_FILENAME . ' file updated.');
-    important_step('Commit updated ' . README_FILENAME . ' file', true, "[REL] Update " . README_FILENAME . " file for $secdbVersion");
-}
-
 if (! $options['no-lang-update'] && important_step("Update language files")) {
     passthru("$phpCommand console.php translation:getstrings");
     $removeFiles = glob('lang/*/language.php.old');
@@ -1085,7 +1077,6 @@ function get_options()
         'no-check-php-warnings' => false,
         'no-check-smarty' => false,
         'no-first-update' => false,
-        'no-readme-update' => false,
         'no-lang-update' => false,
         'no-changelog-update' => false,
         'no-copyright-update' => false,
@@ -1544,80 +1535,6 @@ function get_contributors_sf_data(&$contributors)
     }
 }
 
-/**
- * @param $releaseVersion
- * @param $mainVersion
- * @return bool
- */
-function update_readme_file($releaseVersion, $mainVersion)
-{
-    if (! is_readable(README) || ! is_writable(README)) {
-        error('The README file "' . README . '" is not readable or writable.');
-        die;
-    }
-
-    $year = gmdate('Y');
-    $copyrights_file = COPYRIGHTS_FILENAME;
-    $license_file = LICENSE_FILENAME;
-
-    $majorVersion = substr($mainVersion, 0, strpos($mainVersion, '.'));
-    $release_notes_url = 'http://doc.tiki.org/Tiki' . $majorVersion;
-    // Changed from Tiki 12 to point to http://doc.tiki.org/Tiki12 instead of http://tiki.org/ReleaseNotes30
-
-    $readme = <<<EOF
-Tiki Wiki CMS Groupware
-Version $releaseVersion
-
-Started in 2002, Tiki Wiki CMS Groupware is a web application combining
-the features of a wiki, a content management system (CMS) and groupware.
-It is the Free/Libre and Open Source (FLOSS) web application with the most built-in features, https://tiki.org/Features.
-
-CONTRIBUTING
-
-* Tiki is driven by the contributions of an active community of developers and
-  translators who participate in its development.
-  You can be the next contributor to the Tiki source code or documentation.
-  Please check the Wishlist, https://dev.tiki.org/Wishlist,
-  for bugs or feature requests you can start developing or create new ones if you don't find them listed.
-
-
-DOCUMENTATION
-
-* You have access to a diverse source of support through documentation, forum, events, etc.
-
-* The documentation for $mainVersion version is ever evolving at http://doc.tiki.org.
-  You're encouraged to contribute.
-
-* It is highly recommended that you refer to the online documentation:
-* http://doc.tiki.org/Installation for a setup guide
-
-* Notes about this release are accessible from $release_notes_url
-* Tiki has an active Gitter community, join us at https://gitter.im/tiki-org/community.
-
-INSTALLATION
-
-* There is a file INSTALL in this directory with notes on how to setup and
-  configure Tiki. Again, see http://doc.tiki.org/Installation for the latest install help.
-
-UPGRADES
-
-* Read the online instructions if you want to upgrade your Tiki from a previous release http://doc.tiki.org/Upgrade
-
-COPYRIGHT
-
-Copyright (c) 2002-$year, Luis Argerich, Garland Foster, Eduardo Polidor, et. al.
-Tiki was started under the name tikiwiki by Luis Argerich, Garland Foster, Eduardo Polidor, et. al.
-All Rights Reserved. See $copyrights_file for details and a complete list of authors.
-Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See $license_file for details.
-
-... Have fun!
-
-Note to Tiki developers: update this text through release.php.
-EOF;
-
-    return (bool)file_put_contents(README, $readme);
-}
-
 function display_usage()
 {
     echo "Usage: php doc/devtools/release.php [ Options ] <version-number> [ <subrelease> ]
@@ -1638,7 +1555,6 @@ Options:
     --no-check-php-warnings   : do not display PHP warnings and notices during the PHP syntax check
     --no-check-smarty         : do not check syntax of all Smarty templates
     --no-first-update         : do not vcs update the checkout used for the release as the first step
-    --no-readme-update        : do not update the '" . README_FILENAME . "' file
     --no-lang-update          : do not update lang/*/language.php files
     --no-changelog-update     : do not update the '" . CHANGELOG_FILENAME . "' file
     --no-copyright-update     : do not update the '" . COPYRIGHTS_FILENAME . "' file


=====================================
web_config
=====================================
@@ -3,7 +3,9 @@
 <!-- DEVELOPERS: 
 This is the sample configuration file for IIS.  Must be linked to web.config to be active.
 
-This configuration must be kept synchronized with the configuration for other Web servers. See http://dev.tiki.org/Operating+System+independence#Keep_web.config_and_.htaccess_synchronized -->
+This configuration must be kept synchronized with the configuration for other Web servers.
+If you change any rule in this file, also review and update ./_htaccess.
+See http://dev.tiki.org/Operating+System+independence#Keep_web.config_and_.htaccess_synchronized -->
 
 <configuration>
   <system.webServer>



View it on GitLab: https://gitlab.com/tikiwiki/tiki/-/commit/6193abce86289ce13ed0cb475ec676b54a670624

-- 
View it on GitLab: https://gitlab.com/tikiwiki/tiki/-/commit/6193abce86289ce13ed0cb475ec676b54a670624
You're receiving this email because of your account on gitlab.com. Manage all notifications: https://gitlab.com/-/profile/notifications | Help: https://gitlab.com/help

_______________________________________________
TikiWiki-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/tikiwiki-cvs