Skip to content
This repository has been archived by the owner on Jul 1, 2024. It is now read-only.

fix(docs-testimonial): Update Testimonial Addition Process #10123

Merged

Conversation

ArvindParekh
Copy link
Member

Fixes Issue

Closes #10055

Changes proposed

Updated the Testimonial addition process in the docs, now that the Add Testimonial button has been removed.
The new process now includes the following steps:

  • Go to the Issues Tab
  • Create a new Issue
  • Select the type 🏆 Testimonial
  • Fill in your testimonial

Check List (Check all the applicable boxes)

  • My code follows the code style of this project.
  • My change requires changes to the documentation.
  • I have updated the documentation accordingly.
  • All new and existing tests passed.
  • This PR does not contain plagiarized content.
  • The title of my pull request is a short description of the requested changes.

Screenshots

Before:

image

After:

image

Note to reviewers

@github-actions github-actions bot added 📖 docs Documentation pages issue linked Pull Request has issue linked labels Jan 11, 2024
@ArvindParekh
Copy link
Member Author

Also, there's another image that may need updating:

image

This image is based on the fact that an issue with type "testimonial" has been created through the Add Testimonial button (and has a pre-populated field of user), which is not the case now. The new issue now will not have any pre-populated field.
Considering this, do you prefer that I update the image as well? It's a minor change, but we can do it for consistency. Let me know what you think.

@ThomasCode92
Copy link
Member

As you suggested, I would update the image as well for consistency.
Upon approval of this PR, the documentation for adding testimonials will be accurate and complete.

Copy link
Member

@eddiejaoude eddiejaoude left a comment

Choose a reason for hiding this comment

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

Thank you 👍

@eddiejaoude
Copy link
Member

Also, there's another image that may need updating:

image

This image is based on the fact that an issue with type "testimonial" has been created through the Add Testimonial button (and has a pre-populated field of user), which is not the case now. The new issue now will not have any pre-populated field. Considering this, do you prefer that I update the image as well? It's a minor change, but we can do it for consistency. Let me know what you think.

this can come in another issue/PR - having the pre-filled image I think it is good, it gives them an example, but the repo name is the previous (old) repo name, so it would be good to update. I will merge this PR so not to block the value it already adds to the users

@eddiejaoude eddiejaoude merged commit da3abc6 into EddieHubCommunity:main Jan 11, 2024
13 checks passed
@ArvindParekh
Copy link
Member Author

Also, there's another image that may need updating:
image
This image is based on the fact that an issue with type "testimonial" has been created through the Add Testimonial button (and has a pre-populated field of user), which is not the case now. The new issue now will not have any pre-populated field. Considering this, do you prefer that I update the image as well? It's a minor change, but we can do it for consistency. Let me know what you think.

this can come in another issue/PR - having the pre-filled image I think it is good, it gives them an example, but the repo name is the previous (old) repo name, so it would be good to update. I will merge this PR so not to block the value it already adds to the users

I understand. I can update the image to reflect the new repo name, also pre-populating the name field.
Should I just directly raise a pr for that and reference this pr, or would you like me to create a new issue?

@eddiejaoude
Copy link
Member

Please create an issue first

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
📖 docs Documentation pages issue linked Pull Request has issue linked
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Update Testimonial Addition Process in Docs
3 participants