Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

9354 tutorial move #9364

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

9354 tutorial move #9364

wants to merge 7 commits into from

Conversation

stevector
Copy link
Contributor

Closes #9354

@rachelwhitton, can you review? I might be breaking your preference for short URL paths here.

Copy link

github-actions bot commented Jan 3, 2025

Hi from your friendly robot! 🤖

I've applied Prettier formatting to the following files in fa379f9:

src/components/omniSidebarNav/submenus/certification.js

The full diff is below. Please review the changes.

Click to expand
diff --git a/src/components/omniSidebarNav/submenus/certification.js b/src/components/omniSidebarNav/submenus/certification.js
index daf8f4d2c..63f24b77f 100644
--- a/src/components/omniSidebarNav/submenus/certification.js
+++ b/src/components/omniSidebarNav/submenus/certification.js
@@ -81,7 +81,10 @@ const CertificationItems = () => {
         getGuideDirectory('guides/wordpress-git', 'WordPress and Git'),
         getGuideDirectory('guides/pagerduty', 'Incident Management'),
         getGuideDirectory('guides/accessibility', 'Web Accesibility'),
-        simpleLink('/tutorials/drupal-site-creation-and-workflow-commandline', 'All CLI workflow with Terminus and Drupal'),
+        simpleLink(
+          '/tutorials/drupal-site-creation-and-workflow-commandline',
+          'All CLI workflow with Terminus and Drupal',
+        ),
         simpleLink('/pivotal-tracker', 'Pivotal Tracker'),
         simpleLink('/pingdom-uptime-check', 'Pingdom Uptime Check'),
 

@rachelwhitton
Copy link
Member

@stevector Is this a new standard we want to impose across the entire codebase in the longterm?

Where we 1) relocate .md files to a new subdir based on the respective submenu AND 2) update URLs to include the respective submenu?

e.g., moving source/content/drupal-advanced-page-cache to source/content/tutorials/drupal-advanced-page-cache with permalink set to docs/tutorials/drupal-advanced-page-cache etc.

There are contributor experience gains I think to this move, but since we have an "edit this page" button on every doc I'm not sure anyone outside of our team would notice a difference

Are there UX gains unlocked by adopting this standard? like would it get us closer to a unified sidebar experience? If not, I think my preference is to leave submenus out of our permalink structures and ignore submenus in the directory structure, for simpler URLs but also because it would be a lot of effort and time required to do this with not a lot of payoff


What I had in mind for these follow up todos, where one page of a multipage guide needs to be relocated to a different submenu, was simply relocating the file from source/content/guides/<example>/<page>.md to source/content/<page>.md and remove guides from the permalink

Since that's the existing standard for like 90% of the codebase

@stevector
Copy link
Contributor Author

@rachelwhitton I'd be fine with putting this doc at /source/content instead of creating a new source/content/tutorials. Mostly I wanted it out of guides

@rachelwhitton
Copy link
Member

@stevector can you review latest commit? I revised this based on discussion above

Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9364-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

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.

Move Drupal/Terminus tutorial from guide to Tutorials section
2 participants