glosseta icon indicating copy to clipboard operation
glosseta copied to clipboard

[Feature]: Add a page/form for requesting new definitions

Open narbs91 opened this issue 3 years ago • 13 comments

Context

Users landing on the site will likely run into a scenario where a given term is not available because there is no entry in the knowledge bank. No one to date has used the social media links for requesting a new term and it might be because it's not obvious.

Problem and/or Opportunity

The aim of this feature request is to add a page/form to the site to allow the average person to submit a definition request. This will help those who are non-tech savy be able to request a definition without having to open up a github request (for example).

Proposed Solution

The proposed solution is to create a new static page (/request-term) that houses a form with the following required elements:

  • term
  • category (from a predefined set of choices)
  • why this term should be added

Essentially this form mimics the Definition intake request template.

When submitted, the hope is to find a way to automatically create a GitHub issue in the repo programatically with the information provided. Research will need to be done to see if this is viable to do.

Note: A new navigation item titled Request term will need to be added

Testing the changes

Testing the changes will requires creating unit tests for the new page, manually smoke testing and ensuring existing functionality is not broken.

Additional Information

No response

narbs91 avatar Jan 04 '22 05:01 narbs91

Useful documentation

  • https://docs.github.com/en/graphql/guides/forming-calls-with-graphql
  • https://docs.github.com/en/graphql
  • https://docs.github.com/en/graphql/reference/input-objects#createissueinput

narbs91 avatar Jan 05 '22 01:01 narbs91

Hi @narbs91,

I'd like to express interest in contributing to this feature request. Let me know of other things I might need to get started.

Regards, @naftalimurgor

naftalimurgor avatar Jan 15 '22 10:01 naftalimurgor

Hi @narbs91,

I'd like to express interest in contributing to this feature request. Let me know of other things I might need to get started.

Regards,

@naftalimurgor

For sure @naftalimurgor ! Thanks for stepping up to take this on 😃 . I think most of the details are there but we may need to utilize a GitHub auth token to utilize their api. I haven't used the api before but it's something that can easily be addressed if that the case. I'll assign this issue to you

narbs91 avatar Jan 15 '22 18:01 narbs91

Hello @narbs91

Greetings! Just a heads up, I'm working on this issue and will submit a PR over the course of this week after It's done.

naftalimurgor avatar Jan 23 '22 11:01 naftalimurgor

Hello @narbs91

Greetings! Just a heads up, I'm working on this issue and will submit a PR over the course of this week after It's done.

Awesome, thank you @naftalimurgor ! Let me know if you have any questions. Also, heads up that I also have a decently sized change nearing completion

narbs91 avatar Jan 23 '22 19:01 narbs91

Hi @narbs91

Good to hear. I might need some help with the API stuff as I work on this

naftalimurgor avatar Jan 23 '22 21:01 naftalimurgor

Hi @narbs91

Good to hear. I might need some help with the API stuff as I work on this

Sounds good @naftalimurgor , I think that's the only grey area with this issue; however, don't hesitate to throw up a draft PR and we can work through any road blocks you might come across

narbs91 avatar Jan 23 '22 22:01 narbs91

Hi @naftalimurgor just checking in, how are things going here?

narbs91 avatar Feb 03 '22 02:02 narbs91

Hi @narbs91 Sorry for the delayed response I got held up preparing and attending interviews as I am job hunting 😄 and also recently moved out. Things are going well. I'm working on this issue.

I got a couple of questions:

  1. What do route name do we use for the new term request page

I will submit a WIP PR as I work on this Thanks, Naftali

naftalimurgor avatar Feb 09 '22 09:02 naftalimurgor

Hi @narbs91 Sorry for the delayed response I got held up preparing and attending interviews as I am job hunting 😄 and also recently moved out. Things are going well. I'm working on this issue.

I got a couple of questions:

  1. What do route name do we use for the new term request page

I will submit a WIP PR as I work on this Thanks, Naftali

No problem at all and great to hear things are going well :), take your time and no rush. As for the route, I say lets keep it simple and go with /request-definition

narbs91 avatar Feb 10 '22 05:02 narbs91

@naftalimurgor I made some mocks of what I think the Request a term feature should look like in the following figma:

https://www.figma.com/file/CFNZbJNVaggeZHpETM5h2K/Glosseta-assets?node-id=1%3A21

(Click into the request a term mocks)

Also, i think the page name should revert back to /request-term

Please do let me know if you have any questions or anything

narbs91 avatar Mar 29 '22 04:03 narbs91

@narbs91 Really awesome! I will let you know in case of any questions.

naftalimurgor avatar Mar 29 '22 07:03 naftalimurgor

This was prematurely closed, my apologies

narbs91 avatar Apr 11 '22 03:04 narbs91