The Wayback Machine - https://web.archive.org/web/20210218191835/https://github.com/rwaldron/johnny-five/issues/1489
Skip to content

/ johnny-five

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

Jump to bottom

Broken links in official docs in the website #1489

Open
mjguru opened this issue Jul 28, 2018 · 13 comments
Open

Broken links in official docs in the website #1489

mjguru opened this issue Jul 28, 2018 · 13 comments
Labels
DOCS Good First Issue Hardware Not Required

Comments

@mjguru
Copy link

@mjguru mjguru commented Jul 28, 2018

Specifically, these are the pages from wiki which have both plural and singular versions and link from one to other (usually under the heading See Also). I am listing the links of ones I found to be broken:

  1. Boards. The link to Board at 'See also: Board.'
  2. ESC. The link to ESCs at 'If you are interested in working with multiple ESCs, see the ESCs page.'
  3. ESCs. The link to ESC at 'For working with a single ESC check out the ESC class.'
  4. Leds. The link to Led at 'For working with a single Led check out the Led class.'
  5. Motors. The link to Motor at 'For working with a single motor check out the Motor class.'
  6. Relays. The link to Relay at 'For working with a single relay check out the Relay class.'
  7. Servos. The link to Servo at 'For working with a single servo check out the Servo class.'

I think the issue underlying all these is that in the plural linked page, link to the singular version is appended to the url instead of replacing the plural version.
@mjguru
Copy link
Author

@mjguru mjguru commented Jul 28, 2018

How are the docs ported from wiki to the website. I mean I am down to help if needed.
@dtex
Copy link
Collaborator

@dtex dtex commented Jul 28, 2018 •
edited

@mjguru This page documents the process, but if you just want to edit the wiki on this repo then someone can deploy the changes to the website for you.

We appreciate the help!
@mjguru
Copy link
Author

@mjguru mjguru commented Jul 29, 2018

I investigated a little. It seems that any link from a main wiki page to other wiki page is broken. The reason is because we are using relative urls. So, lets say that in Motors page we are linking to Motor. We will have a relative url with href attribute 'motor'. Here's the deal: On Github Wiki, relative urls replace the word after wiki so motors becomes motor on clicking. While, in the website, the relative url gets appended to motors. So, the url becomes /motors/motor. I think instead of changing the wiki, we should make a rule or something in deployment to fix this. Maybe a script could help with relative url as ../motor say instead of motor directly.
@dtex
Copy link
Collaborator

@dtex dtex commented Jul 29, 2018

In that case, the fix would probably need to be made in this repo:

https://github.com/johnny-five-io/johnny-five.io
@mjguru
Copy link
Author

@mjguru mjguru commented Jul 29, 2018

Here's the deal, we have absolute links in some places while relative in others. The ones that work are those that have absolute links in wiki markdown pages. Also, there is an issue of capitalization. Like in wiki, if the link is to say Relay, then it works fine even though the actual link is relay. So, the links in wiki must also be relay and not Relay.
@mjguru
Copy link
Author

@mjguru mjguru commented Jul 29, 2018

I am gonna go ahead and try changing the wiki.
@mjguru
Copy link
Author

@mjguru mjguru commented Jul 29, 2018

Okay, I made relevant changes in as many wiki pages as I could. I guess we could redeploy the website? How do we do that? I am having trouble understanding the procedure in the Readme.
@mjguru mjguru mentioned this issue Jul 30, 2018
Merged
@reconbot reconbot reopened this Aug 8, 2018
@reconbot
Copy link
Collaborator

@reconbot reconbot commented Aug 8, 2018

Let me know if it looks in good shape and then we can close this issue.
@mjguru
Copy link
Author

@mjguru mjguru commented Aug 18, 2018

Alas no! There are still broken links for example the link from esc to escs page is broken. I guess I could take a look again.
@rwaldron
Copy link
Owner

@rwaldron rwaldron commented Aug 19, 2018

This has been fixed

Once someone has a chance to verify that the links in all of these are consistent and correct, we will close this issue.
@dtex
Copy link
Collaborator

@dtex dtex commented Aug 19, 2018

@stale stale bot added stale and removed stale labels Aug 15, 2019
@stale stale bot added stale and removed stale labels Aug 9, 2020
@reconbot
Copy link
Collaborator

@reconbot reconbot commented Aug 9, 2020

@dtex this issue, why not?
Repository owner deleted a comment from stale bot Aug 9, 2020
Repository owner deleted a comment from stale bot Aug 9, 2020
@dtex
Copy link
Collaborator

@dtex dtex commented Aug 9, 2020

I'll just drop them here. Rick fixed a bunch of them, but here's what's left.

Error URL Appears On
404 http://johnny-five.io/img/j5-campaign-small-2x.gif http://johnny-five.io FIELD5
404 http://johnny-five.io/img/j5-campaign.gif http://johnny-five.io
404 http://johnny-five.io/api/Requested-Features http://johnny-five.io/api/
404 https://software.intel.com/en-us/node/672326 2 instances over more than one page
404 https://github.com/linino/linino_distro http://johnny-five.io/platform-support/
404 http://www.pcduino.com/wiki/index.php?title=Book http://johnny-five.io/platform-support/
404 http://www.mediatek.com/en/products/connectivity/gps/mt3339 http://johnny-five.io/news/johnny-five-gps-class/
404 http://johnny-five.io/examples/keypad-MPR121QR2 2 instances over more than one page
404 http://www.anz.ru/files/mediatek/MT7620_Datasheet.pdf http://johnny-five.io/news/tessel-2-chipkit-uno32-sparkfun-edison-arduino-block/
404 http://www.amazon.com/MS5611-High-resolution-Atmospheric-Pressure-Module/dp/B00F4P6LKE?utm_source=j5 5 instances over more than one page
404 http://tiny-circuits.com/products/tinyduino http://johnny-five.io/api/board/
404 http://www.mediatek.com/en/products/connectivity/gps/mt3339?utm_source=j5 http://johnny-five.io/api/gps/
404 https://github.com/rwaldron/johnny-five/blob/master/docs/led-rgb-PCA9685.md http://johnny-five.io/api/led.rgb/
404 http://osepp.com/products/sensors-arduino-compatible/osepp-ir-proximity-sensor-module http://johnny-five.io/api/motion/
404 https://github.com/rwaldron/johnny-five/releases/tag/v0.9.12 3 instances over more than one page
404 https://www.servocity.com/html/hsr-1425cr__continuous_rotatio.html http://johnny-five.io/api/servo/
404 https://dl.dropboxusercontent.com/u/3531958/external-servo-power.png http://johnny-five.io/api/servo/
404 http://www.maximintegrated.com/en/products/analog/sensors-and-sensor-interface/DS18B20.html http://johnny-five.io/api/thermometer/
404 http://johnny-five.io/api/collection 4 instances over more than one page
404 http://www.seeedstudio.com/wiki/images/0/03/Serial_LEC_RGB_Backlight_Lcd.jpg 5 instances over more than one page
404 http://johnny-five.io/api/orientation http://johnny-five.io/examples/imu-bno055-orientation/
404 http://www.maximintegrated.com/en/products/analog/sensors-and-sensor-interface/DS18S20.html 2 instances over more than one page
404 https://github.com/rwaldron/johnny-five/raw/master/multi-TH02.png http://johnny-five.io/examples/grove-humidity-temperature-edison/
404 http://www.seeedstudio.com/wiki/images/0/01/Grove_-_touch_sensor_Photo.jpg 3 instances over more than one page
404 http://www.seeedstudio.com/wiki/images/thumb/b/b0/Thermometer1.jpg/400px-Thermometer1.jpg http://johnny-five.io/examples/grove-lcd-rgb-temperature-display-edison/
404 http://www.seeedstudio.com/wiki/images/thumb/b/b0/Temperature1.jpg/400px-Temperature1.jpg http://johnny-five.io/examples/grove-lcd-rgb-temperature-display/
404 http://www.dagurobot.com/goods.php?id=137 3 instances over more than one page
500 https://shop.tessel.io http://johnny-five.io/news/tessel-2-chipkit-uno32-sparkfun-edison-arduino-block/
Hostname http://support.pinocc.io/hc/en-us/articles/201439160-Out-of-the-Box http://johnny-five.io/platform-support/
Hostname https://getchip.com http://johnny-five.io/news/linux-io/
Hostname http://getchip.com http://johnny-five.io/news/the-next-thing-co.-c.h.i.p./
Hostname http://www.gtop-tech.com/en/product/LadyBird-1-PA6H/MT3339_GPS_Module_04.html http://johnny-five.io/news/johnny-five-gps-class/
Hostname http://www.gtop-tech.com/en/product/LadyBird-1-PA6H/MT3339_GPS_Module_04.html?utm_source=j5 http://johnny-five.io/api/gps/
Hostname http://comingsoon.radioshack.com/radioshack-ultrasonic-range-sensor/2760342.html http://johnny-five.io/api/proximity/
Hostname http://tinkerkit.tihhs.nl/accelerometer http://johnny-five.io/examples/tinkerkit-accelerometer/
Hostname http://tinkerkit.tihhs.nl/led-red-10mm http://johnny-five.io/examples/tinkerkit-blink/
Hostname http://tinkerkit.tihhs.nl/shield 9 instances over more than one page
Hostname http://tinkerkit.tihhs.nl/button http://johnny-five.io/examples/tinkerkit-button/
Hostname http://tinkerkit.tihhs.nl/thermistor http://johnny-five.io/examples/tinkerkit-thermistor/
Hostname http://tinkerkit.tihhs.nl/servo 3 instances over more than one page
Hostname http://tinkerkit.tihhs.nl/linear-pot 2 instances over more than one page
Hostname http://tinkerkit.tihhs.nl/joystick http://johnny-five.io/examples/tinkerkit-joystick/
Hostname http://tinkerkit.tihhs.nl/rotary-pot http://johnny-five.io/examples/tinkerkit-rotary/
Hostname http://tinkerkit.tihhs.nl/tilt-sensor http://johnny-five.io/examples/tinkerkit-tilt/
Hostname http://tinkerkit.tihhs.nl/touch http://johnny-five.io/examples/tinkerkit-touch/
Certificate https://www-ssl.intel.com/content/www/us/en/do-it-yourself/maker.html http://johnny-five.io/news/edison-io:-default-i2c-bus-updates/
Timeout http://wiki.linino.org/doku.php?id=wiki:upgradetolininoio http://johnny-five.io/platform-support/
Timeout https://pinocc.io http://johnny-five.io/platform-support/
Timeout http://www.nkcelectronics.com/freeduino-arduino-motor-control-shield-kit.html http://johnny-five.io/api/motor/
Timeout http://start.tessel.io/modules/climate 3 instances over more than one page
302 loop http://www.atmel.com/Images/Atmel-42181-SAM-D21_Datasheet.pdf http://johnny-five.io/news/tessel-2-chipkit-uno32-sparkfun-edison-arduino-block/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DOCS Good First Issue Hardware Not Required
4 participants
@reconbot @rwaldron @dtex @mjguru