Fix markdownlint issues
Markdownlint flags a number of issues, mostly around using bare urls.
Fix all reported issues.
Tested: Markdownlint builds now run without warnings.
Change-Id: I11631c6e038dcbefc231fdbaa92431f0913a571e
Signed-off-by: Ed Tanous <etanous@nvidia.com>
diff --git a/CLIENTS.md b/CLIENTS.md
index ce99de7..b17f29b 100644
--- a/CLIENTS.md
+++ b/CLIENTS.md
@@ -17,13 +17,13 @@
Redfish-Service-Validator: A tool to verify through GET requests that bmcweb
properly implements the Redfish schemas in the responded Resource.
-git@github.com:DMTF/Redfish-Service-Validator.git
+<https://github.com/DMTF/Redfish-Service-Validator.git>
Status: 100% passing. Integrated with CI to ensure no regressions.
Redfish-Protocol-Validator: A tool to verify the protocol-level interactions
with the Redfish wire-protocol, and checks those against the Redfish
-specification. git@github.com:DMTF/Redfish-Protocol-Validator.git
+specification. <https://github.com/DMTF/Redfish-Protocol-Validator>
Status: 100% of assertions passing. No CI integration.
@@ -47,12 +47,12 @@
fwupd: Is a client implementation that allows updating firmware components in a
generic way, and includes redfish as one of its plugins.
-git@github.com:fwupd/fwupd.git
+<https://github.com/fwupd/fwupd>
Status: Unknown
python-redfish-library: A python library used by a number of tools.
-git@github.com:DMTF/python-redfish-library.git
+<https://github.com/DMTF/python-redfish-library>
Status: Compatible
@@ -62,7 +62,7 @@
Status: Compatible. No CI integration.
Redfish-Tacklebox: A collection of common utilities for managing redfish servers
-git@github.com:DMTF/Redfish-Tacklebox.git
+<https://github.com/DMTF/Redfish-Tacklebox>
Status: Unknown.
diff --git a/OEM_SCHEMAS.md b/OEM_SCHEMAS.md
index 7d30cba..6cddbe2 100644
--- a/OEM_SCHEMAS.md
+++ b/OEM_SCHEMAS.md
@@ -96,6 +96,6 @@
Given the nature of semantic versioning, Redfish does not directly have support
for schema branching within a namespace, therefore, if a system intends to ship
a version of the schemas that have been modified from the version available at
-https://github.com/openbmc/bmcweb/tree/master/static/redfish/v1/schema, the
+<https://github.com/openbmc/bmcweb/tree/master/static/redfish/v1/schema>, the
Redfish specification _requires_ that the namespace be changed to avoid
collisions.
diff --git a/REDFISH_CHECKLIST.md b/REDFISH_CHECKLIST.md
index e7b5f6d..b454613 100644
--- a/REDFISH_CHECKLIST.md
+++ b/REDFISH_CHECKLIST.md
@@ -1,3 +1,5 @@
+# Redfish Checklist
+
When making changes to the Redfish tree, please follow the checklist below.
If any of these are incomplete when pushing a patch to gerrit, either mark the
diff --git a/Redfish.md b/Redfish.md
index 734802e..bbfabfb 100644
--- a/Redfish.md
+++ b/Redfish.md
@@ -77,7 +77,7 @@
### /redfish/v1/AccountService/MultiFactorAuth/ClientCertificate/Certificates
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/AccountService/MultiFactorAuth/ClientCertificate/Certificates/{Certificate}
@@ -112,7 +112,7 @@
#### AggregationSourceCollection
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}
@@ -127,7 +127,7 @@
- Description
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/AccountService/Accounts/{ManagerAccountId}/
@@ -138,7 +138,7 @@
- Enabled
- Links/Role
- Locked
-- Locked@Redfish.AllowableValues
+- `Locked@Redfish.AllowableValues`
- Password
- PasswordChangeRequired
- RoleId
@@ -151,7 +151,7 @@
- Description
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/AccountService/Roles/
@@ -160,7 +160,7 @@
- Description
- Members
- By default will contain 3 roles, "Administrator", "Operator", and "ReadOnly"
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/AccountService/Roles/{RoleId}/
@@ -185,7 +185,7 @@
- Description
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/Cables/{CableId}/
@@ -216,7 +216,7 @@
#### ChassisCollection
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/Chassis/{ChassisId}/
@@ -249,7 +249,7 @@
#### Drive
- Drives
-- Drives@odata.count
+- `Drives@odata.count`
- Status (this is dependent on a entity manager association from Chassis to
Drives)
@@ -272,7 +272,7 @@
- Description
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/Chassis/{ChassisId}/Sensors/{Id}/
@@ -354,7 +354,7 @@
- Description
- Members
-- Members@odata.count
+- `Members@odata.count`
#### /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Fans/{FanName}/
@@ -429,7 +429,7 @@
- Description
- Members
-- Members@odata.count
+- `Members@odata.count`
#### /redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies/{PowerSupplyId}
@@ -467,7 +467,7 @@
#### EventDestinationCollection
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/EventService/Subscriptions/{EventName}/
@@ -485,7 +485,7 @@
#### JsonSchemaFileCollection
- Description
-- Members@odata.count
+- `Members@odata.count`
- Members
### /redfish/v1/JsonSchemas/{Id}/
@@ -495,16 +495,16 @@
- Schema
- Description
- Languages
-- Languages@odata.count
+- `Languages@odata.count`
- Location
-- Location@odata.count
+- `Location@odata.count`
### /redfish/v1/Managers/
#### ManagerCollection
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/Managers/bmc/
@@ -547,7 +547,7 @@
- Description
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/Managers/bmc/EthernetInterfaces/{EthernetInterfaceId}/
@@ -609,7 +609,7 @@
- Description
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/Managers/bmc/LogServices/RedfishLog/
@@ -664,7 +664,7 @@
- Description
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/Managers/bmc/NetworkProtocol/HTTPS/Certificates/{CertificateId}/
@@ -692,7 +692,7 @@
- Description
- Members
- Should support Base, CommonMessages, and EventingMessages
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/Registries/{MessageRegistryFileId}/
@@ -700,9 +700,9 @@
- Description
- Languages
-- Languages@odata.count
+- `Languages@odata.count`
- Location
-- Location@odata.count
+- `Location@odata.count`
- Registry
### /redfish/v1/SessionService/
@@ -720,7 +720,7 @@
- Description
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/SessionService/Sessions/{SessionId}/
@@ -737,7 +737,7 @@
- Members
- Should support one system
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/Systems/system/Bios/
@@ -793,7 +793,7 @@
#### EthernetInterfaceCollection
- Members
-- Members@odata.count
+- `Members@odata.count`
- Description
### /redfish/v1/Systems/system/FabricAdapters/
@@ -801,7 +801,7 @@
#### FabricAdapterCollection
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/Systems/system/FabricAdapters/{FabricAdapterId}/
@@ -821,7 +821,7 @@
- Description
- Members
- Should default to one member, named SEL
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/Systems/system/LogServices/EventLog/
@@ -840,7 +840,7 @@
- Description
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/Systems/system/LogServices/EventLog/Entries/{LogEntryId}/
@@ -859,7 +859,7 @@
#### LogEntryCollection
- Members
-- Members@odata.count
+- `Members@odata.count`
- Description
- @odata.nextLink
@@ -881,7 +881,7 @@
#### MemoryCollection
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/Systems/system/Memory/{MemoryId}/
@@ -916,7 +916,7 @@
- Description
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/Systems/system/PCIeDevices/{PCIeDevice}/
@@ -942,7 +942,7 @@
- Members
- Should Support CPU1 and CPU2 for dual socket systems
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/Systems/system/Processors/{ProcessorId}/
@@ -978,14 +978,14 @@
#### StorageCollection
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/Systems/system/Storage/{StorageId}/
#### Storage
- Drives
-- Drives@odata.count
+- `Drives@odata.count`
- Status
### /redfish/v1/Systems/system/Storage/{StorageId}/Drive/{DriveId}/
@@ -1013,7 +1013,7 @@
#### TaskCollection
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/TelemetryService/
@@ -1032,7 +1032,7 @@
#### MetricReportDefinitionCollection
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/TelemetryService/MetricReportDefinitions/{MetricReportDefinitionId}/
@@ -1055,7 +1055,7 @@
#### MetricReportCollection
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/TelemetryService/MetricReports/{MetricReportId}/
@@ -1072,7 +1072,7 @@
#### TriggersCollection
- Members
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/UpdateService/
@@ -1092,14 +1092,14 @@
- Members
- Should Support BMC, ME, CPLD and BIOS
-- Members@odata.count
+- `Members@odata.count`
### /redfish/v1/UpdateService/FirmwareInventory/{SoftwareInventoryId}/
#### SoftwareInventory
- Description
-- RelatedItem@odata.count
+- `RelatedItem@odata.count`
- RelatedItem
- Status
- Updateable
diff --git a/redfish-core/include/registries/openbmc_message_registry.readmefirst.md b/redfish-core/include/registries/openbmc_message_registry.readmefirst.md
index c521ff4..012bb5b 100644
--- a/redfish-core/include/registries/openbmc_message_registry.readmefirst.md
+++ b/redfish-core/include/registries/openbmc_message_registry.readmefirst.md
@@ -1,3 +1,5 @@
+# Registry Edits: Read me first
+
Please read this before making edits to the openbmc base registry.
Messages in this registry are intended to be generally useful across OpenBMC
@@ -16,11 +18,8 @@
3. Message strings should be human readable, and read like a normal sentence.
This generally involves placing the substitution parameters in the
- appropriate place in the string.
-
-Incorrect: "An error occurred. Device: %1"
-
-Correct: "An error occurred on device %1".
+ appropriate place in the string. Incorrect: "An error occurred. Device: %1"
+ Correct: "An error occurred on device %1".
4. Message registry versioning semantics shall be obeyed. Adding new messages
require an increment to the subminor revision. Changes to existing messages