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

[Documentation:Developer] Reorganize troubleshooting #565

Merged
merged 15 commits into from
Dec 12, 2023

Conversation

RitaLei123
Copy link
Contributor

@RitaLei123 RitaLei123 commented Nov 12, 2023

Reorganized the troubleshooting pages under developer. Organized troubleshooting into 3 files (Installation troubleshooting, Re-installation troubleshooting, and System Clock Testing & Troubleshooting). Now developers can go to the new troubleshooting folder to find instructions on how to fix their problem.

image

Copy link

@Nicc041 Nicc041 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything works and the code looks good.

Copy link

@benlee04 benlee04 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code seems fine and works.

Copy link
Member

@bmcutler bmcutler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggested undoing some of the shuffling

@@ -204,133 +205,6 @@ autograding configuration, you'll probably need to:

---

## System Clock Testing & Troubleshooting
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i agree with moving the system clock troubleshooting to another file


---

## System Re-Configuration
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but the instructions for teting changes to configure_submitty.py & etc should stay here


---

## Re-Creating All Sample Course Data
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and the instructions for rebuilding sample course data should stay here


---

## Complete System Re-Installation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and system re-installation instructions should stay here

@@ -72,5 +72,4 @@ You may also need to edit test cases in Cypress, Selenium, etc.

---

See also: [Re-Creating All Sample Course Data](/developer/development_instructions/index#re-creating-all-sample-course-data)

See also: [Re-Creating All Sample Course Data](/developer/troubleshooting/reinstallation_troubleshooting)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so we will revert this change

@@ -0,0 +1,97 @@
---
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this shouldn't be a separate page, its not troubleshooting, they are development instructions (less commonly used, but still development instructions)

navtreedata.js Outdated
@@ -234,6 +233,11 @@ var NAVTREE =
[ "Frontend JavaScript", "/developer/developing_the_php_site/javascript", null]
] ],
] ],
[ "Troubleshooting & Other Information", "/developer/troubleshooting/installation_troubleshooting", [
[ "Installation", "/developer/troubleshooting/installation_troubleshooting", null ],
[ "Re-Installation", "/developer/troubleshooting/reinstallation_troubleshooting", null ],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this goes away

@RitaLei123 RitaLei123 requested a review from bmcutler December 12, 2023 18:22
@bmcutler bmcutler merged commit e18f63f into main Dec 12, 2023
3 checks passed
@bmcutler bmcutler deleted the Reorganize-Troubleshooting branch December 12, 2023 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants