Skip to content

Minor: Add Development Environment to Documentation Index#14890

Merged
comphead merged 1 commit intoapache:mainfrom
alamb:alamb/fix_doc_index
Feb 26, 2025
Merged

Minor: Add Development Environment to Documentation Index#14890
comphead merged 1 commit intoapache:mainfrom
alamb:alamb/fix_doc_index

Conversation

@alamb
Copy link
Contributor

@alamb alamb commented Feb 26, 2025

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

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 #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

Are there any user-facing changes?

@alamb alamb marked this pull request as ready for review February 26, 2025 11:31
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 26, 2025
@dentiny
Copy link
Contributor

dentiny commented Feb 26, 2025

Oh I should be more careful, thank you!

@alamb
Copy link
Contributor Author

alamb commented Feb 26, 2025

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 🤔 )

Copy link
Contributor

@comphead comphead left a comment

Choose a reason for hiding this comment

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

lgtm thanks @alamb for finding this

@comphead comphead merged commit b3407f9 into apache:main Feb 26, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants