hejia-zhang / installation-guides

Centralized administration of dependency installation guides.

Installation Guides

Installation Guides @ roboticslab-uc3m

Currently hosted at https://robots.uc3m.es/installation-guides/

If you have any doubts or comments

Please read the Developer Manual's Asking Questions section, and once you've succeded with its self-evaluation follow the recommendations by commenting publicly HERE if required

How-To's

• How to serve on localhost
• How to upload changes to GitHub

How to serve on localhost

It is useful to serve on localhost to modify the website and see changes locally.

Note: This specific repository is different, it uses a SUMMARY.md that is auto-generated via scripts/admin/update-gitbook.sh. For general guides refer to install-gitbook.

1. Make sure you have installed gitbook-summary.

2. To serve, from the root of the project, run: ./scripts/admin/gitbook-local-serve.sh

3. You can now browse the site at the default location: http://127.0.0.1:4000

4. To clean, (recover .gitignore to its previous state, remove generated SUMMARY.md), run: ./scripts/admin/gitbook-local-clean.sh

How to upload changes to GitHub

This project is managed as any project on GitHub. You may use Git or even the GitHub web interface, both on which you can find many tutorials online. The following points are specific to the Gitbook (legacy) mechanism used:

1. Please do not upload the _book/ folder. It is auto-generated locally, and the same should happen on the Gitbook (legacy) servers. For this repository, do not upload the SUMMARY.md file.

2. It is safe to git push to any upstream branch, just remember that what is on master is what will be actually rendered as the website.