Skip to contentSkip to conversation

Add links to feature docs

DISCUSSION Joseph Reynolds 1 participant 2 messages Dec 5, 2018 – Jan 3, 2019

lore
Share & tools
lore
#0 lore raw

I want to make it easier to find documentation for features of OpenBMC. The README [1] file lists the features and links to the docs repo, but not all features are documented there, and I'm still new to BMCs, so it is hard for me to determine which docs to read.

I propose to add a link from each feature to its canonical documentation. So if you see me asking question in this area, you'll know why.

- Joseph

[1]: https://github.com/openbmc/openbmc/blob/master/README.md#features-of-openbmc

#1 lore raw

Re: Add links to feature docs - created TOC

Quoted 8 lines · Joseph Reynolds

I want to make it easier to find documentation for features of OpenBMC. The README ... file lists the features and links to the docs repo, but not all features are documented there, and I'm still new to BMCs, so it is hard for me to determine which docs to read.

I propose to add a link from each feature to its canonical documentation. So if you see me asking question in this area, you'll know why.

I changed the OpenBMC feature list into a table of contents for OpenBMC features. The old list needed to be updated and doesn't make it easy to find more information about OpenBMC features. So I looked for docs and added links to the project's README.

Please review.
- Let me know what features should be added or removed, or how to organize the list.

- I tried to find all the feature documentation, but I need your help. Please contribute doc links for your area and I will add them. I prefer for each feature to link to a single document, but I will take what I can get.

The review is here:
https://gerrit.openbmc-project.xyz/#/c/openbmc/openbmc/+/17056/

Thanks!
- Joseph