documentation
documentation copied to clipboard
Create a Guide to Troubleshoot a Specific Hardware
To expand our documents in the hardware categoy, you could work through a hardware issue and document the process you took to resolve it. See this document for an example: HPE ProLiant Agentless Management Service. Note the document structure of Introduction; Prerequisites and Assumptions; Installing; Conclusion. This is suggested but not mandatory.
To resolve this issue, create a new document explaining your process for troubleshooting a specific type of hardware. Add as a new file, to your fork of the the following directory: docs/guides/hardware. When complete, submit a PR to merge to the main branch of the documentation repository. Then, please add that PR# to this issue to make sure they are connected.
For contribution guide visit README.md for this repository.
Note: Docs are generally created in markdown format and include the following meta information at the top:
title: Document title author: the author of the source (English) version of the document. contributors: a comma separated list of contributors to the source document. tested with: a comma separated list of versions, for example 8.6, 9.0 tags:
- hardware
- troubleshooting
- whatever 1-word tags are appropriate
We believe in you. Progress is better than perfection. This is a team effort and your PR reviewer will assist with details.