https://github.com/tidalmigrations/tidalmigrations.github.io
Documentation for using Tidal software
https://github.com/tidalmigrations/tidalmigrations.github.io
cloud migration tidal
Last synced: about 2 months ago
JSON representation
Documentation for using Tidal software
- Host: GitHub
- URL: https://github.com/tidalmigrations/tidalmigrations.github.io
- Owner: tidalmigrations
- Created: 2018-02-07T18:53:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-04T22:40:29.000Z (3 months ago)
- Last Synced: 2025-03-04T23:29:48.158Z (3 months ago)
- Topics: cloud, migration, tidal
- Language: HTML
- Homepage: https://guides.tidal.cloud
- Size: 15.5 MB
- Stars: 0
- Watchers: 7
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: licenses/LICENSE
Awesome Lists containing this project
README
# Tidal Guides
A set of guides on how to use the Tidal API and Tidal Tools.
## Development
To run the site locally you will need:
- [Ruby](https://www.ruby-lang.org/en/) installed.
- `gem install bundler` or `sudo dnf install rubygem-bundler` (RHEL/CentOS/Fedora) or `sudo apt install bundler` (Debian/Ubuntu)
- Set the `$GEM_HOME` environment variable.
- Check if it is set with `env | grep GEM_HOME`
- If it is not set, set it with `export GEM_HOME=$(ruby -r rubygems -e 'puts Gem.user_dir')`
To install the needed dependencies:
`bundle install`
To run [jekyll](https://jekyllrb.com/) and start hacking run:
`jekyll server`
You should see the rendered site on http://localhost:4000
## PDF generation
You need to have [`pandoc`](https://pandoc.org/installing.html) and LaTeX
(`lualatex`) installed. We suggest using
[TinyTex](https://yihui.name/tinytex/) because it is lightweight,
cross-platform, portable, and easy-to-maintain.
The following LaTeX packages need to be installed:
- `environ`
- `everypage`
- `fancyhdr`
- `luatexbase`
- `noto`
- `pgf`
- `selnolig`
- `sourcecodepro`
- `tcolorbox`
The above packages could be easily installed on Debian Stable by running `./book/deps.sh` script.
Build PDF files with the following command:
```
make -j8 book
```