Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restore bitly functionality to create shortlinks within the KB #1065

Closed
akatsoulas opened this issue Jul 5, 2022 · 9 comments
Closed

Restore bitly functionality to create shortlinks within the KB #1065

akatsoulas opened this issue Jul 5, 2022 · 9 comments
Assignees
Labels
bug Something isn't working

Comments

@akatsoulas
Copy link
Collaborator

No description provided.

@akatsoulas akatsoulas added the bug Something isn't working label Jul 5, 2022
@akatsoulas akatsoulas added this to Triage in SUMO Engineering Board via automation Jul 5, 2022
@akatsoulas akatsoulas moved this from Triage to Next Items in SUMO Engineering Board Jul 5, 2022
@akatsoulas akatsoulas moved this from Next Items to In Progress in SUMO Engineering Board Jul 14, 2022
@akatsoulas akatsoulas self-assigned this Jul 29, 2022
@akatsoulas akatsoulas moved this from In Progress to Review in SUMO Engineering Board Aug 2, 2022
@akatsoulas akatsoulas moved this from Review to Merged in SUMO Engineering Board Aug 3, 2022
@akatsoulas akatsoulas moved this from Merged to QA in SUMO Engineering Board Aug 4, 2022
@kelimuttu
Copy link
Collaborator

I was asked by @mirunacurtean to test this functionality. There are a few things I'd like to clarify after I tested this:

  • I found that the link is locale-specific. I'm not sure if this was intended. The thing with this is that, contributors often share the shortened link to users, which may use a different locale. With regards to this scenario, it's actually better to use a locale-agnostic link so users will be directed to their preference locale automatically. This being said, this will require a different approach, which is, that we will have the same shortened link for the same article in different locales.
  • Regardless of the above point, I found that the current automation doesn't work for Indonesian locale. For example: this article (for comparison, this is the same article for de, fr, or ko). I haven't tested all locales, but out of 15 locales that I tested, this only happen with id locale.

@mirunacurtean
Copy link
Collaborator

mirunacurtean commented Aug 9, 2022

Thank you @kelimuttu You've done in a very short time what I was trying to figure out on and off for a while. Do you know if this is that way it worked before? As noted in the title of this ticket, the purpose is to restore the bitly functionality present at some time in the past, and we need to understand if these are regressions or just new issues to tackle separately.
CC @escattone for awarness in relation to the the release planning.

@kelimuttu
Copy link
Collaborator

@mirunacurtean I'm not aware of how it was before. It's been a while since the automation was broken. But I can check with contributors who may know better than me.

@mirunacurtean
Copy link
Collaborator

@mirunacurtean I'm not aware of how it was before. It's been a while since the automation was broken. But I can check with contributors who may know better than me.

@kelimuttu Yes, please. That would be quite useful. The conversation thread can be linked in the ticket, after.

@kelimuttu
Copy link
Collaborator

@mirunacurtean A contributor pointed me out to an old bug which refer to this PR that seems useful for historical context. From what I can catch, at least there are two more requirements for this functionality:

  • The automation should also work for new article (not sure if you have tested this)
  • KB articles that are part of the “Admin” category should be exempted from this automation as they are meant to be accessed from an in-product link

@mirunacurtean
Copy link
Collaborator

mirunacurtean commented Aug 9, 2022

@mirunacurtean A contributor pointed me out to an old bug which refer to this PR that seems useful for historical context. From what I can catch, at least there are two more requirements for this functionality:

  • The automation should also work for new article (not sure if you have tested this)
  • KB articles that are part of the “Admin” category should be exempted from this automation as they are meant to be accessed from an in-product link

@kelimuttu I can confirm the new article share link automation (which on stage had been deactivated the previous days and it also works by generating links in 6 hour cycles)
Test articles:

  1. https://support.allizom.org/en-US/kb/share-article
  2. https://support.allizom.org/en-US/kb/copy-paste

For the second point, I will create some test data this evening and hopefully it will be good to check and to go by tomorrow morning.
Updating with new articles:

  1. https://support.allizom.org/en-US/kb/admin-article-test
  2. https://support.allizom.org/de/kb/sprache-eingabe-erkennung

Thank you

@escattone
Copy link
Contributor

@kelimuttu @mirunacurtean Thanks so much for all of your work on this. I can confirm that the Bitly functionality was restored as it was in the past. In other words, the logic of generating short links did not change. So I think we should open one or more tickets with any new issues that were found.

One more thing. I did check the current code, and I see that we do not include the locale when generating the short link, so we'll have to look into that some more.

@mirunacurtean
Copy link
Collaborator

@mirunacurtean A contributor pointed me out to an old bug which refer to this PR that seems useful for historical context. From what I can catch, at least there are two more requirements for this functionality:

  • The automation should also work for new article (not sure if you have tested this)
  • KB articles that are part of the “Admin” category should be exempted from this automation as they are meant to be accessed from an in-product link

@kelimuttu I can confirm the new article share link automation (which on stage had been deactivated the previous days and it also works by generating links in 6 hour cycles) Test articles:

  1. https://support.allizom.org/en-US/kb/share-article
  2. https://support.allizom.org/en-US/kb/copy-paste

For the second point, I will create some test data this evening and hopefully it will be good to check and to go by tomorrow morning. Updating with new articles:

  1. https://support.allizom.org/en-US/kb/admin-article-test
  2. https://support.allizom.org/de/kb/sprache-eingabe-erkennung

Thank you

Morning. I've verfied that these articles have/ or don't have shortlinks, as expected.

@kelimuttu @mirunacurtean Thanks so much for all of your work on this. I can confirm that the Bitly functionality was restored as it was in the past. In other words, the logic of generating short links did not change. So I think we should open one or more tickets with any new issues that were found.

One more thing. I did check the current code, and I see that we do not include the locale when generating the short link, so we'll have to look into that some more.

I've added this new ticket for all the locale specific work, to be further discussed and defined.

So with all that done, I'm marking this as Ready for Release.

@mirunacurtean mirunacurtean moved this from QA to Ready for release in SUMO Engineering Board Aug 10, 2022
@kelimuttu
Copy link
Collaborator

@kelimuttu @mirunacurtean Thanks so much for all of your work on this. I can confirm that the Bitly functionality was restored as it was in the past. In other words, the logic of generating short links did not change. So I think we should open one or more tickets with any new issues that were found.

Sounds good to me.

@mirunacurtean I'd like to get some clarification about the issue that you just created. But let's talk more about that in #1082

@escattone escattone moved this from Ready for release to Done in SUMO Engineering Board Aug 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
No open projects
Development

No branches or pull requests

4 participants