Skip to content

SIT-3007: Add usage reasons to readmes#249

Merged
jeffpaul merged 6 commits into
developfrom
docs/SIT-3007
Apr 27, 2022
Merged

SIT-3007: Add usage reasons to readmes#249
jeffpaul merged 6 commits into
developfrom
docs/SIT-3007

Conversation

@jeffpaul
Copy link
Copy Markdown
Contributor

Description of the Change

This PR begins to add some rationale as to why a Sophi integration might chose to use the Site Automation block or a custom Query integration. I'm going to look for additional input from @oscarssanchez to ensure this is as detailed as we can, then I'll replicate the update in README.md to readme.txt.

Alternate Designs

n/a

Possible Drawbacks

none identified

Verification Process

Use a markdown viewer to preview the changes in the README.md file.

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests passed.

Changelog Entry

Added - Documentation on rationale for block vs. custom query integration uses.

Credits

Props @jeffpaul.

@jeffpaul jeffpaul added this to the 1.0.14 milestone Apr 26, 2022
@jeffpaul jeffpaul requested a review from oscarssanchez April 26, 2022 13:33
@jeffpaul jeffpaul self-assigned this Apr 26, 2022
@jeffpaul
Copy link
Copy Markdown
Contributor Author

Comment thread README.md Outdated
- No additional development effort needed for initial Sophi integration
- Immediate integration with Sophi Site Automation API and page/widget settings
- Basic block display settings allow for basic configurations (show/hide post excerpt, author name, post date, featured image)
- Supports advanced CSS for further custom styling
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

As you can also add custom styling if you are manually integrating, I removed this line. Please let me know your thoughts @jeffpaul

Comment thread README.md Outdated
- Can implement support into non-block editor setups
- Likely more flexible for headless setups
- Block editor is not in-use within your WordPress environment
- Blocks are not available on category/taxonomy pages
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Made a small change there @jeffpaul let me know what you think.

@sonarqubecloud
Copy link
Copy Markdown

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@jeffpaul jeffpaul merged commit faaea91 into develop Apr 27, 2022
@jeffpaul jeffpaul deleted the docs/SIT-3007 branch April 27, 2022 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants