You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "alamb (via GitHub)" <gi...@apache.org> on 2025/02/26 11:31:08 UTC

[PR] Minor: Add Development Environment to Documentation Index [datafusion]

alamb opened a new pull request, #14890:
URL: https://github.com/apache/datafusion/pull/14890

   ## Which issue does this PR close?
   
   
   ## Rationale for this change
   
   I found the that the setting up development environment page wasn't linked in the table of contents
   
   ![Screenshot 2025-02-26 at 6 26 27 AM](https://github.com/user-attachments/assets/266ed643-3fa1-4eee-aa24-ca55f79ced9b)
   
   running `cd docs && ./build.sh` also shows an error
   
   ```
   reading sources... [100%] user-guide/sql/write_options
   /Users/andrewlamb/Software/datafusion/docs/temp/index.rst:138: WARNING: toctree contains reference to nonexisting document 'contributor-guide/getting_started'
   looking for now-outdated files... none found
   pickling environment... done
   checking consistency... /Users/andrewlamb/Software/datafusion/docs/temp/contributor-guide/development_environment.md: WARNING: document isn't included in any toctree
   ```
   
   I think this may have been introduced in https://github.com/apache/datafusion/pull/14694
   ## What changes are included in this PR?
   Fix the index:
   
   
   ## Are these changes tested?
   I tested them lcal
   ![Screenshot 2025-02-26 at 6 27 40 AM](https://github.com/user-attachments/assets/2c60bad9-3e82-4a16-aa55-968c9a42d4a3)
   
   <!--
   We typically require tests for all PRs in order to:
   1. Prevent the code from being accidentally broken by subsequent changes
   2. Serve as another way to document the expected behavior of the code
   
   If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
   -->
   
   ## Are there any user-facing changes?
   
   <!--
   If there are user-facing changes then we may require documentation to be updated before approving the PR.
   -->
   
   <!--
   If there are any breaking changes to public APIs, please add the `api change` label.
   -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org


Re: [PR] Minor: Add Development Environment to Documentation Index [datafusion]

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #14890:
URL: https://github.com/apache/datafusion/pull/14890#issuecomment-2685486525

   > Oh I should be more careful, thank you!
   
   No worries -- it is easy to fix. Maybe we should turn doc build warnings into errors (like we do for code 🤔 )


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org


Re: [PR] Minor: Add Development Environment to Documentation Index [datafusion]

Posted by "dentiny (via GitHub)" <gi...@apache.org>.
dentiny commented on PR #14890:
URL: https://github.com/apache/datafusion/pull/14890#issuecomment-2684718610

   Oh I should be more careful, thank you! 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org


Re: [PR] Minor: Add Development Environment to Documentation Index [datafusion]

Posted by "comphead (via GitHub)" <gi...@apache.org>.
comphead merged PR #14890:
URL: https://github.com/apache/datafusion/pull/14890


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org