Skip to content

Move and update Get started section #871

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 44 commits into from
Dec 23, 2023
Merged

Move and update Get started section #871

merged 44 commits into from
Dec 23, 2023

Conversation

sfc-gh-dmatthews
Copy link
Contributor

@sfc-gh-dmatthews sfc-gh-dmatthews commented Oct 31, 2023 •
edited
Loading

📚 Context

As part of revamping the Get started section, this PR updates the installation workflows to provide users with more options.

🧠 Description of Changes

  • Move library/get-started to its own top-level category
  • Separate setup installation into options: Community Cloud, Anaconda Distribution, command line
  • Reorganize main concepts:
    • Most of the previous main concepts is labeled "Fundamentals."
    • Caching was lifted into a new page of "Advanced concepts" where Session State and connections were added.
    • Themeing and (multi)pages was lifted into a new page of "Additional features" where static file serving and app testing were also introduced (superficially).

Closes: #366

💥 Impact

Size:- [X] Not small

🌐 References

Notion project: Revamp Get started

Contribution License Agreement
By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.

sfc-gh-dmatthews
sfc-gh-dmatthews commented Nov 1, 2023
View reviewed changes
@sfc-gh-dmatthews sfc-gh-dmatthews marked this pull request as ready for review November 1, 2023 02:21
@sfc-gh-dmatthews sfc-gh-dmatthews changed the title Update Get started section Move and update Get started section Nov 1, 2023
@sfc-gh-dmatthews sfc-gh-dmatthews marked this pull request as draft November 17, 2023 04:52
@sfc-gh-dmatthews sfc-gh-dmatthews marked this pull request as ready for review November 17, 2023 04:57
@sfc-gh-dmatthews sfc-gh-dmatthews marked this pull request as draft November 17, 2023 04:58
@sfc-gh-dmatthews
Copy link
Contributor Author

sfc-gh-dmatthews commented Nov 18, 2023 •
edited
Loading

@sfc-gh-jgarcia The design edits should be reflected now. I have a TODO item to update the ArrowLink logic to automatically skip the new menu dividers, but for now I have manual next/previous settings to circumvent that and avoid delay.

@jrieke I didn't focus on rewriting the existing content more than bare-bones consistency. The iteration on this will include a rewrite of those first two tutorials, maybe even additional ones. The end goal is to make the Fundamentals->Advanced concepts->Additional features platform-agnostic as much as possible. I'll be adding a SiS quickstart to Setup and Installation with the intent of providing new users as many options as possible to get quickly get into an active coding session. I want to end each option in Setup and Installation with Hello world so it's easy to jump into exploration while reading main concepts. (And I want to do a really nice update to the summary page with an updated diagram.)

@sfc-gh-dmatthews sfc-gh-dmatthews marked this pull request as ready for review November 18, 2023 01:09
@sfc-gh-dmatthews sfc-gh-dmatthews requested review from sfc-gh-tteixeira and removed request for sfc-gh-jgarcia December 20, 2023 15:15
@sfc-gh-dmatthews sfc-gh-dmatthews mentioned this pull request Dec 21, 2023
Closed
sfc-gh-dmatthews and others added 10 commits December 21, 2023 11:29
@sfc-gh-dmatthews
Merge branch 'main' into ia/get-started
e5990c3
@sfc-gh-dmatthews
Remove menu dividers in /get-started/fundamentals
0d9ce55
@sfc-gh-dmatthews
Move and rename files
e0b5441
@sfc-gh-dmatthews
Move get started tutorials into separate category
aac3408
@sfc-gh-dmatthews
Simplify Installation category page
1201e42
@sfc-gh-dmatthews
Fix Div import/export error
1aa0e10
@sfc-gh-tteixeira
Improve colors, as well as the infra used for setting colors. (#902)
67f165e 
* Improve colors, as well as the infra used for setting colors.

* Fix circle and kb colors.
@sfc-gh-tteixeira
Fix bug I introduced in my last commits. (#903)
2da68f1 
* Improve colors, as well as the infra used for setting colors.

* Fix circle and kb colors.

* Fix some color bugs I introduced, and clean up all colors names.
@sfc-gh-tteixeira
Changed some text & layout in "getting started", "cli", and "anaconda…
9ae52d9 
…". (#905)

* Improve colors, as well as the infra used for setting colors.

* Fix circle and kb colors.

* Fix some color bugs I introduced, and clean up all colors names.

* Change get started, cli, and anaconda instructions. Some layout, some text changes.
@sfc-gh-dmatthews
Capitalization, proper names, and small edit
6533748
@sfc-gh-dmatthews sfc-gh-dmatthews merged commit 488af57 into main Dec 23, 2023
@sfc-gh-dmatthews sfc-gh-dmatthews deleted the ia/get-started branch December 23, 2023 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sfc-gh-tteixeira sfc-gh-tteixeira sfc-gh-tteixeira approved these changes

@jrieke jrieke Awaiting requested review from jrieke

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Confusion about python package management in "get started" docs
2 participants
@sfc-gh-dmatthews @sfc-gh-tteixeira