Broken links in https://lbry.tech/contribute #305

Closed
opened 2019-10-26 10:44:28 +02:00 by apoorva-mk · 11 comments
apoorva-mk commented 2019-10-26 10:44:28 +02:00 (Migrated from github.com)

Other than the first link to "Ecosystem Overview" all others seem to be broken.

Other than the first link to "Ecosystem Overview" all others seem to be broken.
apoorva-mk commented 2019-10-26 10:44:45 +02:00 (Migrated from github.com)

I would like to work on this issue.

I would like to work on this issue.
tzarebczan commented 2019-10-26 14:59:14 +02:00 (Migrated from github.com)

There may be a pr to fix this already. Which link in particular?

There may be a pr to fix this already. Which link in particular?
tzarebczan commented 2019-10-26 15:32:18 +02:00 (Migrated from github.com)

Looks like it's still broken, feel free to submit a PR.

Looks like it's still broken, feel free to submit a PR.
apoorva-mk commented 2019-10-26 22:15:38 +02:00 (Migrated from github.com)

Thanks I will send a PR immediately @tzarebczan

Thanks I will send a PR immediately @tzarebczan
dougwebb commented 2020-01-02 20:22:48 +01:00 (Migrated from github.com)

It looks like there are still broken links. For example, https://lbry.com/bounty/lbry-binding (which is on the https://lbry.tech/resources/api-wrappers page) redirects to https://lbry.tech/contribute but there's nothing there about developing new bindings.

Also, https://lbry.tech/api/sdk just sits in a loop reloading itself. Tested on both Firefox and Chrome. No error messages showing up in the console. Something in the javascript is making the page refresh.

It looks like there are still broken links. For example, https://lbry.com/bounty/lbry-binding (which is on the https://lbry.tech/resources/api-wrappers page) redirects to https://lbry.tech/contribute but there's nothing there about developing new bindings. Also, https://lbry.tech/api/sdk just sits in a loop reloading itself. Tested on both Firefox and Chrome. No error messages showing up in the console. Something in the javascript is making the page refresh.
tzarebczan commented 2020-01-02 20:24:34 +01:00 (Migrated from github.com)

Thanks Doug - do you wanna take a shot at fixing them? Would be much appreciated!

Thanks Doug - do you wanna take a shot at fixing them? Would be much appreciated!
dougwebb commented 2020-01-02 20:39:04 +01:00 (Migrated from github.com)

I would if I could, but I'm looking around in the lbry.tech repo and I
can't find the API docs or bounty page, so I have no idea what the fixes
would be.
I did find https://github.com/lbryio/lbry-sdk/blob/master/docs/api.json
which appears to be the source for the API reference documentation, but I'm
not familiar with tools for turning that into a webpage. I'd also
expect/hope to see tutorial/overview style documentation to go along with
the auto-generated reference documentation.

For what it's worth, I'd be interested in contributing a C# binding for the
API. I've written C# wrappers for a bunch of REST/JSON apis for electronic
payments, so I could get a lbry wrapper put together easily. If api.json is
authoritative, I'd also look at using it to auto-generate the C# wrapper
code so it's easy to update after API changes.

Doug.

On Thu, Jan 2, 2020 at 2:24 PM Thomas Zarebczan notifications@github.com
wrote:

Thanks Doug - do you wanna take a shot at fixing them? Would be much
appreciated!


You are receiving this because you commented.
Reply to this email directly, view it on GitHub
https://github.com/lbryio/lbry.tech/issues/305?email_source=notifications&email_token=AAHISZEBCKLMYGZTZO763ULQ3Y5PFA5CNFSM4JFMOCBKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEH7E4HI#issuecomment-570314269,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AAHISZAU26KQLXN2MVLMDKLQ3Y5PFANCNFSM4JFMOCBA
.

I would if I could, but I'm looking around in the lbry.tech repo and I can't find the API docs or bounty page, so I have no idea what the fixes would be. I did find https://github.com/lbryio/lbry-sdk/blob/master/docs/api.json which appears to be the source for the API reference documentation, but I'm not familiar with tools for turning that into a webpage. I'd also expect/hope to see tutorial/overview style documentation to go along with the auto-generated reference documentation. For what it's worth, I'd be interested in contributing a C# binding for the API. I've written C# wrappers for a bunch of REST/JSON apis for electronic payments, so I could get a lbry wrapper put together easily. If api.json is authoritative, I'd also look at using it to auto-generate the C# wrapper code so it's easy to update after API changes. Doug. On Thu, Jan 2, 2020 at 2:24 PM Thomas Zarebczan <notifications@github.com> wrote: > Thanks Doug - do you wanna take a shot at fixing them? Would be much > appreciated! > > — > You are receiving this because you commented. > Reply to this email directly, view it on GitHub > <https://github.com/lbryio/lbry.tech/issues/305?email_source=notifications&email_token=AAHISZEBCKLMYGZTZO763ULQ3Y5PFA5CNFSM4JFMOCBKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEH7E4HI#issuecomment-570314269>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AAHISZAU26KQLXN2MVLMDKLQ3Y5PFANCNFSM4JFMOCBA> > . >
tzarebczan commented 2020-01-02 20:41:59 +01:00 (Migrated from github.com)

