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

Commits on Aug 30, 2024

  1. start reorganizing 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Aug 30, 2024
    Configuration menu
    Copy the full SHA
    eb6ece9 View commit details
    Browse the repository at this point in the history

Commits on Sep 3, 2024

  1. update deployment docs 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    baa3604 View commit details
    Browse the repository at this point in the history

  2. update index page 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    a0e5c0e View commit details
    Browse the repository at this point in the history

  3. reorganize user guide 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    0f49f62 View commit details
    Browse the repository at this point in the history

  4. more sidebar updates 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    813fc3c View commit details
    Browse the repository at this point in the history

  5. update concepts docs 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    093503b View commit details
    Browse the repository at this point in the history

  6. temporary tutorials and integrations index files to get build working 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    accedc7 View commit details
    Browse the repository at this point in the history

  7. renamed to cluster_deployment 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    3f99e1c View commit details
    Browse the repository at this point in the history

  8. update gitignore to match docs 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    cb5c4fa View commit details
    Browse the repository at this point in the history

  9. add api reference docs structure 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    2382300 View commit details
    Browse the repository at this point in the history

  10. remove unneeded flyteidl file 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    a31b08f View commit details
    Browse the repository at this point in the history

  11. update docs conf 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    00337f5 View commit details
    Browse the repository at this point in the history

  12. update with new locations of generated api docs 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    0350611 View commit details
    Browse the repository at this point in the history

  13. add flyte api playground page 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    a6bc51d View commit details
    Browse the repository at this point in the history

  14. update index 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    3da3afb View commit details
    Browse the repository at this point in the history

  15. renamed this 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    d3be177 View commit details
    Browse the repository at this point in the history

  16. add missing sidebar templates and ecosystem section 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    eb58d55 View commit details
    Browse the repository at this point in the history

  17. add missing sidebar 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    41f95a1 View commit details
    Browse the repository at this point in the history

  18. add ecosystem section to index 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    7470c49 View commit details
    Browse the repository at this point in the history

  19. add quickstart guide and first workflow section back in 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    8ecb2be View commit details
    Browse the repository at this point in the history

  20. incorporate introduction content into user guide index page 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    1517f86 View commit details
    Browse the repository at this point in the history

  21. remove deprecated integrations (will move to flytesnacks/integrations) 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    c272c3b View commit details
    Browse the repository at this point in the history

  22. move flyte agents docs to user guide section 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    9789edc View commit details
    Browse the repository at this point in the history

  23. update user guide index 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    bcecdd6 View commit details
    Browse the repository at this point in the history

  24. reorganize some of the flyte fundamentals docs 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    ded64a7 View commit details
    Browse the repository at this point in the history

  25. remove core use cases (will move to flytesnacks/tutorials) 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    a66348b View commit details
    Browse the repository at this point in the history

  26. move optimizing tasks doc 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    e5dc72b View commit details
    Browse the repository at this point in the history

  27. remove redundant flyte fundamentals articles - will incorporate conte… 

    …nt into user guide articles and add redirects as needed

Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    8c83285 View commit details
    Browse the repository at this point in the history

  28. fix toctree 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    c3763a4 View commit details
    Browse the repository at this point in the history

  29. do not copy flytekit source -- we will use autodoc instead 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    737a992 View commit details
    Browse the repository at this point in the history

  30. remove separate index page 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    754dbd4 View commit details
    Browse the repository at this point in the history

  31. move doc contribution guide from flytesnacks to community directory 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    b214532 View commit details
    Browse the repository at this point in the history

  32. placeholder TOCs 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    de9a33b View commit details
    Browse the repository at this point in the history

  33. move environment setup to user guide for now 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    2be4181 View commit details
    Browse the repository at this point in the history

  34. turn on import and auto examples extensions for testing 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    6467cb9 View commit details
    Browse the repository at this point in the history

  35. lots of small fixes, plus move docs from flytekit repo 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    9efe834 View commit details
    Browse the repository at this point in the history

