gazebosim / gazebosim/sdformat

Continuous documentation

Open
#167 0 comments 0 reactions 0 assignees View on GitHub
enhancement minor
Dominant language
C++
Stars
216
Forks
125
Avg merge
1d 14h
Merged PRs (30d)
14

Description

**Original report ([archived issue](https://osrf-migration.github.io/sdformat-gh-pages/#!/osrf/sdformat/issues/167)) by Louise Poubel (Bitbucket: [chapulina](https://bitbucket.org/%7B5cfa2075-477b-4ded-bdb9-8d2479544ec4%7D/), GitHub: [chapulina](https://github.com/chapulina)).**

----------------------------------------
We should setup "continuous deployment" for documentation, so the [spec website](http://sdformat.org/spec) is updated with the latest documentation when pull requests are merged into release / dev branches, or when new release tags are created.

See the comments on [this](http://answers.gazebosim.org/question/17207/why-are-heightmaps-subsampled/) question.

Contributor guide

Open the contributing guide

Research direction

Start with the spec website and the release/dev branches and tags named in the issue; determine how documentation is currently published. Done means merged pull requests and new release tags update the spec website with the latest documentation.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd, documentation, release
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.