We've updated the api links, should work now. The bounty page is gone and should be removed.

We've updated the api links, should work now. The bounty page is gone and should be removed.
misspellted commented 2020-02-05 06:32:22 +01:00 (Migrated from github.com)

I was reviewing the Contributor's Guide, and it looks as if there are still a couple of broken links trying to connect to the Ecosystem Overview:

  • contribute.md#reporting-a-bug
  • contribute.md#feature-requests

After following the procedure for Reporting a Bug, I discovered that @apoorva-mk had already created the issue, but I do not see a follow-up PR addressing the 2 broken Ecosystem Overview links noted above.

Additionally, I was unable to find the template for reporting a bug for this repository. Should that be a separate issue? I don't know if the following is sufficient (it is a format I've used in prior roles), but to expand on the initial report by @apoorva-mk:

Expected Behavior
Clicking on the ecosystem overview links under the Reporting a Bug or Feature Requests sections of the Contributor's Guide takes the viewer to the Ecosystem Overview diagram in the Overview article that the Ecosystem Overview link does in the Repository Overview section.

Actual Behavior
Clicking on the ecosystem overview links under the Reporting a Bug or Feature Requests sections of the Contributor's Guide does not take the viewer to the Ecosystem Overview diagram in the Overview article.

Observational Environment
Platform: Pop!_OS 19.10
Browser: Firefox 72.0.1 (64-bit)

Steps to Reproduce
Open the Contributor's Guide in a browser.
Scroll to the Repository Overview section.
Click on the Ecosystem Overview link in the Repository Overview section.
Observe the Ecosystem Overview diagram in the Overview article opened in the same tab.
Return to the Contributor's Guide using the browser's Back navigation.
Scroll to the Report a Bug section.
Click on the ecosystem overview link in the Repository Overview section.
Observe the lack of the browser navigating to the Overview article to show the Ecosystem Overview diagram.
Scroll to the Features Requests section.
Click on the ecosystem overview link in the Repository Overview section.
Observe the lack of the browser navigating to the Overview article to show the Ecosystem Overview diagram.
Scroll slightly up to the appreciation link at the bottom of the Report a Bug section.
Click the appreciation link.
Observe the browser scroll down to the Appreciation section of the Contributor's Guide.

Demonstration
And if the StR portion is too much to read, I captured it in a short video: lbry://@misspellted#a/some-contrib-guide-eco-view-links-broken#1

I was reviewing the Contributor's Guide, and it looks as if there are still a couple of broken links trying to connect to the Ecosystem Overview: * contribute.md#reporting-a-bug * contribute.md#feature-requests After following the procedure for Reporting a Bug, I discovered that @apoorva-mk had already created the issue, but I do not see a follow-up PR addressing the 2 broken Ecosystem Overview links noted above. Additionally, I was unable to find the template for reporting a bug for this repository. Should that be a separate issue? I don't know if the following is sufficient (it is a format I've used in prior roles), but to expand on the initial report by @apoorva-mk: **Expected Behavior** Clicking on the ecosystem overview links under the Reporting a Bug or Feature Requests sections of the Contributor's Guide takes the viewer to the Ecosystem Overview diagram in the Overview article that the Ecosystem Overview link does in the Repository Overview section. **Actual Behavior** Clicking on the ecosystem overview links under the Reporting a Bug or Feature Requests sections of the Contributor's Guide does not take the viewer to the Ecosystem Overview diagram in the Overview article. **Observational Environment** Platform: Pop!_OS 19.10 Browser: Firefox 72.0.1 (64-bit) **Steps to Reproduce** Open the Contributor's Guide in a browser. Scroll to the Repository Overview section. Click on the Ecosystem Overview link in the Repository Overview section. Observe the Ecosystem Overview diagram in the Overview article opened in the same tab. Return to the Contributor's Guide using the browser's Back navigation. Scroll to the Report a Bug section. Click on the ecosystem overview link in the Repository Overview section. Observe the lack of the browser navigating to the Overview article to show the Ecosystem Overview diagram. Scroll to the Features Requests section. Click on the ecosystem overview link in the Repository Overview section. Observe the lack of the browser navigating to the Overview article to show the Ecosystem Overview diagram. Scroll slightly up to the appreciation link at the bottom of the Report a Bug section. Click the appreciation link. Observe the browser scroll down to the Appreciation section of the Contributor's Guide. **Demonstration** And if the StR portion is too much to read, I captured it in a short video: lbry://@misspellted#a/some-contrib-guide-eco-view-links-broken#1
tzarebczan commented 2020-02-06 01:44:10 +01:00 (Migrated from github.com)

Hey @misspellted , thanks for following up on this! Wanna take a shot at fixing it? They should just point to repository-overview instead of ecosystem-overview .

Hey @misspellted , thanks for following up on this! Wanna take a shot at fixing it? They should just point to repository-overview instead of ecosystem-overview .
misspellted commented 2020-02-06 02:34:21 +01:00 (Migrated from github.com)

Sure, I'll give it a try tonight.

Sure, I'll give it a try tonight.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: LBRYCommunity/lbry.tech#305
No description provided.