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

DOC: move install related FAQ to install docs #26628

Merged
merged 1 commit into from
Sep 12, 2023

Conversation

story645
Copy link
Member

@story645 story645 commented Aug 30, 2023

Moves the install related sections of the FAQ to the install docs because I think that would make them more discoverable and ended up editing/consolidating some of the install docs to make these changes smoother.

summary of changes:

  • move environment variables to install because it's install and environment config related

  • moved git related troubleshooting to devel docs

  • moved install related troubleshooting to a file in install

    • included this file in install docs
    • linked out to this file from the development troubleshooting guide
  • added env variables and troubleshooting to the install and workflow listings on the devel index

  • moved get in touch to main faq doc - I don't think we need this given we have this section in our contributor guide but also trying to scope current changes mostly to install 🤷‍♀️

  • moved main faq doc up to users and removed faq folder because it's now 1 document

  • consolidated install docs:

    • removed the install from github instructions from "install from source" and replaced with giant note to see install for development
    • moved windows visual studio instructions to dependencies
    • add first step dependencies to develop install docs

@story645 story645 added the Documentation: devdocs files in doc/devel label Aug 30, 2023
@story645 story645 force-pushed the install-faq branch 2 times, most recently from f4bbc04 to fa56972 Compare August 31, 2023 01:36
@story645 story645 marked this pull request as ready for review August 31, 2023 01:36
@story645 story645 linked an issue Aug 31, 2023 that may be closed by this pull request
@story645
Copy link
Member Author

story645 commented Sep 7, 2023

dunno why codecov is failing 🤷‍♀️

doc/devel/dependencies.rst Outdated Show resolved Hide resolved
doc/devel/dependencies.rst Outdated Show resolved Hide resolved
doc/devel/development_setup.rst Outdated Show resolved Hide resolved
doc/users/installing/index.rst Outdated Show resolved Hide resolved
@story645 story645 force-pushed the install-faq branch 2 times, most recently from ed63b3e to 47a445f Compare September 10, 2023 23:57
doc/devel/dependencies.rst Outdated Show resolved Hide resolved
doc/devel/dependencies.rst Outdated Show resolved Hide resolved
doc/devel/dependencies.rst Outdated Show resolved Hide resolved
doc/devel/dependencies.rst Outdated Show resolved Hide resolved
doc/devel/dependencies.rst Outdated Show resolved Hide resolved
doc/devel/dependencies.rst Outdated Show resolved Hide resolved
doc/devel/dependencies.rst Outdated Show resolved Hide resolved
moved install related troubleshooting/faq to install docs
new troubleshooting page specific to development
consolidated information across install, install for dev, and dependencies

Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
@QuLogic QuLogic merged commit 1b4b50b into matplotlib:main Sep 12, 2023
31 of 32 checks passed
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Sep 12, 2023
@story645 story645 deleted the install-faq branch September 12, 2023 22:03
QuLogic added a commit that referenced this pull request Sep 12, 2023
…628-on-v3.8.x

Backport PR #26628 on branch v3.8.x (DOC: move install related FAQ to install docs)
@ksunden ksunden mentioned this pull request Sep 15, 2023
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: devdocs files in doc/devel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc]: FAQ is not reachable anymore via the main menu
3 participants