All of lore.kernel.org
 help / color / mirror / Atom feed
* Add links to feature docs
@ 2018-12-05 23:31 Joseph Reynolds
  2019-01-03 23:30 ` Add links to feature docs - created TOC Joseph Reynolds
  0 siblings, 1 reply; 2+ messages in thread
From: Joseph Reynolds @ 2018-12-05 23:31 UTC (permalink / raw)
  To: openbmc

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

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: Add links to feature docs - created TOC
  2018-12-05 23:31 Add links to feature docs Joseph Reynolds
@ 2019-01-03 23:30 ` Joseph Reynolds
  0 siblings, 0 replies; 2+ messages in thread
From: Joseph Reynolds @ 2019-01-03 23:30 UTC (permalink / raw)
  To: openbmc; +Cc: openbmc

On 2018-12-05 17:31, Joseph Reynolds wrote:
> 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

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2019-01-03 23:25 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-12-05 23:31 Add links to feature docs Joseph Reynolds
2019-01-03 23:30 ` Add links to feature docs - created TOC Joseph Reynolds

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.