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

D8CORE-7292 - Updated the help pages. #864

Open
wants to merge 5 commits into
base: 11.x
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
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
30 changes: 0 additions & 30 deletions src/Plugin/HelpSection/ProfileConnectSection.php

This file was deleted.

81 changes: 81 additions & 0 deletions src/Plugin/HelpSection/ProfileHelpMaintainingSection.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
<?php

namespace Drupal\stanford_profile\Plugin\HelpSection;

use Drupal\help\Plugin\HelpSection\HelpSectionPluginBase;

/**
* Provides the module topics list section for the help page.
*
* @HelpSection(
* id = "profile_help_maintaining",
* title = @Translation("Maintaining your site"),
* description = @Translation("Resources for maintaining the health of your site."),
* weight = -99
* )
*/
class ProfileHelpMaintainingSection extends HelpSectionPluginBase {

/**
* {@inheritdoc}
*/
public function listTopics() {
return [
$this->getMaintainingYourSite(),
$this->getStanfordWebServicesSupport(),
$this->getSiteHealth(),
$this->getContent(),
];
}

/**
* Get the user guide help text.
*
* @return array
* Markup render array.
*/
protected function getMaintainingYourSite() {
$help = '<h3>' . $this->t('Maintaining your site') . '</h3>';
$help .= '<p>' . $this->t('The following tools and resources will help you keep your site healthy. You can also join our active community of Stanford Sites users on <a href="https://stanford.enterprise.slack.com/archives/C01NR8WC6AX">Slack</a>. This is a great place to ask questions, learn about the newest features on Stanford Sites, and more!') . '</p>';
return ['#markup' => $help];
}

/**
* Get the user guide help text.
*
* @return array
* Markup render array.
*/
protected function getStanfordWebServicesSupport() {
$help = '<h3>' . $this->t('Stanford Web Services Support') . '</h3>';
$help .= '<p>' . $this->t('The following tools and resources will help you keep your site healthy. You can also join our active community of Stanford Sites users on Slack. This is a great place to ask questions, learn about the newest features on Stanford Sites, and more!') . '</p>';
return ['#markup' => $help];
}

/**
* Get the user guide help text.
*
* @return array
* Markup render array.
*/
protected function getSiteHealth() {
$help = '<h3>' . $this->t('Site Health') . '</h3>';
$help .= '<p>' . $this->t('Use <a href="http://siteimprove.stanford.edu/">Siteimprove</a>, an accessibility and quality assurance platform to scan and monitor your website that is active for all launched sites on Stanford Sites. Siteimprove will help you identify accessibility issues, broken links, typos and more! You can learn more about this service here: <a href="https://uit.stanford.edu/accessibility/testing/siteimprove">https://uit.stanford.edu/accessibility/testing/siteimprove</a>.') . '</p>';
return ['#markup' => $help];
}

/**
* Get the user guide help text.
*
* @return array
* Markup render array.
*/
protected function getContent() {
$help = '<h3>' . $this->t('Content') . '</h3>';
$help .= '<p>' . $this->t('There are many resources available to help communicators.') . '</p>';
$help .= '<p>' . $this->t('The <a href="https://communicators.stanford.edu/">Communicators</a> community is a great place to start to learn more about common practices, style guides, and policies.') . '</p>';
$help .= '<p>' . $this->t('<a href="https://sallie.stanford.edu/">Sallie</a> is the university’s image database. Find images to meet your communication goals.') . '</p>';
return ['#markup' => $help];
}

}
32 changes: 2 additions & 30 deletions src/Plugin/HelpSection/ProfileHelpSection.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,8 @@ public function listTopics() {
return [
$this->getUserGuide(),
$this->getAssistance(),
$this->getLaunchWebsite(),
$this->getFeedback(),
$this->getPolicies(),
$this->getContact(),
$this->getLaunchWebsite(),
];
}

Expand Down Expand Up @@ -74,6 +72,7 @@ protected function getPolicies() {
$help .= self::getLinkString($this->t('Online Privacy'), 'https://www.stanford.edu/site/privacy/') . '</br>';
$help .= self::getLinkString($this->t('Accessibility'), 'https://www.stanford.edu/site/accessibility/') . '</br>';
$help .= self::getLinkString($this->t('Terms of use for Sites'), 'https://www.stanford.edu/site/terms/') . '</br>';
$help .= self::getLinkString($this->t('Branding'), 'https://identity.stanford.edu/') . '</br>';

return ['#markup' => $help];
}
Expand All @@ -90,31 +89,4 @@ protected function getAssistance() {
$help .= self::getLinkString($this->t('Stanford Web Services ServiceNow Form'), 'https://stanford.service-now.com/it_services?id=sc_cat_item&sys_id=83daed294f4143009a9a97411310c70a', TRUE);
return ['#markup' => $help];
}

/**
* Get the feedback help text.
*
* @return array
* Markup render array.
*/
protected function getFeedback() {
$help = '<h3>' . $this->t('Do you have feedback for us?') . '</h3>';
$help .= '<p>' . $this->t('Submit Feedback to our Drupal service through our ServiceNow form') . '</p>';
$help .= self::getLinkString($this->t('Stanford Web Services ServiceNow Form'), 'https://stanford.service-now.com/it_services?id=sc_cat_item&sys_id=83daed294f4143009a9a97411310c70a', TRUE);
return ['#markup' => $help];
}

/**
* Get the contact info help text.
*
* @return array
* Markup render array.
*/
protected function getContact() {
$help = '<h3>' . $this->t("Can't find what you're looking for?") . '</h3>';
$help .= '<p>' . $this->t("We'll help you find the answer or connect you with an advisor.") . '</p>';
$help .= self::getLinkString($this->t('Stanford Web Services ServiceNow Form'), 'https://stanford.service-now.com/it_services?id=sc_cat_item&sys_id=83daed294f4143009a9a97411310c70a', TRUE);
return ['#markup' => $help];
}

}
25 changes: 12 additions & 13 deletions src/Plugin/HelpSection/ProfileResourceSection.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
*
* @HelpSection(
* id = "profile_resources",
* title = @Translation("Drupal resources at Stanford"),
* description = @Translation("Stanford has a very active and engaged Drupal community, and many centrally offered and community created resources that might help you."),
* title = @Translation("Other resources at Stanford"),
* description = @Translation("Stanford has many centrally offered and community created resources that might help you."),
* weight = -50
* )
*/
Expand All @@ -23,9 +23,9 @@ class ProfileResourceSection extends HelpSectionPluginBase {
*/
public function listTopics() {
return [
$this->getSupport(),
$this->getSoda(),
$this->getTechTraining(),
$this->getBlog(),
$this->getMorningOfCode(),
];
}

Expand All @@ -36,8 +36,8 @@ public function listTopics() {
* Markup render array.
*/
protected function getTechTraining() {
$help = '<h3>' . self::getLinkString($this->t('University IT Technology Training'), 'https://itservices.stanford.edu/service/techtraining/schedule') . '</h3>';
$help .= '<p>' . $this->t('Check the upcoming courses schedule for training courses offered to Stanford faculty and staff.') . '</p>';
$help = '<h3>' . self::getLinkString($this->t('Tech Training:'), 'https://itservices.stanford.edu/service/techtraining/schedule') . '</h3>';
$help .= '<p>' . $this->t('See upcoming courses on site editing.') . '</p>';
return ['#markup' => $help];
}

Expand All @@ -47,9 +47,9 @@ protected function getTechTraining() {
* @return array
* Markup render array.
*/
protected function getBlog() {
$help = '<h3>' . self::getLinkString($this->t('Stanford Web Services Blog'), 'https://swsblog.stanford.edu/') . '</h3>';
$help .= '<p>' . $this->t('The Stanford Web Services team blogs about all things related to Stanford Sites, Drupal, design, site building, and many other topics. This is a great resource for SWS clients.') . '</p>';
protected function getSoda() {
$help = '<h3>' . self::getLinkString($this->t('Office of Digital Accessibility'), 'https://uit.stanford.edu/accessibility') . '</h3>';
$help .= '<p>' . $this->t('Get assistance with identifying issues and improving the accessibility of your site.') . '</p>';
return ['#markup' => $help];
}

Expand All @@ -59,10 +59,9 @@ protected function getBlog() {
* @return array
* Markup render array.
*/
protected function getMorningOfCode() {
$help = '<h3>' . self::getLinkString($this->t("Mornings o' Code, Drupallers Drop-in Help, Drupallers Co-Working Sessions"), 'https://opensource.stanford.edu/moc') . '</h3>';
$help .= '<p>' . $this->t("Stanford Drupallers (new and experienced) meet regularly to collaborate and troubleshoot issues. Check the schedule for upcoming co-working sessions.") . '</p>';
protected function getSupport() {
$help = '<h3>' . self::getLinkString($this->t("Stanford Web Services Support"), 'https://sitesuserguide.stanford.edu/support') . '</h3>';
$help .= '<p>' . $this->t("See upcoming onboarding sessions for editors or book office hours to get hands-on assistance with your site.") . '</p>';
return ['#markup' => $help];
}

}
Loading