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

[SYNPY-1334] Revamp getting started docs #1036

Merged
merged 11 commits into from
Jan 2, 2024

Conversation

BryanFauble
Copy link
Contributor

@BryanFauble BryanFauble commented Dec 22, 2023

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.

@BryanFauble BryanFauble self-assigned this Dec 22, 2023
@pep8speaks
Copy link

pep8speaks commented Dec 22, 2023

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

@BryanFauble BryanFauble changed the title Draft: [SYNPY-1334] Revamp getting started docs [SYNPY-1334] Revamp getting started docs Dec 29, 2023
@BryanFauble BryanFauble marked this pull request as ready for review December 29, 2023 16:38
@BryanFauble BryanFauble requested a review from a team as a code owner December 29, 2023 16:38
Copy link
Member

@thomasyu888 thomasyu888 left a comment

Choose a reason for hiding this comment

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

🔥 LGTM! I'm going to pre-approve because we can always continuously improve documentation.

It will be continued iteration.

BryanFauble and others added 3 commits January 2, 2024 12:58
Co-authored-by: Thomas Yu <thomas.yu@sagebase.org>
Co-authored-by: Thomas Yu <thomas.yu@sagebase.org>
@BryanFauble BryanFauble merged commit f1a5584 into develop Jan 2, 2024
29 checks passed
@BryanFauble BryanFauble deleted the SYNPY-1334-revamp-getting-started-docs branch January 2, 2024 20:28
Copy link

sonarcloud bot commented Jan 2, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants