Move all pages into a nested navigation (#9097)

* moving deck chairs * removing a too small function. And removing sample unit test * deleting separate sidebarNav component * moving test fixture * simplyfing a function * simplify data structures * running prettier * checking for search js before adding it * cleanup * adding some doc blocks and minor refactor * docs and cleanup * more comments * more cleanup * more comments more tests * adding all the front-end sites guides * removing extra nav alert in the middle of decouple overview pages * running prettier * going back to old prettier config files. Redo this change under #9082 * reporting files * reporting tests * more reporting tools * tests for reporting * more tests and console logging * moving reporting function * more testing of reporting * reporting * getting percentages calculated * adding contributors for exceptions examples * starting to unwind logic error that had percentages reversed * fixing logic * more logic fixing * getting close * 8%! * removing unused stuff * adding to menu * more menus * 55% * migrating and upgrading guides * more guides in menus * 199! * updating exceptions * Adding menu to video template * putting omni items in doc template * starting on DNS * putting everything in a menu * more sidebars * moving simpleLink to helper * breaking out file for submenu * breaking out menus * two more * breaking out menus * assigning menus * a few more assignments * getting doc template with sidebar * dns menus * lots of menu moving * Drupal and WordPress separate menus * moving menus * adding about section * everything in a top level menu * build tools menu link * comment about nested docroot * starting to add a styling file for omnisidebarnav * starting on styling * getting external link indicator working * remove extra arrow in link * removing console.log * workflows() * getting rendering of default docs pages working * code organizing * adding comment * adding comments * reporting on status codes * Moving submenus around * more * Adding label * Add vitest to GitHub actions (#9162) * Add vitest to GHA * Make a clean install * switching from jsx to React.createElement() * Update and rename test.yml to vitest.yml --------- Co-authored-by: Steve Persch <[email protected]> Co-authored-by: Steve Persch <[email protected]> * moving icon to back and setting to small * testing readme * fixing link * copy fix * changing addsearch back * addsearch back * adding vite.config.ts * some menu restructuring * menu reorgs * fixing page title * drupal notes and DNS titles * Refining menus with Rachel and Chris. And adding some JS todos * more menu tweaks with Rachel and Chris * fixup terminus template and submenu * whitespace to trigger build * more menu tweaking * terminus menu * adding a comment to a md file * working out a top-level nav * Coworking on submenus - integrations * manually bringing over files from main before merging * manually bringing over prettier config change from main * running prettier on some of the files in omniSidebarNav * Apply Prettier formatting * renaming dnsProviders * working on the migrate section * Apply Prettier formatting * Migration submenu edits * Apply Prettier formatting * Combine migration and getstarted submenus * Debug migration nested submenu * Apply Prettier formatting * Fix link to getstarted submenu * test pre-push hook * test pre-push hook * add prettier pre-push hook to .github/hooks * add git hooks section to readme * actually add the changed files to git * White spaces * Apply Prettier formatting * Apply Prettier formatting * Support submenu * Apply Prettier formatting * Move troubleshooting menu from webinfra * Apply Prettier formatting * Edits to support submenu * Apply Prettier formatting * Edits to accountmanagement submenu * Apply Prettier formatting * add comments * Apply Prettier formatting * Coworking session submenu updates * Apply Prettier formatting * finish workflows section * Apply Prettier formatting * web infra submenu * Apply Prettier formatting * more submenu work * Apply Prettier formatting * Add notes for merge blockers * Apply Prettier formatting * certification menu organizing * Apply Prettier formatting * updating links in header * Apply Prettier formatting * clean up a few links * Cleaning up education section * Apply Prettier formatting * cleaning up support menu * prettier * more reordering in troubleshooting * prettier * getting header functioning with menu of links * header cleanup * top level menu fixes * Apply Prettier formatting * moving a guide * Apply Prettier formatting * reviewing pages to delete * prettier * removing unused import * moving pages to delete * bring back search bar * Apply Prettier formatting * removing popover code * Apply Prettier formatting * removing popover code * Apply Prettier formatting * fixing import order * Apply Prettier formatting * landing page layout * landing page layout * Apply Prettier formatting * some comment cleanup * whitespace * cleaning up the drupal upgrade and migration stuff * moving around links * Apply Prettier formatting * menu updates * prettier * updating all-written-paths.txt * more menu updates * prettier * some cleanup * redistributing landing pages * prettier * Adding search to landing page * adding new pages to menu * prettier * Apply Prettier formatting * Deleting the unassignedPages submenu * redistributing some pages that were previously in "pages to delete" * For easier review, reorder based on work done in pr #9335 * Apply Prettier formatting * Finish pagestodelete submenu * Apply Prettier formatting * Delete all-written-paths.txt * Update source/content/guides/drush/04-drupal-commandline.md * removing todos that are done * Update src/components/omniSidebarNav/submenus/support.js * moving some reporting out of index * prettier * Apply suggestions from code review * Apply Prettier formatting * Terminus menu fix * Apply Prettier formatting --------- Co-authored-by: Chris Reynolds <[email protected]> Co-authored-by: Rachel Whitton <[email protected]> Co-authored-by: Pantheon Bot <[email protected]> Co-authored-by: Chris Reynolds <[email protected]>
pantheon-systems · Dec 18, 2024 · fb346ac · fb346ac
1 parent 603eedb
commit fb346ac
Show file tree

Hide file tree

Showing 46 changed files with 4,538 additions and 445 deletions.
diff --git a/gatsby-node.js b/gatsby-node.js
@@ -650,5 +650,47 @@ exports.onPreBootstrap = () => {
   fs.copySync(scriptsCopyFrom, scriptsCopyTo);
 };
 
+/* This block is for debugging purposes. It writes the paths of all pages to a file.
+exports.onPostBuild = async ({ graphql, getNodes }) => {
+  // Fetch all pages created by Gatsby
+  const pages = getNodes().filter((node) => node.internal.type === 'SitePage');
+
+  //console.log('pages', pages);
+  //loop over pages and log the path
+  const pagePaths = pages.map((page) => page.path);
+  console.log('pagePaths', pagePaths);
+  pages.forEach((page) => {
+    console.log('path', page.path);
+  });
+
+  // const exceptions = ['https://certification.pantheon.io/', '/404.html'];
+  // const OmniItems = getOmniItems();
+  // const menuReport = calculateNumberOfPathsInMenu(pagePaths, OmniItems, exceptions);
+  // console.log('menuReport', menuReport);
+
+  fs.writeFile(
+    'all-written-paths.txt',
+    JSON.stringify(pagePaths, null, 2),
+    (err) => {
+      if (err) throw err;
+      console.log('The file has been saved!');
+    },
+  );
+
+  // // Read the menu links from your menu file (assuming it's a JSON file)
+  // const menuFilePath = path.resolve(__dirname, 'src/data/menu.json');
+  // const menuData = JSON.parse(fs.readFileSync(menuFilePath, 'utf-8'));
+
+  // // Extract the paths from the menu links
+  // const menuLinks = menuData.map(item => item.path);
+
+  // // Check how many pages are in the menu
+  // const pagesInMenu = pages.filter(page => menuLinks.includes(page.path));
+
+  // console.log(`Total Pages Created by Gatsby: ${pages.length}`);
+  // console.log(`Total Pages in Menu: ${pagesInMenu.length}`);
+};
+*/
+
 /* todo Should there be an error thrown if a release note category is set that is not allowed? */
 /* todo, infer published date from file name. And throw an error if there are files that don't follow the pattern. */
diff --git a/gatsby-ssr.js b/gatsby-ssr.js
@@ -18,6 +18,7 @@ export const onRenderBody = ({ setPostBodyComponents }) => {
       src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"
     />,
     <script key="twitter" src="https://platform.twitter.com/widgets.js" />,
+
     // OneTrust Banner
     <script
       src="https://cdn.cookielaw.org/scripttemplates/otSDKStub.js"

diff --git a/source/content/guides/backups/01-introduction.md b/source/content/guides/backups/01-introduction.md
@@ -1,5 +1,5 @@
 ---
-title: Backups Tool
+title: Backups
 subtitle: Introduction
 description: Learn access and manage your Pantheon site backups.
 tags: [backups, security]

diff --git a/source/content/guides/backups/02-access-backups.md b/source/content/guides/backups/02-access-backups.md
@@ -1,5 +1,5 @@
 ---
-title: Backups Tool
+title: Backups
 subtitle: Access Backups
 description: Learn how to access your backups.
 tags: [backups, security]

diff --git a/source/content/guides/backups/03-create-backups.md b/source/content/guides/backups/03-create-backups.md
@@ -1,5 +1,5 @@
 ---
-title: Backups Tool
+title: Backups
 subtitle: Create Backups
 description: Learn how to create new backups.
 tags: [backups, security]

diff --git a/source/content/guides/backups/04-restore-from-backup.md b/source/content/guides/backups/04-restore-from-backup.md
@@ -1,5 +1,5 @@
 ---
-title: Backups Tool
+title: Backups
 subtitle: Restore a Backup
 description: Learn how restore from an existing backup.
 tags: [backups, security]

diff --git a/source/content/guides/backups/05-code-archives-backups-log.md b/source/content/guides/backups/05-code-archives-backups-log.md
@@ -1,5 +1,5 @@
 ---
-title: Backups Tool
+title: Backups
 subtitle: Code Archives and Backup Log
 description: Learn about your code archives and Backup Log.
 tags: [backups, security]

diff --git a/source/content/guides/backups/06-faqs-backups.md b/source/content/guides/backups/06-faqs-backups.md
@@ -1,5 +1,5 @@
 ---
-title: Backups Tool
+title: Backups
 subtitle: FAQs
 description: Get answers to your Backups Tool questions.
 tags: [backups, security]

diff --git a/source/content/guides/domains/configure-dns.md b/source/content/guides/domains/configure-dns.md
diff --git a/source/content/guides/drush/04-drupal-commandline.md b/source/content/guides/drush/04-drupal-commandline.md
@@ -16,6 +16,8 @@ product: [--]
 integration: [drush]
 ---
 
+<!--  @todo, move this page out of this guide and to a "Tutorials" section. https://github.com/pantheon-systems/documentation/issues/9354  -->
+
 [Drush](https://github.com/drush-ops/drush) is a tool for working with Drupal from the command line. [Terminus](/terminus) allows you to use the command line to do everything you can do in Pantheon's browser-based dashboard. You can also run Drush commands directly from Terminus, making it a single solution for command line development on Pantheon.
 
 This section walks you through using Drush and Terminus in the command line to create a new Drupal site and move configurations between Pantheon environments.
@@ -67,7 +69,7 @@ The next few sections use the example variables `my-site` and `"My D9 Site"` as
   ```
 
   - You can add the `--org` option to the command above and pass the Workspace name, label, or ID if you want to associate this site with an Workspace.
-  
+
   - Use the `site:org:add` command to associate an existing site with an Workspace.
 
 1. Open your new Site Dashboard in a browser:
@@ -312,4 +314,4 @@ Terminus provides the power to manage most aspects of your Pantheon sites, while
 
 - [Use the Pantheon Workflow](/pantheon-workflow)
 - [Configuration Workflow for Drupal Sites](/drupal-configuration-management)
-- [Terminus Guide](/terminus)
+- [Terminus Guide](/terminus)
diff --git a/source/content/guides/local-development/10-continuous-integration.md b/source/content/guides/local-development/10-continuous-integration.md
@@ -15,7 +15,7 @@ integration: []
 showtoc: true
 permalink: docs/guides/local-development/continuous-integration
 ---
-
+<!--Todo: move content to /continuous-integration and delete -->
 This section provides information on how to use Terminus and Drupal SimpleTest to run automated integration tests.
 
 [Continuous Integration](https://pantheon.io/integrations/continuous-integration) (CI) is a method of running automated unit and integration tests to apply quality control. Pantheon doesn't provide or host tools for continuous integration, but many tools and techniques are compatible with Pantheon. [Contact support](/guides/support/contact-support/) if you have a particular use case or technique that you'd like to highlight.

diff --git a/source/content/guides/mariadb-mysql/09-database-connection-errors.md b/source/content/guides/mariadb-mysql/09-database-connection-errors.md
@@ -14,6 +14,8 @@ showtoc: true
 permalink: docs/guides/mariadb-mysql/database-connection-errors
 ---
 
+<!-- Much of this guide could be restructured. Some of the info in this guide is general explanation. Some is troubleshooting "how to"  -->
+
 This section provides information on database connection errors.
 
 There is an issue connecting to the Pantheon database if your site suddenly reverts to `install.php`, or you get database connection errors like the one below:
@@ -24,7 +26,7 @@ There is an issue connecting to the Pantheon database if your site suddenly reve
 Can’t connect to local MySQL server through socket '/var/lib/mysql/mysql.sock'...).
 ```
 
-There are two common causes for this issue: 
+There are two common causes for this issue:
 
 - Overwriting core
 - Using non-standard bootstraps
@@ -80,4 +82,4 @@ Uncaught exception 'PDOException' with message 'SQLSTATE[42S02]: Base table or v
 
 ## More Resources
 
-- [Troubleshooting MySQL Connections](/guides/mariadb-mysql/mysql-access/#troubleshooting-mysql-connections)
+- [Troubleshooting MySQL Connections](/guides/mariadb-mysql/mysql-access/#troubleshooting-mysql-connections)
diff --git a/source/content/guides/sso/04-shibboleth-sso.md b/source/content/guides/sso/04-shibboleth-sso.md
@@ -14,7 +14,7 @@ product: [--]
 integration: [SimpleSAMLphp]
 permalink: docs/guides/sso/shibboleth-sso
 ---
-
+<!--Todo: Relocate this to a single page doc so it can be added to Integrations submenu -->
 This section provides information on how to install and configure [SimpleSAMLphp](https://simplesamlphp.org/) for Pantheon sites. Refer to the [Other SSO Options](#other-sso-options) section if you are searching for an SSO service provider solution with minimal configuration requirements.
 
 ## Before You Begin

diff --git a/source/content/guides/wordpress-developer/07-wordpress-s3.md b/source/content/guides/wordpress-developer/07-wordpress-s3.md
@@ -15,6 +15,7 @@ reviewed: "2024-10-23"
 showtoc: true
 permalink: docs/guides/wordpress-developer/wordpress-s3
 ---
+<!--Todo: Relocate this to a single page doc so it can be added to Integrations submenu -->
 
 This section provides information on how to integrate Amazon Web Services (AWS) S3 storage with your WordPress Pantheon site.
 

diff --git a/source/content/optimize-wp-options-table-autoloaded-data.md b/source/content/optimize-wp-options-table-autoloaded-data.md
@@ -1,5 +1,5 @@
 ---
-title: Optimize Your wp-options Table and Autoloaded Data
+title: Optimize Your wp_options Table and Autoloaded Data
 description: Learn how to check and configure the autoloaded data in your wp_options table.
 tags: [cache]
 contributors: [carl-alberto, whitneymeredith]