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

Conversation

rachelwhitton
Copy link
Member

@rachelwhitton rachelwhitton commented Dec 5, 2024

Fixes #9142

Summary

  • Site Dashboard:
    • Document the behavior of the CMS buttons in the site dash (Visit Site and Site Admin).
    • Note platform domain is expected by default unless overridden by custom primary domain.
    • Refresh stale image at top of the doc.

@rachelwhitton rachelwhitton requested a review from a team as a code owner December 5, 2024 20:07
@rachelwhitton rachelwhitton added Type: New Content Request for or PR containing new content to existing page Topic: Dashboard labels Dec 5, 2024
@rachelwhitton
Copy link
Member Author

@jazzsequence can you review when convenient?

Copy link

⚡ Deployed with Pantheon Decoupled

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

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

@@ -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

Copy link
Contributor

@jazzsequence jazzsequence left a comment

Choose a reason for hiding this comment

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

A couple notes but not worth blocking or rabbit holing on. Agree with @stevector re: stray <br /> tag, but also not explicitly blocking.

@@ -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


<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

Copy link

⚡ Deployed with Pantheon Decoupled

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

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

@rachelwhitton rachelwhitton requested a review from a team as a code owner December 18, 2024 18:53
Copy link

⚡ Deployed with Pantheon Decoupled

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

👀 Preview: https://pr-9342-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
Topic: Dashboard Type: New Content Request for or PR containing new content to existing page
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The Site Dashboard Doc Update
3 participants