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

Source links in documentation are broken #5792

Closed
emackey opened this issue Aug 30, 2017 · 9 comments
Closed

Source links in documentation are broken #5792

emackey opened this issue Aug 30, 2017 · 9 comments

Comments

@emackey
Copy link
Contributor

emackey commented Aug 30, 2017

Reported by @gberaudo in #5791.

All of the source links (the small hyperlinks in the right margin of each sub-header) are broken. For example: https://cesiumjs.org/Cesium/Build/Documentation/EntityCollection.html#getById

The link's target looks like this:

https://github.com/AnalyticalGraphicsInc/cesium/blob/1.36.0-13623056/Source/DataSources/EntityCollection.js#L388

The problem here is 1.36.0-13623056 is being used in the path, which does not match the GitHub tag name of 1.36. This URL is constructed here:
https://github.com/AnalyticalGraphicsInc/cesium/blob/1.36/Tools/jsdoc/cesium_template/publish.js#L308

The CESIUM_VERSION appears to be assigned here:
https://github.com/AnalyticalGraphicsInc/cesium/blob/1.36/gulpfile.js#L203

/cc @mramato Are you aware of recent build changes that might have altered this value?

@mramato
Copy link
Contributor

mramato commented Aug 30, 2017

Our website is also showing the wrong version in Sandcastle, @ggetz can you take a quick look to see if it's something obvious that changed in the build process.

@mramato
Copy link
Contributor

mramato commented Aug 30, 2017

Actually, this is most likely specific to how the version of Cesium on the website gets updated and not anything to do with Cesium's build itself. Which means @ggetz is even more of the right person to check this out.

@emackey
Copy link
Contributor Author

emackey commented Aug 30, 2017

Agreed. It doesn't seem to affect the "archived" version, such as:

https://cesiumjs.org/releases/1.36/Build/Documentation/EntityCollection.html -- works fine

It also doesn't affect local developer builds. It seems to be only the main hosted version that's incorrect.

@emackey
Copy link
Contributor Author

emackey commented Aug 30, 2017

Downgraded from "next release" since the release itself doesn't seem to be broken.

@ggetz
Copy link
Contributor

ggetz commented Aug 30, 2017

To clarify, using the cesiumjs.org branch and running npm run release will be the version we want hosted, right?

@mramato
Copy link
Contributor

mramato commented Aug 30, 2017

Yes.

@ggetz
Copy link
Contributor

ggetz commented Aug 30, 2017

Alright, this is fixed on the site now, and I'm working on fixing this as part of the automated website build process.

@emackey
Copy link
Contributor Author

emackey commented Aug 31, 2017

OK to close?

@ggetz
Copy link
Contributor

ggetz commented Aug 31, 2017

Yes please, thanks @emackey!

@mramato mramato closed this as completed Aug 31, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants