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

Troubleshoot and Debug Documentation #370

Open
3 tasks
TechnicallyWilliams opened this issue Jan 20, 2020 · 0 comments
Open
3 tasks

Troubleshoot and Debug Documentation #370

TechnicallyWilliams opened this issue Jan 20, 2020 · 0 comments
Assignees
Labels
documentation Applies to documentation and diagrams effort - small 1 day effort

Comments

@TechnicallyWilliams
Copy link
Contributor

TechnicallyWilliams commented Jan 20, 2020

Description

As both a user or contributor, I'd like a centralized page that documents and highlights steps that I can take to troubleshoot and debug any issues that arise from using Cobalt.

Acceptance Criteria

  • Should be initialized with instructions for deleting .terraform sub-directory as a starting point for overcoming errors.
  • The conclusion of each page in the walkthrough should provide a link to troubleshooting and debugging documentation.
  • Page should invite others to contribute solutions to discovered problems.

Tasks

Assignee should break down work into tasks here

  • Create a new page in the docs directory
  • Create an overview section to explain it's purpose
  • Give page a table of contents with sub-section anchors
  • Write instructions for deleting .terraform sub-directory
  • Add contribution invitation
  • Update all other walkthrough pages with a link back to this documentation
  • Look through all other walkthrough pages for errors and consolidate them onto this page.
@TechnicallyWilliams TechnicallyWilliams added documentation Applies to documentation and diagrams effort - small 1 day effort labels Jan 20, 2020
@TechnicallyWilliams TechnicallyWilliams self-assigned this Jan 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Applies to documentation and diagrams effort - small 1 day effort
Projects
None yet
Development

No branches or pull requests

1 participant