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

rename docs/source-app & adjust docs links for lightning #16676

Merged
merged 13 commits into from
Feb 13, 2023
Merged

Conversation

Borda
Copy link
Member

@Borda Borda commented Feb 7, 2023

What does this PR do?

seems the deploy was failing bease we have not generated lightning_app
in fact, we shall be changing all imports in unified docs to lightning instead

Before submitting
  • Was this discussed/agreed via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

Reviewer checklist
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

cc @Borda @carmocca @akihironitta @justusschock @awaelchli

@Borda Borda added docs Documentation related ci Continuous Integration refactor labels Feb 7, 2023
@Borda Borda added this to the 2.0 milestone Feb 7, 2023
@github-actions github-actions bot added the app (removed) Generic label for Lightning App package label Feb 7, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Feb 7, 2023

⛈️ Required checks status: Has failure 🔴

Warning
This job will need to be re-run to merge your PR. If you do not have write access to the repository, you can ask Lightning-AI/lai-frameworks to re-run it. If you push a new commit, all of CI will re-trigger.

Groups summary

🟢 pytorch_lightning: Docs
Check ID Status
make-doctest (pytorch) success
make-html (pytorch) success

These checks are required after the changes to .github/workflows/docs-checks.yml.

🟡 lightning_app: Tests workflow
Check ID Status
app-pytest (macOS-11, lightning, 3.8, latest) no_status
app-pytest (macOS-11, lightning, 3.8, oldest) no_status
app-pytest (macOS-11, app, 3.9, latest) no_status
app-pytest (ubuntu-20.04, lightning, 3.8, latest) no_status
app-pytest (ubuntu-20.04, lightning, 3.8, oldest) no_status
app-pytest (ubuntu-20.04, app, 3.9, latest) no_status
app-pytest (windows-2022, lightning, 3.8, latest) no_status
app-pytest (windows-2022, lightning, 3.8, oldest) no_status
app-pytest (windows-2022, app, 3.8, latest) no_status

These checks are required after the changes to tests/tests_app/components/serve/test_model_inference_api.py.

🔴 lightning_app: Docs
Check ID Status
make-doctest (app) failure
make-html (app) failure

These checks are required after the changes to docs/source/Makefile, docs/source/_static/copybutton.js, docs/source/_static/images/icon.svg, docs/source/_static/images/logo-large.svg, docs/source/_static/images/logo-small.svg, docs/source/_static/images/logo.png, docs/source/_static/images/logo.svg, docs/source/_static/main.css, docs/source/_templates/classtemplate.rst, docs/source/_templates/classtemplate_no_index.rst, docs/source/_templates/layout.html, docs/source/_templates/theme_variables.jinja, docs/source/api_reference/components.rst, docs/source/api_reference/core.rst, docs/source/api_reference/frontend.rst, docs/source/api_reference/runners.rst, docs/source/api_reference/storage.rst, docs/source/basics.rst, docs/source/cloud/customize_a_lightning_cluster.rst, docs/source/code_samples/basics/0.py, docs/source/code_samples/basics/1.py, docs/source/code_samples/convert_pl_to_app/app.py, docs/source/code_samples/convert_pl_to_app/requirements.txt, docs/source/code_samples/convert_pl_to_app/train.py, docs/source/code_samples/quickstart/__init__.py, docs/source/code_samples/quickstart/app/__init__.py, docs/source/code_samples/quickstart/app/app_0.py, docs/source/code_samples/quickstart/app/app_1.py, docs/source/code_samples/quickstart/app_01.py, docs/source/code_samples/quickstart/app_02.py, docs/source/code_samples/quickstart/app_03.py, docs/source/code_samples/quickstart/app_comp.py, docs/source/code_samples/quickstart/hello_world/app.py, docs/source/code_samples/quickstart/hello_world/app_ui.py, docs/source/code_samples/quickstart/hello_world/ui/index.html, docs/source/conf.py, docs/source/contribute_app.rst, docs/source/core_api/lightning_app/app.py, docs/source/core_api/lightning_app/communication.rst, docs/source/core_api/lightning_app/communication_content.rst, docs/source/core_api/lightning_app/compute_content.rst, docs/source/core_api/lightning_app/dynamic_work.rst, docs/source/core_api/lightning_app/dynamic_work_content.rst, docs/source/core_api/lightning_app/index.rst, docs/source/core_api/lightning_app/lightning_app.rst, docs/source/core_api/lightning_flow.rst, docs/source/core_api/lightning_work/compute.rst, docs/source/core_api/lightning_work/compute_content.rst, docs/source/core_api/lightning_work/handling_app_exception.rst, docs/source/core_api/lightning_work/handling_app_exception_content.rst, docs/source/core_api/lightning_work/index.rst, docs/source/core_api/lightning_work/lightning_work.rst, docs/source/core_api/lightning_work/payload.rst, docs/source/core_api/lightning_work/payload_content.rst, docs/source/core_api/lightning_work/status.rst, docs/source/core_api/lightning_work/status_content.rst, docs/source/core_api/overview.rst, docs/source/examples/dag/dag.rst, docs/source/examples/dag/dag_from_scratch.rst, docs/source/examples/data_explore_app.rst, docs/source/examples/etl_app.rst, docs/source/examples/file_server/app.py, docs/source/examples/file_server/file_server.rst, docs/source/examples/file_server/file_server_content.rst, docs/source/examples/file_server/file_server_step_1.rst, docs/source/examples/file_server/file_server_step_2.rst, docs/source/examples/file_server/file_server_step_3.rst, docs/source/examples/file_server/file_server_step_4.rst, docs/source/examples/github_repo_runner/app.py, docs/source/examples/github_repo_runner/github_repo_runner.rst, docs/source/examples/github_repo_runner/github_repo_runner_content.rst, docs/source/examples/github_repo_runner/github_repo_runner_step_1.rst, docs/source/examples/github_repo_runner/github_repo_runner_step_2.rst, docs/source/examples/github_repo_runner/github_repo_runner_step_3.rst, docs/source/examples/github_repo_runner/github_repo_runner_step_4.rst, docs/source/examples/github_repo_runner/github_repo_runner_step_5.rst, docs/source/examples/hands_on_example.rst, docs/source/examples/index.rst, docs/source/examples/model_server_app/app.py, docs/source/examples/model_server_app/load_testing.rst, docs/source/examples/model_server_app/locust_component.py, docs/source/examples/model_server_app/locustfile.py, docs/source/examples/model_server_app/model_server.py, docs/source/examples/model_server_app/model_server.rst, docs/source/examples/model_server_app/model_server_app.rst, docs/source/examples/model_server_app/model_server_app_content.rst, docs/source/examples/model_server_app/putting_everything_together.rst, docs/source/examples/model_server_app/train.py, docs/source/examples/model_server_app/train.rst, docs/source/examples/research_demo_app.rst, docs/source/get_started/add_an_interactive_demo.rst, docs/source/get_started/build_model.rst, docs/source/get_started/go_beyond_training.rst, docs/source/get_started/go_beyond_training_content.rst, docs/source/get_started/jumpstart_from_app_gallery.rst, docs/source/get_started/jumpstart_from_component_gallery.rst, docs/source/get_started/training_with_apps.rst, docs/source/get_started/what_app_can_do.rst, docs/source/glossary/app_tree.rst, docs/source/glossary/aws_arn.rst, docs/source/glossary/build_config/build_config.rst, docs/source/glossary/build_config/build_config_advanced.rst, docs/source/glossary/build_config/build_config_basic.rst, docs/source/glossary/build_config/build_config_intermediate.rst, docs/source/glossary/command_lines/command_lines.rst, docs/source/glossary/dag.rst, docs/source/glossary/debug_app.rst, docs/source/glossary/distributed_fe.rst, docs/source/glossary/distributed_hardware.rst, docs/source/glossary/environment_variables.rst, docs/source/glossary/event_loop.rst, docs/source/glossary/fault_tolerance.rst, docs/source/glossary/index.rst, docs/source/glossary/ios_and_android.rst, docs/source/glossary/lightning_app_overview/index.rst, docs/source/glossary/mount.rst, docs/source/glossary/restful_api/restful_api.rst, docs/source/glossary/scheduling.rst, docs/source/glossary/secrets.rst, docs/source/glossary/sharing_components.rst, docs/source/glossary/storage/differences.rst, docs/source/glossary/storage/drive.rst, docs/source/glossary/storage/drive_content.rst, docs/source/glossary/storage/drive_content_old.rst, docs/source/glossary/storage/path.rst, docs/source/glossary/storage/storage.rst, docs/source/glossary/use_local_lightning.rst, docs/source/index.rst, docs/source/install/install_beginner.rst, docs/source/install/installation.rst, docs/source/install/mac.bash, docs/source/install/pip.bash, docs/source/install/windows.bash, docs/source/intro.rst, docs/source/landing_app.py, docs/source/landing_app_run.bash, docs/source/levels/advanced/index.rst, docs/source/levels/advanced/level_16.rst, docs/source/levels/advanced/level_17.rst, docs/source/levels/advanced/level_18.rst, docs/source/levels/advanced/level_19.rst, docs/source/levels/advanced/level_20.rst, docs/source/levels/advanced/start_dynamic_components.rst, docs/source/levels/basic/build_a_dag.rst, docs/source/levels/basic/build_a_lightning_component.rst, docs/source/levels/basic/create_a_model_demo.rst, docs/source/levels/basic/deploy_ai_model_api.rst, docs/source/levels/basic/hello_components/code_run_cloud.bash, docs/source/levels/basic/hello_components/code_run_cloud_setup.bash, docs/source/levels/basic/hello_components/code_run_cloud_yours.bash, docs/source/levels/basic/hello_components/code_run_cloud_yours_setup.bash, docs/source/levels/basic/hello_components/code_run_local.bash, docs/source/levels/basic/hello_components/code_run_local_setup.bash, docs/source/levels/basic/hello_components/deploy_model.py, docs/source/levels/basic/hello_components/hello_world.py, docs/source/levels/basic/hello_components/hello_world_gpu.py, docs/source/levels/basic/hello_components/multi_node.py, docs/source/levels/basic/hello_components/pl_multinode.py, docs/source/levels/basic/hello_components/pt_multinode.py, docs/source/levels/basic/hello_components/run_ptl_script.py, docs/source/levels/basic/hello_components/streamlit_demo.py, docs/source/levels/basic/hello_components/terraform_example.bash, docs/source/levels/basic/hello_components/train_ptl.py, docs/source/levels/basic/hello_components/train_pytorch.py, docs/source/levels/basic/hello_components/xgboost.py, docs/source/levels/basic/hello_components/xgboost_gpu.py, docs/source/levels/basic/hero_components.rst, docs/source/levels/basic/hero_run.rst, docs/source/levels/basic/hero_run_setup.rst, docs/source/levels/basic/index.rst, docs/source/levels/basic/key_features/accelerators.py, docs/source/levels/basic/key_features/auto_timeout.py, docs/source/levels/basic/key_features/custom_container.py, docs/source/levels/basic/key_features/idle_machine.py, docs/source/levels/basic/key_features/massive_dataset.py, docs/source/levels/basic/key_features/mount_data.py, docs/source/levels/basic/key_features/spot.py, docs/source/levels/basic/real_lightning_component_implementations.rst, docs/source/levels/basic/run_jupyter_notebook_on_the_cloud.rst, docs/source/levels/basic/run_on_aws_account.rst, docs/source/levels/basic/save_money_on_cloud_costs.rst, docs/source/levels/basic/scripts/toy_app_1_component.py, docs/source/levels/basic/scripts/toy_app_1_component_pdb.py, docs/source/levels/basic/train_pytorch_on_the_cloud.rst, docs/source/levels/expert/index.rst, docs/source/levels/intermediate/connect_lightning_components.rst, docs/source/levels/intermediate/debug_a_lightning_app.rst, docs/source/levels/intermediate/debug_app_scripts/debug_app.py, docs/source/levels/intermediate/debug_app_scripts/toy_app.py, docs/source/levels/intermediate/debug_app_scripts/toy_app_1_component.py, docs/source/levels/intermediate/debug_app_scripts/toy_app_1_component_pdb.py, docs/source/levels/intermediate/embed_web_ui_into_lightningwork.rst, docs/source/levels/intermediate/index.rst, docs/source/levels/intermediate/level_12.rst, docs/source/levels/intermediate/level_2_scripts/code_run_cloud.bash, docs/source/levels/intermediate/level_2_scripts/code_run_local.bash, docs/source/levels/intermediate/level_2_scripts/hello_app.py, docs/source/levels/intermediate/level_2_scripts/hello_app_auto_scale.py, docs/source/levels/intermediate/level_2_scripts/hello_app_cron.py, docs/source/levels/intermediate/level_2_scripts/hello_app_scheduler.py, docs/source/levels/intermediate/level_2_scripts/multi_cloud.bash, docs/source/levels/intermediate/level_2_scripts/organized_app_python.py, docs/source/levels/intermediate/level_2_scripts/tr.bash, docs/source/levels/intermediate/level_9.rst, docs/source/levels/intermediate/run_lightning_work_in_parallel.rst, docs/source/levels/intermediate/scripts/a, docs/source/levels/intermediate/scripts/comms_1.py, docs/source/levels/intermediate/scripts/debug_app.py, docs/source/levels/intermediate/scripts/embeddings, docs/source/levels/intermediate/scripts/toy_app.py, docs/source/levels/intermediate/scripts/toy_payload.py, docs/source/levels/intermediate/scripts/two_comms_non_ml.py, docs/source/levels/intermediate/scripts/two_work_comms.py, docs/source/levels/intermediate/share_files_between_components.rst, docs/source/levels/intermediate/share_variables_between_lightning_components.rst, docs/source/levels/intermediate/start_from_lightning_app_templates.rst, docs/source/make.bat, docs/source/moving_to_the_cloud.rst, docs/source/quickstart.rst, docs/source/testing.rst, docs/source/ui_and_frontends.rst, docs/source/workflows/access_app_state/access_app_state.rst, docs/source/workflows/add_components/index.rst, docs/source/workflows/add_server/any_server.rst, docs/source/workflows/add_server/flask_basic.rst, docs/source/workflows/add_server/index.rst, docs/source/workflows/add_server/index_content.rst, docs/source/workflows/add_web_link.rst, docs/source/workflows/add_web_ui/angular_js_intermediate.rst, docs/source/workflows/add_web_ui/dash/basic.rst, docs/source/workflows/add_web_ui/dash/index.rst, docs/source/workflows/add_web_ui/dash/intermediate.rst, docs/source/workflows/add_web_ui/dash/intermediate_plot.py, docs/source/workflows/add_web_ui/dash/intermediate_state.py, docs/source/workflows/add_web_ui/example_app.rst, docs/source/workflows/add_web_ui/glossary_front_end.rst, docs/source/workflows/add_web_ui/glossary_ui.rst, docs/source/workflows/add_web_ui/gradio/basic.rst, docs/source/workflows/add_web_ui/gradio/index.rst, docs/source/workflows/add_web_ui/gradio/intermediate.rst, docs/source/workflows/add_web_ui/html/basic.rst, docs/source/workflows/add_web_ui/html/index.rst, docs/source/workflows/add_web_ui/html/intermediate.rst, docs/source/workflows/add_web_ui/index.rst, docs/source/workflows/add_web_ui/index_content.rst, docs/source/workflows/add_web_ui/integrate_any_javascript_framework.rst, docs/source/workflows/add_web_ui/jupyter_basic.rst, docs/source/workflows/add_web_ui/justpy/index.rst, docs/source/workflows/add_web_ui/panel/basic.rst, docs/source/workflows/add_web_ui/panel/index.rst, docs/source/workflows/add_web_ui/panel/intermediate.rst, docs/source/workflows/add_web_ui/react/communicate_between_react_and_lightning.rst, docs/source/workflows/add_web_ui/react/connect_react_and_lightning.rst, docs/source/workflows/add_web_ui/react/create_react_template.rst, docs/source/workflows/add_web_ui/react/index.rst, docs/source/workflows/add_web_ui/react/react_development_workflow.rst, docs/source/workflows/add_web_ui/streamlit/basic.rst, docs/source/workflows/add_web_ui/streamlit/index.rst, docs/source/workflows/add_web_ui/streamlit/intermediate.rst, docs/source/workflows/add_web_ui/vue_js_intermediate.rst, docs/source/workflows/arrange_tabs/arrange_app_basic.rst, docs/source/workflows/arrange_tabs/arrange_app_intermediate.rst, docs/source/workflows/arrange_tabs/index.rst, docs/source/workflows/arrange_tabs/index_content.rst, docs/source/workflows/build_command_line_interface/app.py, docs/source/workflows/build_command_line_interface/cli.rst, docs/source/workflows/build_command_line_interface/cli_client.rst, docs/source/workflows/build_command_line_interface/commands/__init__.py, docs/source/workflows/build_command_line_interface/commands/notebook/__init__.py, docs/source/workflows/build_command_line_interface/commands/notebook/run.py, docs/source/workflows/build_command_line_interface/example_command.py, docs/source/workflows/build_command_line_interface/index.rst, docs/source/workflows/build_command_line_interface/index_content.rst, docs/source/workflows/build_command_line_interface/post_example.py, docs/source/workflows/build_lightning_app/from_pytorch_lightning_script.rst, docs/source/workflows/build_lightning_app/from_scratch.rst, docs/source/workflows/build_lightning_app/from_scratch_content.rst, docs/source/workflows/build_lightning_app/index.rst, docs/source/workflows/build_lightning_app/index_content.rst, docs/source/workflows/build_lightning_component/basic.rst, docs/source/workflows/build_lightning_component/from_scratch_component_content.rst, docs/source/workflows/build_lightning_component/index.rst, docs/source/workflows/build_lightning_component/index_content.rst, docs/source/workflows/build_lightning_component/intermediate.rst, docs/source/workflows/build_lightning_component/publish_a_component.rst, docs/source/workflows/build_rest_api/add_api.rst, docs/source/workflows/build_rest_api/index.rst, docs/source/workflows/build_rest_api/index_content.rst, docs/source/workflows/build_rest_api/models.py, docs/source/workflows/build_rest_api/post_example.py, docs/source/workflows/build_rest_api/post_example_pydantic.py, docs/source/workflows/build_rest_api/request_validation.rst, docs/source/workflows/byoc/aws_cli.rst, docs/source/workflows/byoc/aws_console.rst, docs/source/workflows/byoc/create_cluster.rst, docs/source/workflows/byoc/delete_cluster.rst, docs/source/workflows/byoc/index.rst, docs/source/workflows/byoc/run_on_cluster.rst, docs/source/workflows/debug_locally.rst, docs/source/workflows/enable_fault_tolerance.rst, docs/source/workflows/extend_app.rst, docs/source/workflows/index.rst, docs/source/workflows/mount_cloud_object_store.rst, docs/source/workflows/run_app_on_cloud/cloud_files.rst, docs/source/workflows/run_app_on_cloud/index.rst, docs/source/workflows/run_app_on_cloud/index_content.rst, docs/source/workflows/run_app_on_cloud/lightning_cloud.rst, docs/source/workflows/run_app_on_cloud/on_prem.rst, docs/source/workflows/run_app_on_cloud/on_your_own_machine.rst, docs/source/workflows/run_app_snippet.rst, docs/source/workflows/run_components_on_different_hardware.rst, docs/source/workflows/run_on_private_cloud.rst, docs/source/workflows/run_work_in_parallel.rst, docs/source/workflows/run_work_in_parallel_content.rst, docs/source/workflows/run_work_once.rst, docs/source/workflows/run_work_once_content.rst, docs/source/workflows/schedule_apps.rst, docs/source/workflows/scripts/parallel/toy_app.py, docs/source/workflows/scripts/parallel/toy_parallel.py, docs/source/workflows/scripts/parallel/toy_two_parallel.py, docs/source/workflows/scripts/parallel/toy_two_parallel_not_started.py, docs/source/workflows/share_app.rst, docs/source/workflows/share_files_between_components.rst, docs/source/workflows/share_files_between_components/app.py, docs/source/workflows/ssh/index.rst, docs/source/workflows/test_an_app.rst, .github/workflows/docs-checks.yml.


