Add new content to "Help and Support" section and refactor
Open
Nobody has claimed this yet.
style: article/section 📝
- Dominant language
- Python
- Stars
- 24
- Forks
- 15
- Avg merge
- 10d 3h
- Merged PRs (30d)
- 1
Description
What would you like to see added?
Add SLA information
- Support Times
- Monday to Friday
- 8:00 AM to 5:00 PM Central Time
- Excludes UAB Holidays (posted here: https://secure4.compliancebridge.com/uab/portal/getdoc.php?file=19)
- System Maintenance
- Expected maintenance of total 10 business days per calendar year, will be communicated no later than 10 business days prior to maintenance.
- Unexpected maintenance may occur, and will be communicated at the later of
- Date of discovery
- 10 business days prior to maintenance
- Actual total maintenance time may vary, and may extend to more than 10 business days.
- What to expect in communication
- Projected start date
- Projected end date
- Expected changes
- side note: Historically, we have had continuous maintenance windows of up to 5 calendar days.
- Service-specific responsibilities
- Cross-link to specific pages
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing "Help and Support" section in the documentation and read its surrounding structure. Add the specified support times, maintenance details, and links to service-specific responsibility pages; done means the new SLA information is present and the cross-links work.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100