Skip to content

apache/nuttx-website

How to update the project's web site

Running locally

Before opening a pull request, you can preview your contributions by running from within the directory:

export GEM_HOME=$HOME/.gem # Adjust this path as you want
export PATH=$PATH:$GEM_HOME/bin
bundle exec jekyll serve
Open [http://localhost:4000](http://localhost:4000)

Note: The Gemfile.lock may contain some platform specific pins you may want to regenerate this by deleting Gemfile.lock and running bundle update. This is currently locked for x86_64-linux, darwin, and freebsd by using the bundle lock --add-platform foo command.

Pushing to site

Site is updated by a CI job that runs the publish.sh script. Once this runs it the results will be visible here.

Force Deployment

If a dependency has changed such as the external documentation you may need to force the deployment CI to run. This can be done from the CI Actions tab and selecting Run workflow -> Branch: master --> Run workflow

Trigger Workflow

Adding contributors

To add a contributor to the project, or to modify existing contributors, edit site/_data/contributors.yml. The project members list will re-generate.