summaryrefslogtreecommitdiff
path: root/DEVELOPING.md
AgeCommit message (Collapse)AuthorFilesLines
2020-08-21Add reoccuring errors docEd Tanous1-1/+7
There are a number of common coding, design, and implementation mistakes that bmcweb users tend to make. This attempts to document them so we have a single source to point users to when making gerrit comments. The hope is that this alleviates some of the early mistakes that new users tend to make. Tested: Documentation only. No functional changes. Signed-off-by: Ed Tanous <ed@tanous.net> Change-Id: Icc0081c94403c937d9a1ce44b7d6e81a5716a32e
2020-07-10Codespell spelling fixesGunnar Mills1-1/+1
These spelling errors were found using https://github.com/codespell-project/codespell Tested: Built and ran against validator. Signed-off-by: Gunnar Mills <gmills@us.ibm.com> Change-Id: I214fe102550295578cfdf0fc58305897d261ce55
2019-12-09DEVELOPING: Engage Redfish before adding OEMGunnar Mills1-1/+14
Added a Redfish section about engaging the DMTF's Redfish working group before adding a Redfish OEM schema or property. See https://lists.ozlabs.org/pipermail/openbmc/2019-November/019571.html Tested: https://jbt.github.io/markdown-editor/ and grammarly.com Change-Id: I946483a90e34f63930a2cba047d14226d2da7583 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2019-11-26README: Added Redfish Service Validator testingGunnar Mills1-0/+6
In the Redfish.md, we state "The redfish implementation shall pass the Redfish Service Validator with no warnings or errors". Added testing the Redfish Service Validator as part of the "Developing and Testing" in DEVELOPING.md. Change-Id: I1688d6a33066d74ca9d6a79d6241e8cc9fe9deb8 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2019-11-11Document commands to run clang-tidyEd Tanous1-1/+19
clang-tidy is a useful tool for automatically finding bad coding patterns. Add documentation for how to run it manually. Tested: Docs change. Ran commands and verified that clang-tidy runs. Signed-off-by: Ed Tanous <ed.tanous@intel.com> Change-Id: Ibff23be17af9042c2c5d9769c5d5570e5bbe7e3e
2019-07-18redfish-doc: Move Redfish doc to its own fileAndrew Geissler1-461/+0
Redfish support has been growing exponentially within bmcweb. Lets get a separate document for it all. Change-Id: Ibe895c7ab4bf4d2e1d51fce7136c0a6f8ca4119d Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
2019-01-24Revert "bmcweb: update SSL cipher suites to OWASP compatB"Ed Tanous1-4/+0
This reverts commit 54fd221a9139f46c7c95b4a22cc09e6e7ce4cbbc. Reason for revert: This breaks compatibility with python automation running on ubuntu 16.04, and regresses our ability to run the test harness. Suspect we need to run compat C by default, but lets revert for now to stabilize. Change-Id: I4a01450836d917cd9558bc826c1877e629280850
2019-01-23bmcweb: update SSL cipher suites to OWASP compatBEd Tanous1-0/+4
Previously, bmcweb was utilitizing the "mozilla compatibility" cipher suites. This is overly lenient on broken ciphers and can cause some issues with security reviews. In researching this, it looks like we never actually documented that we follow Mozilla ciphers, aside from the statement "The OpenBMC webserver shall follow the latest OWASP recommendations for authentication, session management, and security." Considering that we're moving _to_ OWASP recommendations, this commit is simply making us follow the advice we already document, although this commit also updates the documentation to be more clear. Tested By: Loaded on a BMC, opened web page in browser, and observed phosphor-webui loaded correctly. Change-Id: I912b35d378ce955c1472b2d54f1a365f6efea160 Signed-off-by: Ed Tanous <ed.tanous@intel.com>
2019-01-23Add redfish schema linkAndrew Geissler1-0/+2
Another thing I point people to a lot as a starting point for their redfish work Change-Id: I679dc12287bfa7d12f6e791ef0f31b1480d8190a Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
2019-01-23Add dev section on using SDK/QEMUAndrew Geissler1-1/+85
More and more developers are starting to work with bmcweb and I keep repeating a lot of the same information to them. Figured getting it down in this doc would help others get up and going. Change-Id: I536d0319cc278662f633761b1c38fe5820690a25 Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
2019-01-19Miscellaneous formatting clean upAndrew Geissler1-452/+457
Fixed some numbering and tried to make the spacing between redfish sections consistent. Change-Id: Icda3ae4183d52a6f9fedf0e639a4111dabec3c40 Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
2018-06-13Fix headerGunnar Mills1-1/+1
Needed a space. Change-Id: Ie44a1feae140b1e6fd278afa0d07295d89f7ace2 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2018-06-13Spelling fixesGunnar Mills1-5/+5
Spelling errors found using github.com/lucasdemarchi/codespell A tool to fix common misspellings. This tool is licensed under GNU General Public License, version 2. Change-Id: Id065de1812c3eb383992533efd99b5079b74729d Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2018-03-07Add OpenBmc Developing docsEd Tanous1-0/+568
The DEVELOPING file is intended to set expectations and requirements around the behavior or the OpenBmc webserver. While not a complete requirement list, it improves considerably upon the docs previously available. Change-Id: I0a7119017133aaf15874f9edab4967650e29dc63 Signed-off-by: Ed Tanous <ed.tanous@intel.com>
generated by cgit v1.2.3 (git 2.39.0) at 2024-07-10 06:00:26 +0300