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

docs: split apart installation docs into parts #1420

Merged
merged 4 commits into from
Jan 27, 2024

Conversation

jackgerrits
Copy link
Member

@jackgerrits jackgerrits commented Jan 26, 2024

Why are these changes needed?

Currently the installation page has a lot of information that is valuable but hard to read through. This splits apart that info and organizes it into several pages (including nesting) to make it easier for the user to find what they are after

Split installation into:

  • Installation (venv and install)
    • Docker
    • Optional deps
  • Migration guide
image

Related issue number

Checks

@codecov-commenter
Copy link

codecov-commenter commented Jan 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (fd0094c) 32.48% compared to head (88c73d0) 32.48%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1420   +/-   ##
=======================================
  Coverage   32.48%   32.48%           
=======================================
  Files          41       41           
  Lines        4907     4907           
  Branches     1120     1120           
=======================================
  Hits         1594     1594           
  Misses       3187     3187           
  Partials      126      126           
Flag Coverage Δ
unittests 32.44% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@gagb gagb self-requested a review January 26, 2024 22:52
@jackgerrits jackgerrits changed the title docs: split apart installation file into parts docs: split apart installation docs into parts Jan 27, 2024
@afourney
Copy link
Member

Code formatting fails on an unrelated notebook file:

nbqa-black...............................................................Failed

Which I cannot reproduce locally to correct. See #1418 for discussion.

@sonichi sonichi added this pull request to the merge queue Jan 27, 2024
Merged via the queue into microsoft:main with commit 9434cd4 Jan 27, 2024
19 checks passed
corleroux pushed a commit to corleroux/autogen that referenced this pull request Jan 30, 2024
* docs: split apart installation file into parts

* missing newline

* fix link

---------

Co-authored-by: Chi Wang <wang.chi@microsoft.com>
whiskyboy pushed a commit to whiskyboy/autogen that referenced this pull request Apr 17, 2024
* docs: split apart installation file into parts

* missing newline

* fix link

---------

Co-authored-by: Chi Wang <wang.chi@microsoft.com>
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.

5 participants