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

[WAIT TO MERGE] Flyte docs overhaul #5721

Closed
wants to merge 67 commits into from
Closed

[WAIT TO MERGE] Flyte docs overhaul #5721

wants to merge 67 commits into from

Conversation

neverett
Copy link
Contributor

@neverett neverett commented Sep 3, 2024 •
edited
Loading

Tracking issue

TK - linear issue

Why are the changes needed?

TK

What changes were proposed in this pull request?

TK

How was this patch tested?

TK

Check all the applicable boxes

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

Related PRs

Docs link

TK

@neverett
start reorganizing
eb6ece9 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update deployment docs
baa3604 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update index page
a0e5c0e 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
reorganize user guide
0f49f62 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
more sidebar updates
813fc3c 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update concepts docs
093503b 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
temporary tutorials and integrations index files to get build working
accedc7 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
renamed to cluster_deployment
3f99e1c 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update gitignore to match docs
cb5c4fa 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
add api reference docs structure
2382300 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
remove unneeded flyteidl file
a31b08f 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update docs conf
00337f5 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update with new locations of generated api docs
0350611 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
add flyte api playground page
a6bc51d 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update index
3da3afb 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
renamed this
d3be177 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
add missing sidebar templates and ecosystem section
eb58d55 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
add missing sidebar
41f95a1 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
add ecosystem section to index
7470c49 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
add quickstart guide and first workflow section back in
8ecb2be 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
incorporate introduction content into user guide index page
1517f86 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett neverett self-assigned this Sep 3, 2024
@neverett
remove deprecated integrations (will move to flytesnacks/integrations)
c272c3b 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
move flyte agents docs to user guide section
9789edc 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update user guide index
bcecdd6 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
reorganize some of the flyte fundamentals docs
ded64a7 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
remove core use cases (will move to flytesnacks/tutorials)
a66348b 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
move optimizing tasks doc
e5dc72b 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
remove redundant flyte fundamentals articles - will incorporate conte…
8c83285 
…nt into user guide articles and add redirects as needed

Signed-off-by: nikki everett <nikki@union.ai>
@neverett
fix toctree
c3763a4 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
add new docs paths to ignore
8e3a1db 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update Makefile with new API gen docs paths
5d9e55a 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
delete unused code
91fa7cb 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update deployment docs refs and title
ecfa57b 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update refs and remove cookbook section
1c948da 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update API docs paths
6d7a594 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
add pydata theme dependency
e9b43b1 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
add plugins
c7a6e37 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
lots of design work
084703a 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
add comments
9c7f1b5 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
switch to module-based implementation of algolia docsearch
89a4bd7 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
remove files for old implementation of algolia docsearch
d74113a 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
remove custom CSS and JS, since this mostly duplicates or interferes …
f1770d1 
…with theme CSS/JS and docsearch CSS/JS

Signed-off-by: nikki everett <nikki@union.ai>
@neverett
remove empty flyteremote page for now
cab876e 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
add version
70d08fb 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
remove placeholder directories
1a21e17 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update find/replace logic in import module, delete unused code in module
54bb72b 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update sidebar templates
e19e521 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update deprecated integrations redirects
a6e515a 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update intersphinx inventory links
35fbc90 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
remove extra items from footer
92792dd 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
update left sidebar
17d72a6 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
fix typo
b5019e3 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
DOC-607 use docsearch extension and env variables for docsearch creds
87b751b 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
add copyright to footer
496b9a0 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
remove aws sagemaker plugin documentation for now
5126b4a 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
switch back to original flytekit build process
6abda2c 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
start updating contributing docs
c519032 
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
Copy link
Contributor Author

Closing in favor of #5772

@neverett neverett closed this Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ppiegaze ppiegaze Awaiting requested review from ppiegaze ppiegaze will be requested when the pull request is marked ready for review ppiegaze is a code owner

Assignees

@neverett neverett

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@neverett