Skip to content

Commit

Permalink
WIP - new landing page (#9369)
Browse files Browse the repository at this point in the history
* Getting started on Landing page

* certification to learning

* Apply Prettier formatting

* starting on tldr page

* Apply Prettier formatting

* Embed videos, link out to related docs for all sections

* Add tldr to submenu get started

* tldr update

* nav update

* landing update

---------

Co-authored-by: Pantheon Bot <[email protected]>
Co-authored-by: Rachel Whitton <[email protected]>
  • Loading branch information
3 people authored Jan 10, 2025
1 parent 7751b26 commit a35b09f
Show file tree
Hide file tree
Showing 6 changed files with 142 additions and 14 deletions.
61 changes: 61 additions & 0 deletions source/content/tldr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Documentation Tl;DR
description: Sometimes our Documentation feels overwhelming. Here's the summary version.
reviewed: "2025-01-08"
contenttype: [doc]
innav: [true]
audience: [development]
product: [--]
integration: [--]
---

Sometimes our documentation feels overwhelming. Here's the summary version.

## Site Creation

<Youtube src="1xGhhi6iGgw" title="Creating a Site on Pantheon - the TL;DR Version" />

It can be overwhelming to switch to a new platform like Pantheon. There's a ton of documentation. Do you have to read it all? Can you just try it out? Yes, you can! And after getting the TL;DR version of making a new site, you should be ready to jump in too.

[Read more about creating a free sandbox site here](/add-site-dashboard).

## Development Workflow

<Youtube src="gId4Yb5Qevk" title="Pantheon's Workflow - the TL;DR Version" />

Code goes up. Content comes down. That's the TL;DR of Pantheon's workflow. You can work on your site in a Multidev environment, then merge that code into the Dev environment. And when you're ready to go live, you can push that code to the Test environment. And then to Live.

[Read more about Pantheon's Workflow here](/pantheon-workflow).

## Workspaces, Sites, and Teams

<Youtube src="kP4cfkY5sGw" title="Workspaces, Sites, and Teams - the TL;DR Version" />

Wow, there's a lot of detail in this section of Pantheon's documentation. But the TL;DR is pretty simple. Your websites go in a workspace. Then, you give people access either at the level of the whole workspace (and therefore all sites within it) or you're granting access to individual sites.

[Read more about Workspaces, Sites, and Teams here](/guides/account-mgmt/workspace-sites-teams).

## Updating DNS to Connect a Domain Name to Pantheon

<Youtube src="ZJ3HaGJ8KAk" title="Updating DNS to Connect a Domain Name to Pantheon - the TL;DR Version" />

Updating DNS can be scary. Depending on your team, the importance of your site, and the complexity of your site, all this preparation for going live might be a huge and long effort. Or maybe you just need some clear docs specific to your registrar.

[That's what this doc walks you through.](/guides/launch/domains/)


## How to Use Quicksilver Hooks to Improve your Workflow

<Youtube src="kXKDEpOm_6w" title="Quicksilver Hooks - the TL;DR Version" />

Website operations get more efficient with automation. TL;DR, Pantheon's hook system for building out automation is called Quicksilver. If you want to run scripts in response to each deployment or each creation of a Multidev environment, you declare that in your pantheon.yml file. Now you're automatically posting to Slack so that your co-workers stay in the loop with each deployment.

[That's what this doc explains.](/guides/quicksilver/hooks)

## Terminus: Pantheon's CLI

<Youtube src="Gy_sUqhTa3M" title="Terminus: Pantheon's CLI - the TL;DR Version" />

Using the command line in general can be intimidating. Tools like Pantheon's CLI, Terminus, are more approachable when you know they're mostly just an alternative way to do all the things you might do in the browser-based dashboard. And on the command line, you get the option of building custom Bash scripts if that's your part of your process.

[To get more than the TL;DR read about Terminus here.](/terminus)
67 changes: 67 additions & 0 deletions source/data/landings.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1370,3 +1370,70 @@
links:
- text: "Pantheon WebOps Certification Registry"
url: "https://certification.pantheon.io"

- title: "Learning and Certification"
subtitle: "Learn to use Pantheon's platform and tools"
path: "learning"
topics-groups:

- title: "Getting Started"
links:
- text: "Create a Site"
url: "/guides/getstarted/addsite"
- text: "Launch a Site"
url: "/guides/getstarted/launch/"
- text: "Migrating a Site to Pantheon"
url: "/guides/guided"



- title: "Tutorials"
links:
- text: "WordPress and Git"
url: "/guides/wordpress-git"
- text: "Incident Management"
url: "/guides/pagerduty"
- text: "Web Accessibility"
url: "/guides/accessibility/"


- title: "TL;DR - For when you need a video summary of documentation"
links:

- text: "Site Creation"
url: "/tldr#site-creation"

- text: "Development Workflow"
url: "/tldr#development-workflow"

- text: "Workspaces, Sites, and Teams"
url: "/tldr#workspaces-sites-and-teams"

- text: "Connecting DNS"
url: "/tldr#updating-dns-to-connect-a-domain-name-to-pantheon"

- text: "Quicksilver Workflow Hooks"
url: "/tldr#how-to-use-quicksilver-hooks-to-improve-your-workflow"

- text: "Terminus: Pantheon's CLI"
url: "/tldr#terminus-pantheons-cli"



- title: "Certification"
links:
- text: "Why become certified?"
url: "/certification/about"
- text: "Study Guide"
url: "/certification/study-guide"
- text: "Exam Instructions"
url: "/certification/exam#exam-instructions"
- text: "Exam Topics"
url: "/certification/exam#exam-topics"
- text: "Exam FAQs"
url: "/certification/exam#exam-faqs"
- text: "See who's certified!"
url: "https://certification.pantheon.io"



5 changes: 2 additions & 3 deletions src/components/omniSidebarNav/getOmniItems.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import CertificationItems from './submenus/certification';
import getStarted from './submenus/getStarted';
import goLive from './submenus/goLive';
import pagesToDelete from './submenus/pagesToDelete';
import webInfrastructure from './submenus/webInfrastructure';
import accountManagement from './submenus/accountManagement';
import terminus from './submenus/terminus';
Expand All @@ -10,6 +8,7 @@ import workflows from './submenus/workflows';
import support from './submenus/support';
import security from './submenus/security';
import { simpleLink } from './helpers';
import learning from './submenus/learning';

// Before we can merge we need to:
// Todo: remove console logging from this component.
Expand All @@ -30,7 +29,7 @@ const getOmniItems = () => {
terminus(),
support(),
security(),
CertificationItems(),
learning(),
about(),
simpleLink('/release-notes', 'Release Notes'),
// pagesToDelete(),
Expand Down
1 change: 1 addition & 0 deletions src/components/omniSidebarNav/submenus/getStarted.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ const getStarted = () => {
// This page is kind of a landing page? Should it be in this menu?
simpleLink('/products', 'Products & Features'),
simpleLink('/required-reading', 'Required Reading'),
simpleLink('/tldr', 'Documentation TL;DR'),
getGuideDirectory('guides/platform-considerations'),
simpleLink('/guides/guided', 'Migrating Sites to Pantheon', [
getGuideDirectory('guides/migrate/guided', 'Guided Migration'),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
import { simpleLink, getGuideDirectory } from './../helpers';
import { getGuideDirectory, simpleLink } from './../helpers';

/**
* Array of of links specific to the Certification section of the sidebar.
* @type {Array<Object>}
*/
const CertificationItems = () => {
const learning = () => {
return {
link: '/certification',
title: 'Education & Certification',
link: '/learning',
title: 'Learning and Certification',
children: [
simpleLink('/learning', 'Learning about Pantheon'),

simpleLink('/certification', 'WebOps Certification', [
{
link: '/certification',
title: 'Certification',
},

{
link: '/certification/about',
title: 'About the Certification Program',
},

{
link: '/certification/exam',
title: 'Taking the Exam',
Expand Down Expand Up @@ -77,6 +77,7 @@ const CertificationItems = () => {
title: 'Certification Directory',
},
]),

simpleLink('/guides/wordpress-git', 'Tutorials', [
getGuideDirectory('guides/wordpress-git', 'WordPress and Git'),
getGuideDirectory('guides/pagerduty', 'Incident Management'),
Expand All @@ -93,9 +94,8 @@ const CertificationItems = () => {
simpleLink('/guides', 'More Tutorials'),
]),
simpleLink('/agency-tips', 'Agency Tips'),
simpleLink('https://learning.pantheon.io', 'Pantheon Learning'),
],
};
};

export default CertificationItems;
export default learning;
2 changes: 1 addition & 1 deletion src/templates/certificationpage.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ class CertificationTemplate extends React.Component {
<OmniSidebarNav
slot="guide-menu"
activePage={node.fields.slug}
submenuPathToUse="/certification"
submenuPathToUse="/learning"
/>

<ContentLayoutType slot="guide-content">
Expand Down

0 comments on commit a35b09f

Please sign in to comment.