SHS-6015: Review and update humsci_basic theme readme.md

[mariannuar]

Summary

Review and update humsci_basic readme.md

Need Review By (Date)

01/24

Urgency

low

Notes

I asked H&S is HumSci Airy is still being used, because if it's not, to remove it from the diagram and the text. Still waiting for an answer.

Steps to Test

1. Confirm Diagram references Drupal 10
2. Confirm Diagram and the read me text is not showing any related to the legacy theme which is now removed
3. Branch names are updated
4. Since we are still using decanter, we still need it in the diagram and the text

Review Tasks

Backend / Functional Validation

Code

• Are the naming conventions following our standards?
• Are PHP functions and variables in snake_case and not camelCase?
• Does Drupal code follow Drupal Coding Standards?
• Does the code have sufficient inline comments?
• Is there anything in this code that would be hidden or hard to discover through the UI?
• Are there any code smells?
• Are tests provided?

Code security

• Is all user input properly sanitized when rendered?
• Any obvious security flaws or new areas for attack?

General

• Is there anything included in this PR that is not related to the problem it is trying to solve?
• Is the approach to the problem appropriate?

[cienvaras]

@mariannuar This is a good start, however there are some things that can be improved.

• Stanford Basic is still in the codebase, but not used anymore. It can be removed from the diagram
• Let's wait on @ahughes3 answer about Airy usage
• There are no site-specific themes, this can be removed from the diagram

The "Visual Regression Testing" section needs some improvements. For example, there's no clarity on the different systems available, the linting information is inside it even when it's not directly related to VRT, etc. Also, it would be a good idea to include some information on Tugboat Visual Diff (assuming we're using it). Add some general documentation on how can be used, how to add new pages, etc.

[mariannuar]

@cienvaras Thank you! I just updated it the readme.md file and the diagram according to your feedback. I think the only thing missing is the answer about Airy usage. I just asked @ahughes3 in the Slack channel. I'll wait!

[mariannuar]

Ready for review @cienvaras

[ahughes3]

Tugboat has finished building the preview for this pull request!

Links:

• https://pr1718-v08zezcmhek1ta5ajhvuusxpqr8cmbpl.tugboatqa.com
• https://hs-colorful-v08zezcmhek1ta5ajhvuusxpqr8cmbpl.tugboatqa.com
• https://hs-traditional-v08zezcmhek1ta5ajhvuusxpqr8cmbpl.tugboatqa.com
• https://english-v08zezcmhek1ta5ajhvuusxpqr8cmbpl.tugboatqa.com
• https://history-v08zezcmhek1ta5ajhvuusxpqr8cmbpl.tugboatqa.com
• https://west-v08zezcmhek1ta5ajhvuusxpqr8cmbpl.tugboatqa.com

Dashboard:

• https://dashboard.tugboatqa.com/678834929687054ac332d885

Visual Diffs:

• https://dashboard.tugboatqa.com/678834929687054ac332d885/visualdiffs