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] Fix toctree links to User Guide, Environment Setup, and Contributing sections #4781

Merged
merged 6 commits into from
Jan 26, 2024

Conversation

neverett
Copy link
Contributor

@neverett neverett commented Jan 25, 2024

Why are the changes needed?

Fixes docs build error introduced by #4548. The toctree links in introduction.md need to point to flytesnacks/{filename} for the user guide, environment setup, and contributing sections.

What changes were proposed in this pull request?

Fixes toctree links in introduction.md

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

#4548

Docs link

https://flyte--4781.org.readthedocs.build/en/4781/introduction.html

@neverett neverett self-assigned this Jan 25, 2024
@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jan 25, 2024
Copy link

codecov bot commented Jan 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (42d3866) 58.54% compared to head (a87df2d) 58.52%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4781      +/-   ##
==========================================
- Coverage   58.54%   58.52%   -0.02%     
==========================================
  Files         625      625              
  Lines       53669    53669              
==========================================
- Hits        31418    31411       -7     
- Misses      19734    19741       +7     
  Partials     2517     2517              
Flag Coverage Δ
unittests 58.52% <ø> (-0.02%) ⬇️

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.

Signed-off-by: nikki everett <[email protected]>
@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. and removed size:XS This PR changes 0-9 lines, ignoring generated files. labels Jan 25, 2024
nikki everett added 3 commits January 25, 2024 17:33
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:S This PR changes 10-29 lines, ignoring generated files. labels Jan 26, 2024
Signed-off-by: nikki everett <[email protected]>
@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Jan 26, 2024
@neverett
Copy link
Contributor Author

I don't understand the codecov test failure, but it looks like my change fixes the toctree issue.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 26, 2024
@Future-Outlier Future-Outlier merged commit ac5603b into master Jan 26, 2024
44 of 45 checks passed
@Future-Outlier Future-Outlier deleted the docs/fix-toctree branch January 26, 2024 07:59
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 lgtm This PR has been approved by a maintainer size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants