Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a Guide to Troubleshoot a Specific Hardware #2415

Open
Grammaresque opened this issue Oct 5, 2024 · 0 comments
Open

Create a Guide to Troubleshoot a Specific Hardware #2415

Grammaresque opened this issue Oct 5, 2024 · 0 comments
Labels
hacktoberfest This issue or pull request is ideal for GitHub's Hacktoberfest event tag: good first issue Good for newcomers type: documentation Improvements or additions to documentation

Comments

@Grammaresque
Copy link
Collaborator

Grammaresque commented Oct 5, 2024

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.

@Grammaresque Grammaresque added tag: good first issue Good for newcomers type: documentation Improvements or additions to documentation hacktoberfest This issue or pull request is ideal for GitHub's Hacktoberfest event labels Oct 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest This issue or pull request is ideal for GitHub's Hacktoberfest event tag: good first issue Good for newcomers type: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant