eclipse-iceoryx / eclipse-iceoryx/iceoryx2

Improve CI for documentation

Open
#1,027 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
2.5k
Forks
185
Avg merge
1d 23h
Merged PRs (30d)
47

Description

For the CI we can improvise some points in the doc generation:

- [ ] - revisit the build folder for the generated docs, see https://github.com/eclipse-iceoryx/iceoryx2/pull/990#discussion_r2331216754
- [ ] - revisit the nightly job for documentation in `.github/workflows/documentation.yml`
- [ ] - check if we can remove some logic of `.github/workflows/documentation.yml` into separate scripts

Contributor guide

Open the contributing guide

Research direction

Start by reading the discussion on PR #990 and inspect the generated documentation build folder. Then review .github/workflows/documentation.yml, including its nightly job and embedded logic. Done means the documentation CI is simplified, with any suitable workflow logic moved into separate scripts and generation still working.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, rust
Domain
build-system, ci-cd, documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.