docs: create docs folder
To better organize the docs and align with other repos [1],[2],[3],[4]
create a folder for documentation.
Links between the docs have been adjusted to match their new place.
References:
[1] https://github.com/openbmc/phosphor-logging/tree/master/docs
[2] https://github.com/openbmc/entity-manager/tree/master/docs
[3] https://github.com/openbmc/libpldm/tree/main/docs
[4] https://github.com/openbmc/sdbusplus/tree/master/docs
Change-Id: Ibf990d0d78548bc3407b7f98ccf6a650b1744939
Signed-off-by: Alexander Hansen <alexander.hansen@9elements.com>
diff --git a/DEVELOPING.md b/DEVELOPING.md
index 68aa683..030d08b 100644
--- a/DEVELOPING.md
+++ b/DEVELOPING.md
@@ -131,21 +131,21 @@
bmcweb's Redfish implementation, including Redfish OEM Resources, shall conform
to the Redfish specification. Please keep bmcweb's
-[Redfish support document](https://github.com/openbmc/bmcweb/blob/master/Redfish.md)
+[Redfish support document](https://github.com/openbmc/bmcweb/blob/master/docs/Redfish.md)
updated. OEM schemas should conform and be developed in line with the rules in
-[OEM SCHEMAS](https://github.com/openbmc/bmcweb/blob/master/OEM_SCHEMAS.md).
+[OEM SCHEMAS](https://github.com/openbmc/bmcweb/blob/master/docs/OEM_SCHEMAS.md).
### Common errors
A number of examples of common errors are captured in the common errors doc. It
is recommended that developers read and understand all of them before starting
any openbmc development.
-[Common Errors](https://github.com/openbmc/bmcweb/blob/master/COMMON_ERRORS.md).
+[Common Errors](https://github.com/openbmc/bmcweb/blob/master/docs/COMMON_ERRORS.md).
### Commit messages
Project
-[commit message formatting](https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md#formatting-commit-messages)
+[commit message formatting](https://github.com/openbmc/docs/blob/master/docs/CONTRIBUTING.md#formatting-commit-messages)
should be obeyed.
Commit messages should answer the following questions:
diff --git a/README.md b/README.md
index 27c8c4d..7346188 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@
to dbus and the objects it represents.
- Serial: A serial websocket for interacting with the host serial console
through websockets.
-- Redfish: A protocol compliant, [DBus to Redfish translator](Redfish.md).
+- Redfish: A protocol compliant, [DBus to Redfish translator](docs/Redfish.md).
- KVM: A websocket based implementation of the RFB (VNC) frame buffer protocol
intended to mate to webui-vue to provide a complete KVM implementation.
@@ -78,5 +78,5 @@
## Redfish Aggregation
bmcweb is capable of aggregating resources from satellite BMCs. Refer to
-[AGGREGATION.md](https://github.com/openbmc/bmcweb/blob/master/AGGREGATION.md)
+[AGGREGATION.md](https://github.com/openbmc/bmcweb/blob/master/docs/AGGREGATION.md)
for more information on how to enable and use this feature.
diff --git a/AGGREGATION.md b/docs/AGGREGATION.md
similarity index 100%
rename from AGGREGATION.md
rename to docs/AGGREGATION.md
diff --git a/CLIENTS.md b/docs/CLIENTS.md
similarity index 100%
rename from CLIENTS.md
rename to docs/CLIENTS.md
diff --git a/COMMON_ERRORS.md b/docs/COMMON_ERRORS.md
similarity index 100%
rename from COMMON_ERRORS.md
rename to docs/COMMON_ERRORS.md
diff --git a/DBUS_USAGE.md b/docs/DBUS_USAGE.md
similarity index 100%
rename from DBUS_USAGE.md
rename to docs/DBUS_USAGE.md
diff --git a/HEADERS.md b/docs/HEADERS.md
similarity index 100%
rename from HEADERS.md
rename to docs/HEADERS.md
diff --git a/OEM_SCHEMAS.md b/docs/OEM_SCHEMAS.md
similarity index 100%
rename from OEM_SCHEMAS.md
rename to docs/OEM_SCHEMAS.md
diff --git a/REDFISH_CHECKLIST.md b/docs/REDFISH_CHECKLIST.md
similarity index 100%
rename from REDFISH_CHECKLIST.md
rename to docs/REDFISH_CHECKLIST.md
diff --git a/Redfish.md b/docs/Redfish.md
similarity index 100%
rename from Redfish.md
rename to docs/Redfish.md
diff --git a/TESTING.md b/docs/TESTING.md
similarity index 100%
rename from TESTING.md
rename to docs/TESTING.md