Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion Gemfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins
#gemspec

# Testing utilities
gem "html-proofer"

#gemspec
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,27 @@ After installing Jekyll, install all dependencies by running
bundle install
```

## Testing generated site

To test the generated HTML site, you can use `html-proofer` gem.
This Ruby gem checks and validates the jekyll generated HTML files.
It checks a broad set of points: internal and external links existence (alerting of possible 404 errors), HTML attributes of the images and so on.

To install it, It has been incorporated in the Gemfile so the previous dependency install command would have already installed it.

You can run the following gem to tests the generated site.

```bash
bundle exec jekyll build
bundle exec htmlproofer ./_site
```

A utility script has also been included to run these checks in a CI system smoothly.

```bash
./scripts/cibuild
```

## License

Released under [the Apache Public License 2.0](LICENSE).
2 changes: 1 addition & 1 deletion _docs/embedded_tf/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Table of contents
- [Introduction and Goal](#introduction-and-goal)
- [Requirements](#requirements)
- [Design](#design)
- [Implementation of tf2_filter](#implementation-of-tf2filter)
- [Implementation of tf2_filter](#implementation-of-tf2_filter)
- [Roadmap](#roadmap)
- [Acknowledgments](#acknowledgments)

Expand Down
8 changes: 4 additions & 4 deletions _docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ We're basically following the ROS2 architecture and make use of its middleware p

## Concept Documentation

- Predictable scheduling and execution: [real-time_executor](real-time_executor/)
- System modes and system hierarchy: [system_modes](system_modes/)
- Embedded transform (tf) library: [embedded_tf](embedded_tf/)
- Predictable scheduling and execution: [real-time_executor](/docs/real-time_executor/)
- System modes and system hierarchy: [system_modes](/docs/system_modes/)
- Embedded transform (tf) library: [embedded_tf](/docs/embedded_tf/)
- Reference hardware: [https://github.com/microROS/hardware](https://github.com/microROS/hardware)
- Build infrastructure for embedded development using docker: [https://github.com/microROS/docker](https://github.com/microROS/docker)
- FIWARE interoperability: [FIROS2](FIROS2/)
- FIWARE interoperability: [FIROS2](/docs/FIROS2)

## Source Code Repositories

Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ <h1 class="text-center"><i class="fa fa-cogs" aria-hidden="true"></i></h1>
<h3 class="text-center">Getting Started</h3>
<p>To get you started quickly, header over to the <a href="/docs/tutorials/">tutorial</a> section. The basic ones
can even be done without a micro-controller. For more background and details, see the
<a href="docs/">documentation</a>.</p>
<a href="/docs/home/">documentation</a>.</p>
</div>
<div class="col-sm-4">
<h1 class="text-center"><i class="fa fa-code-fork" aria-hidden="true"></i></h1>
Expand Down
5 changes: 5 additions & 0 deletions scripts/cibuild
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/usr/bin/env bash
set -e # halt script on error

bundle exec jekyll build
bundle exec htmlproofer ./_site