Thank you for your contribution! 💜

Note
This comment is automatically generated and updates for 60 minutes every 180 seconds. If you have any other questions, contact carmocca for help.

.github/CODEOWNERS Outdated Show resolved Hide resolved
.github/CODEOWNERS Outdated Show resolved Hide resolved
@Borda Borda requested a review from carmocca February 8, 2023 11:58
@Borda Borda changed the title adjust docs links for lightning rename docs/source-app & adjust docs links for lightning Feb 8, 2023
@Borda
Copy link
Member Author

Borda commented Feb 8, 2023

@awaelchli, all good catches, and sorry I missed then... :(

UPDATE: redone the whole PR from ground paying proper attention to it 😇

@Borda Borda marked this pull request as draft February 8, 2023 16:02
@Borda
Copy link
Member Author

Borda commented Feb 11, 2023

the true check is in: https://github.com/Lightning-AI/lightning/actions/runs/4149219807
@awaelchli could you pls check again 😇

@Borda Borda marked this pull request as ready for review February 11, 2023 02:25
@@ -1,10 +0,0 @@
.. role:: hidden
Copy link
Contributor

Choose a reason for hiding this comment

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

can't find this, where was it moved?

Copy link
Member Author

Choose a reason for hiding this comment

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

This was removed as it duplicated the generated on and caused an issue while building docs, in fact, that shall be removed a while back as this was a bad artifact...

@mergify mergify bot added the ready PRs ready to be merged label Feb 11, 2023

- repo: https://github.com/psf/black
rev: 22.12.0
hooks:
- id: black
name: Format code
exclude: docs/source-app
exclude: docs/source
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this intended? Do we not want to just include the app files?

Copy link
Member Author

Choose a reason for hiding this comment

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

unfortunalyly it is inted and it was explicitly asked by @williamFalcon as he was not happy about formating docs...
cc: @justusschock

@Borda Borda enabled auto-merge (squash) February 13, 2023 09:06
@Borda Borda requested a review from carmocca February 13, 2023 09:39
@lantiga lantiga disabled auto-merge February 13, 2023 09:58
@lantiga lantiga merged commit 0be025e into master Feb 13, 2023
@lantiga lantiga deleted the ci/docs-deploy branch February 13, 2023 09:59
@Borda Borda mentioned this pull request Feb 14, 2023
7 tasks
@Borda Borda mentioned this pull request Feb 24, 2023
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
app (removed) Generic label for Lightning App package ci Continuous Integration docs Documentation related ready PRs ready to be merged refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants