FCP-INDI / fcp-indi.github.io

Github Pages Repo for FCP-INDI
https://fcp-indi.github.io
2 stars 8 forks source link

📝 Known issue: ABCD hanging #321

Closed shnizzedy closed 4 months ago

shnizzedy commented 4 months ago

Documents

Documents FCP-INDI/C-PAC#2104 by @sgiavasis Resolves #318 by @shnizzedy

Description

Adds documentation and workarounds for FCP-INDI/C-PAC#2104 to C-PAC nightly documentation » User » Troubleshooting and Help » Common Issues

I mostly just stole / moved around copy from the issue and this Slack thread

Technical details

Changes "Common Issues" section from an ordered list to a series of subsections to: a) allow sub-subsections to be included in the issue-specific documentation b) include the issues in the sidebar TOC

Screenshots

Help

"https://fcp-indi.github.io/docs/nightly/user/help#common-issues" screenshot

Sidebar TOC

before

"sidebar TOC before" screenshot

after

"sidebar TOC after" screenshot

Preconfigs: abcd-options

"abcd-options" screenshot

issue-specific sub-page

(linked from abcd-options warning and included in "Common Issues") "known issue" screenshot

Checklist

Developer Certificate of Origin

Developer Certificate of Origin ``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ```