Skip to content
This repository has been archived by the owner on Apr 8, 2022. It is now read-only.

De-duplicate RT kernel build instructions #29

Closed
Tracked by #34
christophebedard opened this issue May 27, 2021 · 4 comments
Closed
Tracked by #34

De-duplicate RT kernel build instructions #29

christophebedard opened this issue May 27, 2021 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@christophebedard
Copy link
Member

There's a guide for building a RT kernel here: https://real-time-working-group.readthedocs.io/en/latest/Guides/Real-Time-Operating-System-Setup/Real-Time-Linux/build_rt_kernel.html

but the instructions here are slightly more up-to-date/better: https://github.com/ros-realtime/rt-kernel-docker-builder

Should the guide be updated with the text from the README? And to de-duplicate we can remove it from the README and point to the guide in the documentation.

@christophebedard christophebedard added the documentation Improvements or additions to documentation label May 27, 2021
@razr
Copy link
Member

razr commented May 31, 2021

@christophebedard indeed, docs part shall be updated. Thanks for pointing it out.
Let me do it. I'm not sure what is the right split between the guide and the README. I think the guide shall be not so detailed as a README. Probably it should more describe a "why" to configure and "what" to configure and a README the "how"?

@christophebedard
Copy link
Member Author

christophebedard commented May 31, 2021

I'm not sure what is the right split between the guide and the README. I think the guide shall be not so detailed as a README. Probably it should more describe a "why" to configure and "what" to configure and a README the "how"?

I was thinking about just removing all the content from one of them and replacing it with a link to the other (i.e. update the guide with the content of the README, empty out the README, and replace with link to the guide). As you wish though, if you think the split should be somewhere in the middle I think that's fine. I'm mostly just bringing this up to remove the duplication.

@carlossvg
Copy link
Contributor

@christophebedard I agree, I think it's better to have a single source of truth. I would remove the readme from the tool repository and replace it with a link to the documentation.

I think we should do the same with the community repo readme. I will go trough the readmes and clean-up the documentation.

@carlossvg
Copy link
Contributor

Moved to ros-realtime/ros-realtime.github.io#9

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants