industrial_ci icon indicating copy to clipboard operation
industrial_ci copied to clipboard

Improve user instruction

Open 130s opened this issue 7 years ago • 7 comments

Some complaints feedback from active users, e.g. https://github.com/ros-industrial-consortium/bezier/issues/153

Indeed README gets necessarily but surely complexed.

  • [x] Add more sample config --> #113
  • [x] provide a template .travis.yml content so that users simply download in their .travis.yml. -> #337
  • [x] The quickstart config is a little bit outdated and not really complete (#336). -> addressed in https://github.com/ros-industrial/industrial_ci/pull/337
  • [x] Dissect README into pieces per level https://github.com/ros-industrial/industrial_ci/issues/105#issuecomment-273318237 --> #113
  • [ ] DOCKER_PULL usage https://github.com/ros-industrial/industrial_ci/pull/283#discussion_r201809566
  • [x] This link is broken in CATKIN_CONFIG. -> done https://github.com/ros-industrial/industrial_ci/issues/105#issuecomment-443870126

130s avatar Jan 17 '17 21:01 130s

Pehaps we should split README.md into different chapters (-> doc directory). And start with a TL;DR section with a minimal example:

sudo: required 
dist: trusty 
language: generic 
env:
  - ROS_DISTRO="indigo"
install:
  - git clone --depth 1 https://github.com/ros-industrial/industrial_ci.git .ci_config  
script: 
  - .ci_config/travis.sh

mathias-luedtke avatar Jan 17 '17 22:01 mathias-luedtke

Complaint is a strong word. You have done some awesome work with this repository. Please don't feel offended :hugs:

VictorLamoine avatar Jan 17 '17 22:01 VictorLamoine

@VictorLamoine Thanks. I've seen "complaint" in OSS is often used as the same meaning as "feedback", and that was what I meant ;)

130s avatar Jan 18 '17 10:01 130s

A template might help preventing issues like #254

mathias-luedtke avatar Jan 04 '18 11:01 mathias-luedtke

  • provide a template .travis.yml content so that users simply download in their .travis.yml.

Template being added to https://github.com/ros-industrial/industrial_ci/pull/234

130s avatar Feb 05 '18 09:02 130s

The quickstart config is a little bit outdated and not really complete (#336).

mathias-luedtke avatar Nov 28 '18 15:11 mathias-luedtke

Can't find "optional-customize-catkin-config" section. And customize-catkin-config section link is working. Checked.

130s avatar Dec 03 '18 21:12 130s