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

Write new docs for debugging IF #601

Closed
3 tasks
Tracked by #655 ...
jmcook1186 opened this issue Apr 10, 2024 · 1 comment
Closed
3 tasks
Tracked by #655 ...

Write new docs for debugging IF #601

jmcook1186 opened this issue Apr 10, 2024 · 1 comment
Milestone

Comments

@jmcook1186
Copy link
Contributor

jmcook1186 commented Apr 10, 2024

Sub of #655

User Story

As a developer I want to be able to look up the meaning and suggested remediations associated with the IF logs and error messages. This will help me to develop quickly using IF.

Rationale

We will be refining our logging protocol in issue #600 and our error messages in #593 so we should also take the opportunity to document these changes comprehensively for our users. This should include:

  • reference documentation for all error messages
  • reference docs for logs
  • user guide for remediating common errors

Implementation details

  • write error message reference page for if.greensoftware.foundation
  • write logging reference page for if.greensoftware.foundation
  • write user tutorial for remediating common errors for if.greensoftware.foundation

Priority

3/5

Size

L

What does "done" look like?

Three new pages exist on if.greensoftware.foudnation

Deadline

tbc

@jmcook1186 jmcook1186 added this to IF Apr 10, 2024
@zanete zanete moved this to Backlog in IF Apr 22, 2024
@zanete zanete moved this from Backlog to In Design in IF Apr 22, 2024
@zanete zanete moved this from In Design to Backlog in IF Apr 23, 2024
@jmcook1186
Copy link
Contributor Author

Closing as captured in #593 and #602

@github-project-automation github-project-automation bot moved this from Backlog to Done in IF May 20, 2024
@zanete zanete added this to the Improve Trust milestone Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

2 participants