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.

Sign up for GitHub

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

Jump to bottom

Documentation Followup #6914

Merged
merged 58 commits into from
Sep 23, 2024
Merged

Documentation Followup #6914

merged 58 commits into from
Sep 23, 2024

Conversation

smokestacklightnin
Copy link
Contributor

@smokestacklightnin smokestacklightnin commented Sep 10, 2024 •
edited
Loading

This addresses several of the points in Issue #6912

The many changes include:

  • Change the "Run in Google Colab" etc. links to real buttons
  • Fix many broken links
  • Fix formatting errors, including improperly rendered unordered lists
  • Add "Addons" Page
  • Remove TF logo
  • Fix admonitions in api docs, guides, and tutorials
  • Make sure all module members that should be present in api docs are present

Here is a preview

After fixing as many links as possible, there are still some links pointing nowhere. They are detailed in Issue #6917.

@smokestacklightnin
Fix link to tfx mobile
cbb5675
@smokestacklightnin
Fix link to Recommenders ranking TFX
300cdb1
@smokestacklightnin
Fix github repo name
c5f3563
@smokestacklightnin
Fix internal link to "Run the pipeline in Dataflow"
a3c9d3e
@smokestacklightnin
Fix code listings
60a3dad
@smokestacklightnin
Fix links
2464ae6
@smokestacklightnin
Fix buttons
f6c04cf
@smokestacklightnin
Clean up link
60eada3
@smokestacklightnin
Fix images
5d08102
@smokestacklightnin
Fix warning
b829c34
@smokestacklightnin
Fix name of admonition
1a26664
@smokestacklightnin
Fix admonitions
250353b
@smokestacklightnin
Fix broken images
cdfb780
@smokestacklightnin
Fix api docs index link
69f7d54
@smokestacklightnin
Add notes admonitions to guide index page
02b8c56
@smokestacklightnin
Fix note admonitions for "TFX Cloud Solutions"
98f73ef
@smokestacklightnin
Fix notes admoniations for keras page in guide
819a295
@smokestacklightnin
Fix note admonitions for "Building TFX Pipelines"
9f217e8
@smokestacklightnin
Fix notes admonitions in examplegen guide page
6d94eb3
@smokestacklightnin
Fix links in examplegen guide page
6de0d62
@smokestacklightnin
Add __init__.py to help fix link
22fc82d
@smokestacklightnin
Fix note admonition in transform guide page
b1a04a8
@smokestacklightnin
Fix note admonition for trainer guide page
e1323c9
@smokestacklightnin
Fix note admonition for tuner guide page
c0c34c3
@smokestacklightnin
Fix note admonition for infravalidator guide page
87cd42e
@smokestacklightnin
Fix note admonitions in "Custom Python function components" guide page
4a7969e
@smokestacklightnin
Fix capitalization
c0aadc7
@smokestacklightnin
Fix admonitions in cli guide page
3adb4c1
@smokestacklightnin
Enable tables and definition lists
a1ed39a
@smokestacklightnin
Command Line Guide: Update definition list and fix admonitions
a88f513 
Other minor formatting changes
@smokestacklightnin smokestacklightnin linked an issue Sep 18, 2024 that may be closed by this pull request
Documentation Follow-up Work #6912
Closed
5 tasks
@smokestacklightnin smokestacklightnin marked this pull request as ready for review September 18, 2024 02:28
peytondmurray
peytondmurray approved these changes Sep 18, 2024
View reviewed changes
Copy link
Contributor

@peytondmurray peytondmurray left a comment

Choose a reason for hiding this comment

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

I haven't checked every link, but perhaps that's best for Lychee or similar tools. Otherwise this looks good.

docs/api/v1/orchestration.md Outdated Show resolved Hide resolved
@gbaned gbaned self-assigned this Sep 18, 2024
@smokestacklightnin smokestacklightnin mentioned this pull request Sep 23, 2024
Closed
@peytondmurray peytondmurray merged commit 940360d into tensorflow:master Sep 23, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@peytondmurray peytondmurray peytondmurray approved these changes

@roseayeon roseayeon roseayeon approved these changes

@lego0901 lego0901 Awaiting requested review from lego0901

Assignees

@gbaned gbaned

Labels
type:docs
Projects
PR Queue
Status: Merged
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation Follow-up Work
5 participants
@smokestacklightnin @peytondmurray @roseayeon @gbaned @keerthanakadiri