Commits on Sep 5, 2024

  1. update conf with pydata specific theme options, update sidebar 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 5, 2024
    Configuration menu
    Copy the full SHA
    01f5709 View commit details
    Browse the repository at this point in the history

  2. update flytekit docs 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 5, 2024
    Configuration menu
    Copy the full SHA
    96de795 View commit details
    Browse the repository at this point in the history

  3. update refs 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 5, 2024
    Configuration menu
    Copy the full SHA
    3dbbb9e View commit details
    Browse the repository at this point in the history

  4. add new docs paths to ignore 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 5, 2024
    Configuration menu
    Copy the full SHA
    8e3a1db View commit details
    Browse the repository at this point in the history

  5. update Makefile with new API gen docs paths 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 5, 2024
    Configuration menu
    Copy the full SHA
    5d9e55a View commit details
    Browse the repository at this point in the history

  6. delete unused code 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 5, 2024
    Configuration menu
    Copy the full SHA
    91fa7cb View commit details
    Browse the repository at this point in the history

  7. update deployment docs refs and title 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 5, 2024
    Configuration menu
    Copy the full SHA
    ecfa57b View commit details
    Browse the repository at this point in the history

  8. update refs and remove cookbook section 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 5, 2024
    Configuration menu
    Copy the full SHA
    1c948da View commit details
    Browse the repository at this point in the history

  9. update API docs paths 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 5, 2024
    Configuration menu
    Copy the full SHA
    6d7a594 View commit details
    Browse the repository at this point in the history

  10. add pydata theme dependency 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 5, 2024
    Configuration menu
    Copy the full SHA
    e9b43b1 View commit details
    Browse the repository at this point in the history

  11. add plugins 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 5, 2024
    Configuration menu
    Copy the full SHA
    c7a6e37 View commit details
    Browse the repository at this point in the history

Commits on Sep 9, 2024

  1. lots of design work 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    084703a View commit details
    Browse the repository at this point in the history

  2. add comments 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    9c7f1b5 View commit details
    Browse the repository at this point in the history

Commits on Sep 10, 2024

  1. switch to module-based implementation of algolia docsearch 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 10, 2024
    Configuration menu
    Copy the full SHA
    89a4bd7 View commit details
    Browse the repository at this point in the history

  2. remove files for old implementation of algolia docsearch 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 10, 2024
    Configuration menu
    Copy the full SHA
    d74113a View commit details
    Browse the repository at this point in the history

  3. remove custom CSS and JS, since this mostly duplicates or interferes … 

    …with theme CSS/JS and docsearch CSS/JS

Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 10, 2024
    Configuration menu
    Copy the full SHA
    f1770d1 View commit details
    Browse the repository at this point in the history

  4. remove empty flyteremote page for now 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 10, 2024
    Configuration menu
    Copy the full SHA
    cab876e View commit details
    Browse the repository at this point in the history

  5. add version 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 10, 2024
    Configuration menu
    Copy the full SHA
    70d08fb View commit details
    Browse the repository at this point in the history

Commits on Sep 11, 2024

  1. remove placeholder directories 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    1a21e17 View commit details
    Browse the repository at this point in the history

  2. update find/replace logic in import module, delete unused code in module 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    54bb72b View commit details
    Browse the repository at this point in the history

  3. update sidebar templates 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    e19e521 View commit details
    Browse the repository at this point in the history

Commits on Sep 12, 2024

  1. update deprecated integrations redirects 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 12, 2024
    Configuration menu
    Copy the full SHA
    a6e515a View commit details
    Browse the repository at this point in the history

  2. update intersphinx inventory links 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 12, 2024
    Configuration menu
    Copy the full SHA
    35fbc90 View commit details
    Browse the repository at this point in the history

Commits on Sep 16, 2024

  1. remove extra items from footer 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 16, 2024
    Configuration menu
    Copy the full SHA
    92792dd View commit details
    Browse the repository at this point in the history

  2. update left sidebar 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 16, 2024
    Configuration menu
    Copy the full SHA
    17d72a6 View commit details
    Browse the repository at this point in the history

  3. fix typo 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 16, 2024
    Configuration menu
    Copy the full SHA
    b5019e3 View commit details
    Browse the repository at this point in the history

Commits on Sep 18, 2024

  1. DOC-607 use docsearch extension and env variables for docsearch creds 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    87b751b View commit details
    Browse the repository at this point in the history

  2. add copyright to footer 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    496b9a0 View commit details
    Browse the repository at this point in the history

  3. remove aws sagemaker plugin documentation for now 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    5126b4a View commit details
    Browse the repository at this point in the history

Commits on Sep 19, 2024

  1. switch back to original flytekit build process 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 19, 2024
    Configuration menu
    Copy the full SHA
    6abda2c View commit details
    Browse the repository at this point in the history

  2. start updating contributing docs 

    Signed-off-by: nikki everett <nikki@union.ai>
    @neverett
    neverett committed Sep 19, 2024
    Configuration menu
    Copy the full SHA
    c519032 View commit details
    Browse the repository at this point in the history