Skip to content

[TRI-1428] : Improve the SendGrid integration documentation - #671

Merged
D-K-P merged 6 commits into
triggerdotdev:docs-improvementsfrom
Rutam21:TRI-1428
Oct 27, 2023
Merged

[TRI-1428] : Improve the SendGrid integration documentation#671
D-K-P merged 6 commits into
triggerdotdev:docs-improvementsfrom
Rutam21:TRI-1428

Conversation

@Rutam21

@Rutam21 Rutam21 commented Oct 20, 2023

Copy link
Copy Markdown
Contributor

Closes #662

✅ Checklist

  • I have followed every step in the contributing guide
  • The PR title follows the convention.
  • I ran and tested the docs site and it works properly.

Testing

I locally deployed the Docs Website using Netlify and verified all the changes.

Video Snapshot

SendGrid.mp4

Changelog

The SendGrid Documentation has been updated such that it follows the same format as the GitHub Integration.

SendGrid Documentation is now divided into two sections.

  • SendGrid Overview and Authentication
  • SendGrid tasks

Screenshots

Overview and Authentication Page

overview

Tasks Page

tasks1

tasks2

@changeset-bot

changeset-bot Bot commented Oct 20, 2023

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 4768dc4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@Rutam21

Rutam21 commented Oct 20, 2023

Copy link
Copy Markdown
Contributor Author

This PR exactly follows the GitHub Integration format.

  • An overview section has been added based on the official SendGrid Site.
  • Both the Overview and Tasks pages have been separated properly.
  • Comments have been added to all the code blocks for better understanding.

Please review and suggest changes, if any. Thanks.

cc: @D-K-P

@D-K-P

D-K-P commented Oct 23, 2023

Copy link
Copy Markdown
Member

@Rutam21 this is close:

Overview

  • Add a link to the sendgrid docs for how to create an api key

Tasks

  • Remove payloads and put examples. "< your-email-address >" etc

Thanks!

@Rutam21

Rutam21 commented Oct 23, 2023

Copy link
Copy Markdown
Contributor Author

@D-K-P I have included all the suggested changes. Please review. Thanks.

@Rutam21

Rutam21 commented Oct 26, 2023

Copy link
Copy Markdown
Contributor Author

@D-K-P I believe this PR is now ready for merge. Thanks.

@D-K-P
D-K-P changed the base branch from main to docs-improvements October 27, 2023 13:36
@D-K-P

D-K-P commented Oct 27, 2023

Copy link
Copy Markdown
Member

Resolve the conflicts and I'll merge @Rutam21 - thank you!

@Rutam21

Rutam21 commented Oct 27, 2023

Copy link
Copy Markdown
Contributor Author

@D-K-P Merge conflicts are resolved.

@D-K-P
D-K-P merged commit 8321adf into triggerdotdev:docs-improvements Oct 27, 2023
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.

[TRI-1428] Improve the SendGrid integration documentation

2 participants