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 Rehaul #319

Merged
merged 31 commits into from
Jun 20, 2024
Merged

Documentation Rehaul #319

merged 31 commits into from
Jun 20, 2024

Conversation

adhilto
Copy link
Collaborator

@adhilto adhilto commented Jun 13, 2024

🗣 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

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • If applicable, All future TODOs are captured in issues, which are referenced in the PR description.
  • The relevant issues PR resolves are linked preferably via closing keywords.
  • All relevant type-of-change labels have been added.
  • I have read and agree to the CONTRIBUTING.md document.
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated to reflect the changes in this PR.
  • Tests have been added and/or modified to cover the changes in this PR.
  • 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 adhilto added the documentation This issue or pull request improves or adds to documentation label Jun 13, 2024
@adhilto adhilto added this to the Coast milestone Jun 13, 2024
@adhilto adhilto self-assigned this Jun 13, 2024
@adhilto adhilto linked an issue Jun 13, 2024 that may be closed by this pull request
1 task
@adhilto adhilto removed the request for review from buidav June 13, 2024 18:35
Copy link
Collaborator

@mdueltgen mdueltgen left a comment

Choose a reason for hiding this comment

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

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.

@cisagov cisagov deleted a comment from rlxdev Jun 18, 2024
@adhilto
Copy link
Collaborator Author

adhilto commented Jun 18, 2024

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.

@adhilto
Copy link
Collaborator Author

adhilto commented Jun 20, 2024

Quick heads up @mdueltgen @mitchelbaker-cisa, I'm going to be reverting the baseline markdown file name changes per David's recommendation so as to not cause merge conflicts with the other ~10 open PRs.

@adhilto adhilto merged commit b0c764a into main Jun 20, 2024
1 check passed
@adhilto adhilto deleted the 306-docs-update branch June 20, 2024 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Split up the main README OAuth API Scopes - User Improvement
3 participants