Sage-Bionetworks / synapsePythonClient

Programmatic interface to Synapse services for Python
https://www.synapse.org
Apache License 2.0
67 stars 68 forks source link

[SYNPY-1334] Revamp getting started docs #1036

Closed BryanFauble closed 9 months ago

BryanFauble commented 9 months ago

Problem:

  1. The getting started tutorial covered a few use-cases, however, it did not do a great job at teaching the tool to someone.
  2. Some information in the authentication.md doc could use updating
  3. Additional context in several areas was needed

Solution:

  1. I rewrote several of the initial pages you are dropped into on the python docs page
  2. I added context copied from the Synapse doc pages https://help.synapse.org/docs/ here so this is a self-contained experience
  3. I updated the flow of several pages and documents
  4. I started all of the tutorials that I wanted to write about and fully wrote the initial Project, Folder, File tutorials. I'd like feedback around the flow of these tutorials and what I might be able to improve.
  5. I added information into the Further Reading section of the doc pages that we can expand on the Models/Concepts of the system. This was specifically done so I can link to them from the Tutorial section and I didn't need to crowd the tutorials with additional context around these concepts.
  6. I created a scripts folder in tutorials where we can house full tutorial scripts we cover in each tutorial section.
pep8speaks commented 9 months ago

Hello @BryanFauble! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

Line 21:89: E501 line too long (97 > 88 characters)

Line 41:89: E501 line too long (99 > 88 characters) Line 47:89: E501 line too long (90 > 88 characters)

Comment last updated at 2024-01-02 20:25:51 UTC
sonarcloud[bot] commented 9 months ago

Quality Gate Passed Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

152 New issues
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud