Skip to content

Commit

Permalink
Updated sub-module README files.
Browse files Browse the repository at this point in the history
  • Loading branch information
joegl committed Sep 13, 2024
1 parent 26afd34 commit b45ed95
Show file tree
Hide file tree
Showing 9 changed files with 9 additions and 468 deletions.
Original file line number Diff line number Diff line change
@@ -1,54 +1,4 @@
# [Stanford Profile Helper](https://github.com/SU-SWS/stanford_profile_helper)
##### 8.x
[![Maintainability](https://api.codeclimate.com/v1/badges/73a84da54c8a1175ab3e/maintainability)](https://codeclimate.com/github/SU-SWS/stanford_profile_helper/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/73a84da54c8a1175ab3e/test_coverage)](https://codeclimate.com/github/SU-SWS/stanford_profile_helper/test_coverage)
[![CircleCI](https://circleci.com/gh/SU-SWS/stanford_profile_helper.svg?style=svg)](https://circleci.com/gh/SU-SWS/stanford_profile_helper)
Maintainers: [Mike Decker](https://github.com/pookmish), [sherakama](https://github.com/sherakama)

Changelog: [Changelog.md](CHANGELOG.md)

Description
---

This is the main helper module for the installation profile for Stanford Web Services' self service platform and is used as a base for more.

Accessibility
---
[![WCAG Conformance 2.0 AA Badge](https://www.w3.org/WAI/wcag2AA-blue.png)](https://www.w3.org/TR/WCAG20/)
This module conforms to level AA WCAG 2.0 standards as required by the university's accessibility policy. For more information on the policy please visit: [https://ucomm.stanford.edu/policies/accessibility-policy.html](https://ucomm.stanford.edu/policies/accessibility-policy.html).

Installation
---

Install this installation profile like any other profile. [See Drupal Documentation](https://www.drupal.org/docs/7/install/using-an-installation-profile)

Configuration
---

Nothing special needed.

Releases
---

Steps to build a new release:
- Checkout the latest commit from the `8.x-1.x` branch.
- Create a new branch for the release.
- Commit any necessary changes to the release branch.
- These may include, but are not necessarily limited to:
- Update the version in any `info.yml` files, including in any submodules.
- Update the CHANGELOG to reflect the changes made in the new release.
- Make a PR to merge your release branch into `main`
- Give the PR a semver-compliant label, e.g., (`patch`, `minor`, `major`). This may happen automatically via Github actions (if a labeler action is configured).
- When the PR is merged to `main`, a new tag will be created automatically, bumping the version by the semver label.
- The github action is built from: [semver-release-action](https://github.com/K-Phoen/semver-release-action), and further documentation is available there.


Troubleshooting
---

If you are experiencing issues with this try posting an issue on the [GitHub issues page](https://github.com/SU-SWS/stanford_profile/issues).

Contribution / Collaboration
---

You are welcome to contribute functionality, bug fixes, or documentation to this module. If you would like to suggest a fix or new functionality you may add a new issue to the GitHub issue queue or you may fork this repository and submit a pull request. For more help please see [GitHub's article on fork, branch, and pull requests](https://help.github.com/articles/using-pull-requests)
This module was consolidated into the SDSS profile at version 9.6.15 and will
no longer be consumed from the linked repo.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,48 +1,6 @@
# [Stanford Courses](https://github.com/SU-SWS/stanford_courses)
##### Version: 8.x-2.x

Maintainers: [Mike Decker](https://github.com/pookmish), [sherakama](https://github.com/sherakama)

Changelog: [Changelog.txt](CHANGELOG.txt)
# Stanford Courses

Description
---

The Stanford Courses module is used to import course information from ExploreCourses and format it for use in the Stanford Sites environments.

Accessibility
---
[![WCAG Conformance 2.0 AA Badge](https://www.w3.org/WAI/wcag2AA-blue.png)](https://www.w3.org/TR/WCAG20/)
Evaluation Date: 201X-XX-XX
This module conforms to level AA WCAG 2.0 standards as required by the university's accessibility policy. For more information on the policy please visit: [https://ucomm.stanford.edu/policies/accessibility-policy.html](https://ucomm.stanford.edu/policies/accessibility-policy.html).

Installation
---

Install this module like any other module. [See Drupal Documentation](https://drupal.org/documentation/install/modules-themes/modules-8)

Configuration
---

Nothing special needed.


Troubleshooting
---

If you are experiencing issues with this module try reverting the feature first. If you are still experiencing issues try posting an issue on the GitHub issues page.

Developer
---

If you wish to develop on this module you will most likely need to compile some new css. Please use the sass structure provided and compile with the sass compiler packaged in this module. To install:

```
npm install
npm run build
```

Contribution / Collaboration
---

You are welcome to contribute functionality, bug fixes, or documentation to this module. If you would like to suggest a fix or new functionality you may add a new issue to the GitHub issue queue or you may fork this repository and submit a pull request. For more help please see [GitHub's article on fork, branch, and pull requests](https://help.github.com/articles/using-pull-requests)
Original file line number Diff line number Diff line change
@@ -1,50 +1,8 @@
# [Stanford Events](https://github.com/SU-SWS/stanford_events)
##### Version: 8.x-1.0

Maintainers: [Mike Decker](https://github.com/pookmish), [sherakama](https://github.com/sherakama)

Changelog: [Changelog.txt](CHANGELOG.txt)
# Stanford Events

Description
---

The Stanford Events module allows Drupal site owners to create event type
content. Integration with events-legacy.stanford.edu is provided so site owners can
dynamically import content from that source.

Accessibility
---
[![WCAG Conformance 2.0 AA Badge](https://www.w3.org/WAI/wcag2AA-blue.png)](https://www.w3.org/TR/WCAG20/)
Evaluation Date: 201X-XX-XX
This module conforms to level AA WCAG 2.0 standards as required by the university's accessibility policy. For more information on the policy please visit: [https://ucomm.stanford.edu/policies/accessibility-policy.html](https://ucomm.stanford.edu/policies/accessibility-policy.html).

Installation
---

Install this module like any other module. [See Drupal Documentation](https://drupal.org/documentation/install/modules-themes/modules-8)

Configuration
---

Nothing special needed.


Troubleshooting
---

If you are experiencing issues with this module try reverting the feature first. If you are still experiencing issues try posting an issue on the GitHub issues page.

Developer
---

If you wish to develop on this module you will most likely need to compile some new css. Please use the sass structure provided and compile with the sass compiler packaged in this module. To install:

```
npm install
npm run build
```

Contribution / Collaboration
---

You are welcome to contribute functionality, bug fixes, or documentation to this module. If you would like to suggest a fix or new functionality you may add a new issue to the GitHub issue queue or you may fork this repository and submit a pull request. For more help please see [GitHub's article on fork, branch, and pull requests](https://help.github.com/articles/using-pull-requests)
Original file line number Diff line number Diff line change
@@ -1,63 +1,6 @@
# [Stanford News](https://github.com/SU-SOE/stanford_news)
##### Version: 8.x-2.x

[![CircleCI](https://circleci.com/gh/SU-SWS/stanford_news.svg?style=shield)](https://circleci.com/gh/SU-SWS/stanford_news)
[![Test Coverage](https://api.codeclimate.com/v1/badges/d22dd5e41d0a5c9198fd/test_coverage)](https://codeclimate.com/github/SU-SWS/stanford_news/test_coverage)
[![Maintainability](https://api.codeclimate.com/v1/badges/d22dd5e41d0a5c9198fd/maintainability)](https://codeclimate.com/github/SU-SWS/stanford_news/maintainability)

Maintainers: [boznik](https://github.com/boznik)

Changelog: [Changelog.md](CHANGELOG.md)
# Stanford News

Description
---

Stanford News feature provides an out of the box solution for displaying news content on your website. This feature contains a content type, fields, a news page layout, and taxonomy. This module is a great replacement for the default Article content type.

Accessibility
---
[![WCAG Conformance 2.0 AA Badge](https://www.w3.org/WAI/wcag2AA-blue.png)](https://www.w3.org/TR/WCAG20/)
Evaluation Date: N/A
This module conforms to level AA WCAG 2.0 standards as required by the university's accessibility policy. For more information on the policy please visit: [https://ucomm.stanford.edu/policies/accessibility-policy.html](https://ucomm.stanford.edu/policies/accessibility-policy.html).

Installation
---

Install this module like any other module. [See Drupal Documentation](https://drupal.org/documentation/install/modules-themes/modules-8)

Configuration
---

- Pull in this branch.
- Build.
- Add terms to the Topics taxonomy. They have a generated path.
- Create a menu with your taxonomy terms.
- Go to /admin/structure/types/manage/stanford_page/display and allow Topics Menus block to be added via the Layout Builder.
- Create articles and tag them with a term from the taxonomy.
- Create term list pages.
- They need paths like this: /news/term-1 (term name) or /news/all
- On this page, use the layout builder to add your menu.
- On this page, add the News Terms block.
- On this page, add the Newsletter Sign up block.


Troubleshooting
---

If you are experiencing issues with this module try reverting the feature first. If you are still experiencing issues try posting an issue on the GitHub issues page.

Developer
---

If you wish to develop on this module you will most likely need to compile some new css. Please use the sass structure provided and compile with the sass compiler packaged in this module. To install:

```
nvm use
npm install
npm run publish
```

Contribution / Collaboration
---

You are welcome to contribute functionality, bug fixes, or documentation to this module. If you would like to suggest a fix or new functionality you may add a new issue to the GitHub issue queue or you may fork this repository and submit a pull request. For more help please see [GitHub's article on fork, branch, and pull requests](https://help.github.com/articles/using-pull-requests)
Original file line number Diff line number Diff line change
@@ -1,50 +1,8 @@
# [Stanford Notifications](https://github.com/SU-SWS/stanford_notifications)
##### Version: 8.x-1.x

Maintainers: [Mike Decker](https://github.com/pookmish), [sherakama](https://github.com/sherakama)

Changelog: [Changelog.txt](CHANGELOG.txt)
# Stanford Notifications

Description
---

This module provides a way for users to receive notifications in the admin toolbar for a variety of purposes.

Notifications are entities and can be created via the entity type itself, or via the `notification_service` service.

Accessibility
---
[![WCAG Conformance 2.0 AA Badge](https://www.w3.org/WAI/wcag2AA-blue.png)](https://www.w3.org/TR/WCAG20/)
Evaluation Date: 2020-05-15
This module conforms to level AA WCAG 2.0 standards as required by the university's accessibility policy. For more information on the policy please visit: [https://ucomm.stanford.edu/policies/accessibility-policy.html](https://ucomm.stanford.edu/policies/accessibility-policy.html).

Installation
---

Install this module like any other module. [See Drupal Documentation](https://drupal.org/documentation/install/modules-themes/modules-8)

Configuration
---

Nothing special needed.


Troubleshooting
---

If you are experiencing issues with this module try reverting the feature first. If you are still experiencing issues try posting an issue on the GitHub issues page.

Developer
---

If you wish to develop on this module you will most likely need to compile some new css. Please use the sass structure provided and compile with the sass compiler packaged in this module. To install:

```
npm install
npm run build
```

Contribution / Collaboration
---

You are welcome to contribute functionality, bug fixes, or documentation to this module. If you would like to suggest a fix or new functionality you may add a new issue to the GitHub issue queue or you may fork this repository and submit a pull request. For more help please see [GitHub's article on fork, branch, and pull requests](https://help.github.com/articles/using-pull-requests)
Loading

0 comments on commit b45ed95

Please sign in to comment.