Documentation Rehaul - Githubissues

adhilto commented 3 weeks ago

🗣 Description

Splits up the main README file into separate files, similar to the ScubaGear README
Change the OAuth scope list into a comma-separated list

💭 Motivation and context

Closes #306. Closes #283.

🧪 Testing

I clicked all the links in the new documentation files to ensure none were broken.

✅ Pre-approval checklist

[x] This PR has an informative and human-readable title.
[x] Changes are limited to a single goal - eschew scope creep!
[x] If applicable, All future TODOs are captured in issues, which are referenced in the PR description.
[x] The relevant issues PR resolves are linked preferably via closing keywords.
[x] All relevant type-of-change labels have been added.
[x] I have read and agree to the CONTRIBUTING.md document.
[x] These code changes follow cisagov code standards.
[x] All relevant repo and/or project documentation has been updated to reflect the changes in this PR.
[x] Tests have been added and/or modified to cover the changes in this PR.
[x] All new and existing tests pass.

✅ Pre-merge Checklist

[ ] This PR has been smoke tested to ensure main is in a functional state when this PR is merged.
[ ] Squash all commits into one PR level commit using the Squash and merge button.

✅ Post-merge Checklist

[ ] Delete the branch to clean up.
[ ] Close issues resolved by this PR if the closing keywords did not activate.

adhilto commented 2 weeks ago

I left a comment about Python version requirements. I thought we needed something like 3.11 now for some of the new code. We ran into an issue with 3.7 in a pilot meeting maybe @LaurenBassett @rlxdev would remember the version.

(Copying response from @rlxdev) Hi Max (@mdueltgen), During the pilot meeting, the user that was trying to get Scubagoggles installed unsuccessfully tried Python 3.7. (whatever our minimum is). The problem was that the specific version of the pandas package (as defined in requirements.txt) was not available for the Python version. Python version 3.7. is obsolete (same is true really for Python 3.8 and 3.9 (maybe 3.10 as well)), as the current Python version is 3.12). I don't really remember what version that was installed in that meeting to make progress, but I'm sure it was at least 3.9.