Skip to content

docs(installation): archive Drupal 7 guide, update installation docs for Drupal 11+#592

Open
Copilot wants to merge 4 commits intogh-pagesfrom
copilot/upgrade-docs-installation-section
Open

docs(installation): archive Drupal 7 guide, update installation docs for Drupal 11+#592
Copilot wants to merge 4 commits intogh-pagesfrom
copilot/upgrade-docs-installation-section

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 17, 2026

  • Created installation-legacy/index.html with D7 archive content
  • Updated installation/index.html with D11+ content
  • Fixed installation-legacy/index.html asset and nav paths: changed all ../../ to ../ (favicon, CSS, JS, search, nav links, sidebar links) and base_url from "../.." to ".."installation-legacy/ is a top-level section like installation/, not a subdirectory
  • Fixed installation/index.html Nginx version: removed hard-coded 1.1+ and deferred to the linked Drupal system requirements page instead
  • Added document root note: installation/index.html now explicitly states to configure the web server document root to .../YOUR_PROJECT_NAME/web (not the project root) to avoid exposing vendor/ and composer.json

Copilot AI and others added 3 commits April 17, 2026 23:07
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates PECE’s system administration/installation documentation to reflect the move from Drupal 7 to Drupal 11+, while preserving the old Drupal 7 instructions in an archived “legacy” page for reference.

Changes:

  • Add an archived legacy installation page for Drupal 7, with a banner pointing to the current guide.
  • Update the main installation guide to Drupal 11+ requirements and a Composer/Drush-based install/update workflow.
  • Refresh and remove outdated dependency/troubleshooting sections (e.g., php-mcrypt, pecl-yaml, update.php flow).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File Description
installation/index.html Modernizes installation/update instructions and requirements for Drupal 11+ and links to the legacy guide.
installation-legacy/index.html Adds an archived copy of the Drupal 7 installation guide with navigation back to the current Drupal 11+ guide.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread installation-legacy/index.html Outdated
Comment on lines +11 to +24
<link rel="shortcut icon" href="../../img/favicon.ico">


<title>System Admin's Guide (Drupal 7 Legacy) - PECE Documentation</title>


<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.0/css/all.css" integrity="sha384-REHJTs1r2ErKBuJB0fCK99gCYsVjwxHrSU0N7I1zl9vZbggVJXRMsv/sLlOAGb4M" crossorigin="anonymous">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.0/css/v4-shims.css" integrity="sha384-AL44/7DEVqkvY9j8IjGLGZgFmHAjuHa+2RIWKxDliMNIfSs9g14/BRpYwHrWQgz6" crossorigin="anonymous">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/hack-font@3.3.0/build/web/hack.min.css" integrity="sha384-xJimnBJEGitT5KhSxUYmJBbk+brsHZwt1WFdCNkrNbhVsn5maNIIq2mNUHgZp447" crossorigin="anonymous">
<link href='//rsms.me/inter/inter.css' rel='stylesheet' type='text/css'>
<link href='//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,700italic,400,300,600,700&subset=latin-ext,latin' rel='stylesheet' type='text/css'>
<link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../css/base.min.css" rel="stylesheet">
<link href="../../css/cinder.min.css" rel="stylesheet">
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

installation-legacy/index.html is at the same directory depth as other top-level sections (e.g., installation/, siteadmin/), but its asset URLs use ../../... (favicon/CSS). When the docs are hosted under a subpath (e.g., GitHub Pages), ../../ can escape the site base and break asset loading. These paths should match the rest of the site (typically ../img/..., ../css/..., etc.).

Copilot uses AI. Check for mistakes.
Comment thread installation-legacy/index.html Outdated
Comment on lines +336 to +347
<script src="../../js/bootstrap-3.0.3.min.js"></script>


<script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/highlight.min.js" integrity="sha384-PMPdQfn2gANjihulr7se6A+NaXEsPnvL+jlRzXuav6swX2l/uRnDVSDV+zZCz8E1" crossorigin="anonymous"></script>

<script>hljs.initHighlightingOnLoad();</script>


<script>var base_url = "../.."</script>

<script src="../../js/base.js"></script>
<script src="../../search/main.js"></script>
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The legacy page sets base_url (and related JS includes) to ../.., which is inconsistent with other top-level sections that use ... If this site is served from a subdirectory, ../.. can resolve outside the docs base and break search/navigation URLs. Align base_url and local script paths with the rest of the top-level pages.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot apply changes based on this feedback

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in b1012de. All ../../ relative paths in installation-legacy/index.html (favicon, CSS, JS, search, nav links, sidebar links, and banner links) have been updated to ../, and base_url changed from "../.." to ".." — matching the other top-level sections. Also addressed the related feedback: removed the hard-coded Nginx 1.1+ version in installation/index.html (defers to the linked Drupal system requirements page), and added an explicit note to set the web server document root to .../YOUR_PROJECT_NAME/web to avoid exposing vendor/ and composer.json.

Comment thread installation/index.html Outdated
<li>SQLite 3.45+</li>
</ul>
</li>
<li><p><strong>Web server</strong>: Apache 2.4+ (with <code>mod_rewrite</code> enabled) or Nginx 1.1+.</p></li>
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The stated minimum Nginx version (1.1+) is extremely old for a Drupal 11 stack and is likely a typo or too permissive to be meaningful. Consider either (a) updating it to the actual supported minimum for Drupal 11, or (b) avoiding hard-coding a number here and instead deferring to the linked Drupal system requirements page for web server version constraints.

Suggested change
<li><p><strong>Web server</strong>: Apache 2.4+ (with <code>mod_rewrite</code> enabled) or Nginx 1.1+.</p></li>
<li><p><strong>Web server</strong>: Apache 2.4+ (with <code>mod_rewrite</code> enabled) or a supported Nginx version; see the official Drupal system requirements page below for current Nginx version constraints.</p></li>

Copilot uses AI. Check for mistakes.
Comment thread installation/index.html Outdated
<h2 id="ive-installed-pece-but-none-of-my-links-are-working-what-is-going-on">I've installed PECE, but none of my links are working. What is going on?</h2>
<p>Your web server is not properly configured to support URL routing for Drupal.
Make sure the <code>rewrite</code> module is enabled and your virtual host is configured
to allow <code>.htaccess</code> overrides (<code>AllowOverride All</code>). For Apache, Drupal ships
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These instructions reference the .htaccess in web/, but they never explicitly state that the web server’s document root should be set to the web/ directory (which is important for Composer-based Drupal projects to avoid exposing vendor/, composer.json, etc.). Please add an explicit note to configure Apache/Nginx to serve from .../YOUR_PROJECT_NAME/web.

Suggested change
to allow <code>.htaccess</code> overrides (<code>AllowOverride All</code>). For Apache, Drupal ships
to allow <code>.htaccess</code> overrides (<code>AllowOverride All</code>). Configure Apache or Nginx
to use <code>.../YOUR_PROJECT_NAME/web</code> as the document root (not the project root), so that
files such as <code>vendor/</code> and <code>composer.json</code> are not exposed. For Apache, Drupal ships

Copilot uses AI. Check for mistakes.
Comment thread installation-legacy/index.html Outdated
Comment on lines +159 to +169
<li class="second-level"><a href="../../installation/">&#x2190; Current Guide (Drupal 11+)</a></li>

</ul>
</div></div>
<div class="col-md-9" role="main">
<div class="alert" style="background-color:#fff3cd;border:1px solid #ffc107;border-radius:4px;padding:16px 20px;margin-bottom:24px;">
<strong>&#x1F4C1; Archived — Drupal 7 Legacy Documentation</strong><br>
This page contains the original PECE installation instructions for <strong>Drupal 7</strong>, which is no longer maintained.
If you are setting up a new PECE instance, please use the
<a href="../../installation/"><strong>current installation guide (Drupal 11+)</strong></a> instead.
</div>
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sidebar and banner links back to the current guide use ../../installation/. From installation-legacy/, that path can escape the docs base when hosted under a subpath. Use the same relative linking pattern as other top-level pages (likely ../installation/).

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot apply changes based on this feedback

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was already fixed in b1012de — the sidebar link (line 159) and banner link (line 168) both now use ../installation/ instead of ../../installation/.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


<!-- Main title -->

<a class="navbar-brand" href="../..">PECE Documentation</a>
Copy link

Copilot AI Apr 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this top-level section page, the navbar brand link points to "../..", which goes up two levels and can escape the docs root when hosted under a subpath. It should match other top-level sections (e.g. installation/) and link to ".." instead.

Suggested change
<a class="navbar-brand" href="../..">PECE Documentation</a>
<a class="navbar-brand" href="..">PECE Documentation</a>

Copilot uses AI. Check for mistakes.


<li >
<a href="../..">Home</a>
Copy link

Copilot AI Apr 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Home link in the navbar uses "../.." (two levels up). From /installation-legacy/ this can resolve outside the documentation base; other sections use "..". Update this to ".." for consistent and correct navigation.

Suggested change
<a href="../..">Home</a>
<a href="..">Home</a>

Copilot uses AI. Check for mistakes.
management guidelines under the “sustainability” section to learn about
the recommended minimum specs for your servers.</p>
<h3 id="downloading-the-distro">Downloading the Distro</h3>
<p>Our distribution is currently being developed on Github. You can obtain
Copy link

Copilot AI Apr 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use the standard capitalization "GitHub" (capital H) in this sentence for consistent branding across the docs.

Suggested change
<p>Our distribution is currently being developed on Github. You can obtain
<p>Our distribution is currently being developed on GitHub. You can obtain

Copilot uses AI. Check for mistakes.
Comment thread installation/index.html
Comment on lines 251 to +254
<blockquote>
<p>mysql -u $YOUR_USER -p -e "CREATE DATABASE $YOUR_DB_NAME
CHARACTER SET utf8 COLLATE utf8_general_ci;"</p>
<p>drush site:install --db-url=mysql://USER:PASS@localhost/DB_NAME --account-name=admin --account-pass=CHANGEME</p>
</blockquote>
<p>Proceed to the URL in which your Drupal will reside, i.e.
https://worldpece.org. From there, you can install PECE like any other
Drupal site. Follow the Drupal.org <a href="https://www.drupal.org/documentation/install/"><em>official documentation if you need further help</em></a>. In the
section <a href="http://pece.readthedocs.io/en/latest/installation.html#troubleshooting"><em>Troubleshooting</em></a> below we describe common issues users have when trying to install PECE without the proper backend dependencies, configurations, and permissions.</p>
<p>One important note: please, make sure to set the permissions on the
filesystem properly. We cannot emphasize this enough. The <a href="https://www.drupal.org/node/244924"><em>official Drupal documentation explains</em></a> how
to do so, if you have questions. (In our experience, we have needed to
set the file permissions at sites/default/files/artifacts to 770 and
sites/default/files/private to 770.)</p>
<p><strong>Important:</strong> Replace <code>CHANGEME</code> with a strong, unique password before running this command. Never use a weak or default password on a publicly accessible site.</p>
Copy link

Copilot AI Apr 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Drush example includes the admin password directly on the command line, which is commonly captured in shell history and process listings. Prefer an approach that avoids embedding secrets in the command (e.g., prompting for the password or reading it from a protected environment variable/secret store) and mention that in the docs.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants