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

Docs for cms buttons in site dash #9342

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/content/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Easily visualize and manage sites, users, traffic, metrics, visual regression te

Our site dashboard provide a real-time interface into Pantheon. It includes everything you need to build, launch, and run sites. Create new projects, manage team access, interface via SFTP or Git (version control), and track miscellaneous tools like backups. It also allows you to deploy and scale your sites.

![The Pantheon Dashboard](../images/dashboard/new-dashboard/2024/site-dashboard.png)
![The Pantheon Dashboard](../images/dashboard/new-dashboard/2024/_site-dashboard.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: would probably prefer replacing the old screenshot or renaming the new one (e.g. site-dashboard-2024.png) rather than adding an underscore. What happens with the next redesign? And the next? etc. It sets a precedent that I don't think we'd want to perpetuate in the future.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll rename this to ../images/dashboard/new-dashboard/2024/site-dashboard-2024.png as suggested

I don't feel strongly about the renaming convention so long as the name is changed then we'll get the fresh version.

For background though, I added 2024 subdir to the path in an earlier PR which contained mostly the same images just with the nav cropped out based on PDEs recommendations, in a follow up PR I generated fresh screenshots from the product with the new nav shown for context and added _ to the filenames because it was an easy modifier to do a search and replace for and I had already done the 2024 modifier previously in the folder structure


</Tab>

Expand Down
21 changes: 16 additions & 5 deletions source/content/site-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ product: [dashboard]
integration: [--]
tags: [--]
showtoc: true
reviewed: 2023-04-19
reviewed: 2024-12-05
---

The Pantheon Site Dashboard is the hub of all development and activity for an individual site.

![The Pantheon Site Dashboard](../images/dashboard/new-dashboard/2024/site-dashboard.png)
![The Pantheon Site Dashboard](../images/dashboard/new-dashboard/2024/_site-dashboard.png)

## Header Elements

Expand All @@ -27,6 +27,7 @@ On the top left of the page, you will see the following information:
- If applicable, a yellow **Upgrade** button, that will allow you to [upgrade the site](/guides/account-mgmt/plans/site-plans).
- If applicable, the name of the Professional Workspace containing this site.

<br />
Copy link
Contributor

Choose a reason for hiding this comment

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

A stray br seems odd

Copy link
Member Author

Choose a reason for hiding this comment

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

I think there needs to be more space above a new paragraph following a list so I threw in the <br /> but I can do a separate PR to address that in the template styles instead of this approach
Screenshot 2024-12-18 at 9 28 40 AM

On the right side, there are two rows of options:

- Workflows: displays information about any active workflows.
Expand Down Expand Up @@ -57,11 +58,21 @@ This environment is for your live site, where content creators actively post and

## Left Navigation

The following links are located within your Dev, Test, and Live environment tabs:
The following buttons are found above the lefthand navigation menu on every environment in the site dashboard:

- **Code:** Switch between SFTP Connection Mode and Git Connection Mode. Obtain SFTP Connection Info, and commit changes to your Dev environment. (This link is only accessible within your Dev environment.)
- **Visit `Environment` Site**: Where `Environment` is a placeholder for the active environment you're currently looking at in the dashboard, such as **Visit Test Site** or **Visit Development Site** etc. This will open the homepage of your site for the given environment in a new tab.

- **Commit Log:** Review a list of all code changes by viewing the commits. Click an individual commit to see the log message and list of changes.
- **Site Admin**: This will open your sites admin login page for the given environment in a new tab. If you're not already logged into your sites admin interface, this button will open `/user/login` for Drupal and `/wp-login.php` for WordPress. Once you've logged in and have an active admin session, this button will take you to `/user` for Drupal and `/wp-admin` for WordPress.

<Alert title="Note" type="info">

By default, the buttons described above will open links that are served via their respective [platform domains](/guides/domains/platform-domains) (e.g., `test-example.pantheonsite.io`). If you want these buttons to open your site using your own custom domain instead (e.g., `test.example.com`) you can connect a [custom domain](/guides/domains/custom-domains) then configure it as the [primary domain](/guides/domains/primary-domain) for the target environment. This is typically only done for the Live environment as part of launch however you can do this anytime for any environment based on your preferences and requirements.
Copy link
Contributor

Choose a reason for hiding this comment

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

Probably not worth overloading this note but WordPress multisites break if you set a platform domain, so this can't actually be done (or shouldn't) for WordPress multisites that host multiple domains (even for live environments).

Copy link
Member Author

Choose a reason for hiding this comment

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

We could warn about that in the primary domain doc that's crosslinked in this note? https://docs.pantheon.io/guides/domains/primary-domain

Copy link
Member Author

Choose a reason for hiding this comment

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

@jazzsequence can you review the latest commit when convenient? a2190f3


</Alert>

The following navigation items are found on the lefthand side in the site dashboard:

- **Code:** Switch between SFTP Connection Mode and Git Connection Mode. Obtain SFTP Connection Info, and commit changes to your Dev environment. In the center of this page you will find the site's commit log with an activity feed of all code changes. (This tab is only accessible within your Dev or Multidev environments.)

- **Deploys:** View a deploy log for the environment. (This link is only accessible within your Test and Live environments.)

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading