search

roboticslab-uc3m / questions-and-answers

A place for general debate and question&answer
https://robots.uc3m.es/developer-manual/appendix/repository-index.html
2 stars 0 forks source link

Upgrades in GitBook #63

Closed jgvictores closed 5 years ago

jgvictores commented 6 years ago

"Your organization is being upgraded to the new GitBook" (https://www.gitbook.com/@roboticslab-uc3m/migration/status).

Note: Some info at https://github.com/asrob-uc3m/actas/issues/148

jgvictores commented 5 years ago

https://github.com/GitbookIO/documentation is deprecated and now points to:

Which apparently are all also about legacy.

jgvictores commented 5 years ago
jgvictores commented 5 years ago

Blocks https://github.com/asrob-uc3m/actas/issues/148

jgvictores commented 5 years ago

One of the first steps is running Gitbook on localhost: both versions if possible (and also find out if legacy is really legacy or just legacy from the perspective of https://www.gitbook.com).

jgvictores commented 5 years ago

Turns out that https://github.com/GitbookIO/gitbook is the open source command line tool and Node.js library that generated the beautiful legacy books.

From "How will this project move forward - is it left for dead? GitbookIO/gitbook#2148" we read that https://www.gitbook.com has decided to move away from open source. At time of writing:

source arrow keys languages interface plantuml plugin
legacy open yes yes clean yes
new closed no no crowded no

EDIT: added info regarding plantuml, seems not rendered in new:

We've began a a list of alternatives starting here. However, I'll continue to use this issue to track progress on legacy, which was nice.

PeterBowman commented 5 years ago

More alternatives to be found in https://alternativeto.net/software/gitbook.

jgvictores commented 5 years ago

legacy, at least for generating .html, works great:

  1. Install via: npm install gitbook-cli -g
  2. Then two options:
    1. Generate working _book/ via gitbook build
    2. Serve via: gitbook serve (generates _book anyway)

Small note: On a PC without apache, had to use the gitbook serve option: simply opening the index.html rendered, but arrow keys and links did not work. I've been running into similar errors lately, where very plain client-side code had to be served via python -m SimpleHTTPServer 8000 (edit: this option also works). Turns out I may have been running into "For security purposes, Mozilla applications block links to local files (and directories) from remote files. This includes linking to files on your hard drive, on mapped network drives, and accessible via Uniform Naming Convention (UNC) paths. " as described at S.O. (also for Chromium). Tried serving the generated _book folder via apache on server, everything cool. Simple and fast.

jgvictores commented 5 years ago

https://help.github.com/articles/using-a-static-site-generator-other-than-jekyll/ says GitHub pages will host, but not generate, alternatives to Jekyll. We'd have to rely on a server (think about heroku).

jgvictores commented 5 years ago

Turns out that legacy gitbook.com URLs for robotics-lab are dead due to the update (we had been warned there was no way back). Example of broken link as analogous to here (we've tried several of these): https://roboticslab-uc3m.gitbooks.io

jgvictores commented 5 years ago

No longer blocking asrob-uc3m org (see https://github.com/asrob-uc3m/actas/issues/148) provided these results, but blocking roboticslab-uc3m org until we:

*Note: I'm saying "temporal" because I'd like external hosting in the future (e.g. process as herokuapp and push back to github)

jgvictores commented 5 years ago

New README-gitbook.md with banner at:

jgvictores commented 5 years ago
  • [x] set up temporal cron jobs enabling temporal URLs at robots.uc3m.es
jgvictores commented 5 years ago
  • [x] update links to these temporal URLs at robots.uc3m.es

Done for most relevant org gitbook repos (developer-manual and teo-developer-manual). Recommended to reopen or open new issues for other repos. Follow steps cited here as well as recommendations of https://github.com/asrob-uc3m/actas/issues/148#issuecomment-450514258.

jgvictores commented 5 years ago

Pending: https://github.com/roboticslab-uc3m/installation-guides (via https://www.gitbook.com/@roboticslab-uc3m/spaces)

jgvictores commented 5 years ago

Pending: installation-guides

See https://github.com/roboticslab-uc3m/installation-guides/issues/58

PeterBowman commented 3 years ago

For future reference, this is installed on robots.uc3m.es at time of writing:

$ gitbook --version
CLI version: 2.3.2
GitBook version: 3.2.3
jgvictores commented 3 years ago 
$ gitbook --version
CLI version: 2.3.2
GitBook version: 3.2.3

Which, as commented at http://robots.uc3m.es/gitbook-installation-guides/install-gitbook.html (perma) works with nodejs 10.x.