search

cloud-native-toolkit / site-developer-guide

This repository will host the Developer Guide for the IBM Garage Cloud Native Toolkit
https://develop.cloudnativetoolkit.dev
Apache License 2.0
29 stars 57 forks source link

Broken links #10

Closed davesteinberg closed 4 years ago

davesteinberg commented 4 years ago

I'm seeing lots of broken links in the developer guide.

From the MOOC Homework page...

From the left-side navigation pane...

Starter Kit Templates

Programming Guide

Practical Guides

Administrator Guide

I cloned the code to try to have a look, but I don't know Gatsby, and npm run dev fails:

$ npm run dev

> ibm-garage-developer-guide@1.0.0 dev /Users/dave/code/garage/catalyst/ibm-garage-developer-guide
> gatsby develop

The above error occurred in the <StoreStateProvider> component:
    in StoreStateProvider
    in App

React will try to recreate this component tree from scratch using the error boundary you provided, App.
Warning: App: Error boundaries should implement getDerivedStateFromError(). In that method, return a state update to display an error message or fallback UI.

No idea if this is related or not. I see there are Markdown files for at least some of the pages that are the targets of broken links, but I don't know how they're meant to be hooked up.

davesteinberg commented 4 years ago

Hmm...interesting. The links work from here, but not client-side from within the docs. I'm seeing errors like this in the console:

webpack-runtime-e21050775afadc0d5cfd.js:1 Uncaught (in promise) ChunkLoadError: Loading chunk 34 failed. (error: https://ibm-garage-cloud.github.io/ibm-garage-developer-guide/component---src-pages-homework-teams-index-mdx-4380b1f622cfdc71c989.js) at Function.a.e (https://ibm-garage-cloud.github.io/ibm-garage-developer-guide/webpack-runtime-e21050775afadc0d5cfd.js:1:4504) at Object.component---src-pages-homework-teams-index-mdx (https://ibm-garage-cloud.github.io/ibm-garage-developer-guide/app-4ba8544e6a609ea38f1a.js:1:1925285) at n.loadComponent (https://ibm-garage-cloud.github.io/ibm-garage-developer-guide/app-4ba8544e6a609ea38f1a.js:1:1667064) at https://ibm-garage-cloud.github.io/ibm-garage-developer-guide/app-4ba8544e6a609ea38f1a.js:1:1664922

mjperrins commented 4 years ago

When running locally the git pages prefix is in the links , we discovered this late when created the docs for MOOC , we will investigate how to make this dynamic so works in local and published mode

mjperrins commented 4 years ago

We have been doing some work on the broken links so they are at least working on the server copy, we are reaching out to the Gatasby team to see if there is a simple way of setting this up

seansund commented 4 years ago

Is this still an issue? It seems like all the links are working now on the published site and I can access the site when I run npm run dev as well

davesteinberg commented 4 years ago

@seansund It looks to me like these problems are now resolved.